Files
MeanField_SERiF/docs/man/man3/serif_solver_seed_detail.3
Emily Boudreaux 6b57738330 docs(docs): built docs
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
2026-11-09 14:09:44 -05:00

66 lines
2.5 KiB
Groff

.TH "serif::solver::seed::detail" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::seed::detail
.SH SYNOPSIS
.br
.PP
.SS "Functions"
.in +1c
.ti -1c
.RI "const \fBRadialSeed\fP & \fBradial_source\fP (const \fBRadialSeed\fP &seed)"
.br
.RI "Inspect the unchanged physical source of a strict seed\&. "
.ti -1c
.RI "const \fBRadialSeed\fP & \fBradial_source\fP (const \fBFittedRadialSeed\fP &seed)"
.br
.RI "Inspect the unchanged physical source of an explicitly fitted guess\&. "
.ti -1c
.RI "\fBdimensions::LengthValue\fP \fBradial_radius\fP (const \fBRadialSeed\fP &seed)"
.br
.RI "Use the equilibrium radius for ordinary projection\&. "
.ti -1c
.RI "\fBdimensions::LengthValue\fP \fBradial_radius\fP (const \fBFittedRadialSeed\fP &seed)"
.br
.RI "Use the explicit destination radius for fitted projection\&. "
.ti -1c
.RI "\fBdimensions::MassValue\fP \fBradial_mass\fP (const \fBRadialSeed\fP &seed)"
.br
.RI "Retain the original spherical mass for ordinary projection\&. "
.ti -1c
.RI "\fBdimensions::MassValue\fP \fBradial_mass\fP (const \fBFittedRadialSeed\fP &seed)"
.br
.RI "Use the mass of the stretched density for fitted gravity projection\&. "
.in -1c
.SH "Function Documentation"
.PP
.SS "\fBdimensions::MassValue\fP serif::solver::seed::detail::radial_mass (const \fBFittedRadialSeed\fP & seed)\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Use the mass of the stretched density for fitted gravity projection\&.
.SS "\fBdimensions::MassValue\fP serif::solver::seed::detail::radial_mass (const \fBRadialSeed\fP & seed)\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Retain the original spherical mass for ordinary projection\&.
.SS "\fBdimensions::LengthValue\fP serif::solver::seed::detail::radial_radius (const \fBFittedRadialSeed\fP & seed)\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Use the explicit destination radius for fitted projection\&.
.SS "\fBdimensions::LengthValue\fP serif::solver::seed::detail::radial_radius (const \fBRadialSeed\fP & seed)\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Use the equilibrium radius for ordinary projection\&.
.SS "const \fBRadialSeed\fP & serif::solver::seed::detail::radial_source (const \fBFittedRadialSeed\fP & seed)\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Inspect the unchanged physical source of an explicitly fitted guess\&.
.SS "const \fBRadialSeed\fP & serif::solver::seed::detail::radial_source (const \fBRadialSeed\fP & seed)\fR [inline]\fP, \fR [nodiscard]\fP"
.PP
Inspect the unchanged physical source of a strict seed\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.