Emily Boudreaux
6b57738330
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)
79 lines
2.7 KiB
Groff
79 lines
2.7 KiB
Groff
.TH "src/include/serif/solver/seed/fitted.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
.ad l
|
||
.nh
|
||
.SH NAME
|
||
src/include/serif/solver/seed/fitted.hpp
|
||
.SH SYNOPSIS
|
||
.br
|
||
.PP
|
||
\fR#include 'serif/solver/seed/polytrope\&.hpp'\fP
|
||
.br
|
||
|
||
.SS "Classes"
|
||
|
||
.in +1c
|
||
.ti -1c
|
||
.RI "struct \fBserif::solver::seed::FittedRadialSeed\fP"
|
||
.br
|
||
.RI "An explicitly stretched initial guess, distinct from an equilibrium Lane–Emden scaling\&. "
|
||
.in -1c
|
||
.SS "Namespaces"
|
||
|
||
.in +1c
|
||
.ti -1c
|
||
.RI "namespace \fBserif\fP"
|
||
.br
|
||
.ti -1c
|
||
.RI "namespace \fBserif::solver\fP"
|
||
.br
|
||
.ti -1c
|
||
.RI "namespace \fBserif::solver::seed\fP"
|
||
.br
|
||
.ti -1c
|
||
.RI "namespace \fBserif::solver::seed::detail\fP"
|
||
.br
|
||
.in -1c
|
||
.SS "Functions"
|
||
|
||
.in +1c
|
||
.ti -1c
|
||
.RI "auto \fBserif::solver::seed::evaluate_radial_seed\fP (const \fBRadialSeed\fP &seed, \fBdimensions::LengthValue\fP radius)"
|
||
.br
|
||
.RI "Evaluate the original equilibrium profile without changing its physical scaling\&. "
|
||
.ti -1c
|
||
.RI "std::expected< \fBFittedRadialSeed\fP, std::string > \fBserif::solver::seed::fit_radial_seed\fP (const \fBRadialSeed\fP &seed, \fBdimensions::LengthValue\fP radius)"
|
||
.br
|
||
.RI "Copy a radial seed onto another radius without changing its material thermodynamics\&. "
|
||
.ti -1c
|
||
.RI "std::expected< \fButils::laneemden::PhysicalSample\fP, std::string > \fBserif::solver::seed::evaluate_radial_seed\fP (const \fBFittedRadialSeed\fP &seed, \fBdimensions::LengthValue\fP radius)"
|
||
.br
|
||
.RI "Evaluate the fitted density and its consistent spherical gravity, retaining the source enthalpy\&. "
|
||
.ti -1c
|
||
.RI "const \fBRadialSeed\fP & \fBserif::solver::seed::detail::radial_source\fP (const \fBRadialSeed\fP &seed)"
|
||
.br
|
||
.RI "Inspect the unchanged physical source of a strict seed\&. "
|
||
.ti -1c
|
||
.RI "const \fBRadialSeed\fP & \fBserif::solver::seed::detail::radial_source\fP (const \fBFittedRadialSeed\fP &seed)"
|
||
.br
|
||
.RI "Inspect the unchanged physical source of an explicitly fitted guess\&. "
|
||
.ti -1c
|
||
.RI "\fBdimensions::LengthValue\fP \fBserif::solver::seed::detail::radial_radius\fP (const \fBRadialSeed\fP &seed)"
|
||
.br
|
||
.RI "Use the equilibrium radius for ordinary projection\&. "
|
||
.ti -1c
|
||
.RI "\fBdimensions::LengthValue\fP \fBserif::solver::seed::detail::radial_radius\fP (const \fBFittedRadialSeed\fP &seed)"
|
||
.br
|
||
.RI "Use the explicit destination radius for fitted projection\&. "
|
||
.ti -1c
|
||
.RI "\fBdimensions::MassValue\fP \fBserif::solver::seed::detail::radial_mass\fP (const \fBRadialSeed\fP &seed)"
|
||
.br
|
||
.RI "Retain the original spherical mass for ordinary projection\&. "
|
||
.ti -1c
|
||
.RI "\fBdimensions::MassValue\fP \fBserif::solver::seed::detail::radial_mass\fP (const \fBFittedRadialSeed\fP &seed)"
|
||
.br
|
||
.RI "Use the mass of the stretched density for fitted gravity projection\&. "
|
||
.in -1c
|
||
.SH "Author"
|
||
.PP
|
||
Generated automatically by Doxygen for SERiF from the source code\&.
|