.TH "serif::utils::laneemden" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*- .ad l .nh .SH NAME serif::utils::laneemden .SH SYNOPSIS .br .PP .SS "Classes" .in +1c .ti -1c .RI "struct \fBIntegrationOptions\fP" .br .RI "Dimensionless integration controls; the surface tolerance does not bound the global integration error\&. " .ti -1c .RI "struct \fBPhysicalSample\fP" .br .RI "Physical scalar fields; gravity is the outward potential derivative, not the inward force component\&. " .ti -1c .RI "struct \fBPhysicalScales\fP" .br .RI "A physical conversion of one finite-radius dimensionless polytrope, in the caller's consistent units\&. " .ti -1c .RI "struct \fBSample\fP" .br .RI "The regular Lane–Emden solution and its first derivative at one dimensionless radius\&. " .ti -1c .RI "struct \fBSolution\fP" .br .RI "A regular profile, ending at its first zero or the requested integration radius\&. " .in -1c .SS "Functions" .in +1c .ti -1c .RI "std::expected< \fBPhysicalScales\fP, std::string > \fBscale_from_mass\fP (const \fBSolution\fP &solution, \fBdimensions::QuantityValue\fP< \fBdimensions::Mass\fP > mass, \fBdimensions::QuantityValue\fP< \fBdimensions::MassDensity\fP > central_density, \fBdimensions::QuantityValue\fP< \fBdimensions::GravitationalConstant\fP > gravitational_constant)" .br .RI "Fix a reference star by mass and central density; its implied K is an output, never a change to an EOS\&. " .ti -1c .RI "std::expected< \fBPhysicalScales\fP, std::string > \fBscale_from_enthalpy\fP (const \fBSolution\fP &solution, \fBdimensions::QuantityValue\fP< \fBdimensions::SpecificEnthalpy\fP > central_enthalpy, \fBdimensions::QuantityValue\fP< \fBdimensions::MassDensity\fP > central_density, \fBdimensions::QuantityValue\fP< \fBdimensions::GravitationalConstant\fP > gravitational_constant)" .br .RI "Fix a physical star by central enthalpy and density, including the incompressible n = 0 limit\&. " .ti -1c .RI "std::expected< \fBPhysicalScales\fP, std::string > \fBscale_from_polytropic_constant\fP (const \fBSolution\fP &solution, double polytropic_constant, \fBdimensions::QuantityValue\fP< \fBdimensions::MassDensity\fP > central_density, \fBdimensions::QuantityValue\fP< \fBdimensions::GravitationalConstant\fP > gravitational_constant)" .br .RI "Fix a polytropic EOS through its K and central density; n must be strictly positive\&. " .ti -1c .RI "std::expected< \fBPhysicalSample\fP, std::string > \fBevaluate_physical\fP (const \fBSolution\fP &solution, const \fBPhysicalScales\fP &scales, \fBdimensions::QuantityValue\fP< \fBdimensions::Length\fP > radius)" .br .RI "Evaluate physical fields, continuing into vacuum beyond the stellar surface\&. " .ti -1c .RI "std::expected< \fBSolution\fP, std::string > \fBsolve\fP (double n, \fBIntegrationOptions\fP options={})" .br .RI "Integrate theta'' + 2 theta'/xi + theta^n = 0 from the regular center\&. " .ti -1c .RI "std::expected< \fBSample\fP, std::string > \fBevaluate\fP (const \fBSolution\fP &solution, double xi)" .br .RI "Evaluate a solved dimensionless profile with cubic Hermite interpolation, without extrapolation\&. " .in -1c .SH "Function Documentation" .PP .SS "std::expected< \fBSample\fP, std::string > serif::utils::laneemden::evaluate (const \fBSolution\fP & solution, double xi)\fR [nodiscard]\fP" .PP Evaluate a solved dimensionless profile with cubic Hermite interpolation, without extrapolation\&. .SS "std::expected< \fBPhysicalSample\fP, std::string > serif::utils::laneemden::evaluate_physical (const \fBSolution\fP & solution, const \fBPhysicalScales\fP & scales, \fBdimensions::QuantityValue\fP< \fBdimensions::Length\fP > radius)\fR [nodiscard]\fP" .PP Evaluate physical fields, continuing into vacuum beyond the stellar surface\&. The potential vanishes at infinity\&. Density, pressure, and enthalpy are zero at and beyond the surface, including the exterior side of the incompressible density jump\&. .SS "std::expected< \fBPhysicalScales\fP, std::string > serif::utils::laneemden::scale_from_enthalpy (const \fBSolution\fP & solution, \fBdimensions::QuantityValue\fP< \fBdimensions::SpecificEnthalpy\fP > central_enthalpy, \fBdimensions::QuantityValue\fP< \fBdimensions::MassDensity\fP > central_density, \fBdimensions::QuantityValue\fP< \fBdimensions::GravitationalConstant\fP > gravitational_constant)\fR [nodiscard]\fP" .PP Fix a physical star by central enthalpy and density, including the incompressible n = 0 limit\&. .SS "std::expected< \fBPhysicalScales\fP, std::string > serif::utils::laneemden::scale_from_mass (const \fBSolution\fP & solution, \fBdimensions::QuantityValue\fP< \fBdimensions::Mass\fP > mass, \fBdimensions::QuantityValue\fP< \fBdimensions::MassDensity\fP > central_density, \fBdimensions::QuantityValue\fP< \fBdimensions::GravitationalConstant\fP > gravitational_constant)\fR [nodiscard]\fP" .PP Fix a reference star by mass and central density; its implied K is an output, never a change to an EOS\&. .SS "std::expected< \fBPhysicalScales\fP, std::string > serif::utils::laneemden::scale_from_polytropic_constant (const \fBSolution\fP & solution, double polytropic_constant, \fBdimensions::QuantityValue\fP< \fBdimensions::MassDensity\fP > central_density, \fBdimensions::QuantityValue\fP< \fBdimensions::GravitationalConstant\fP > gravitational_constant)\fR [nodiscard]\fP" .PP Fix a polytropic EOS through its K and central density; n must be strictly positive\&. .SS "std::expected< \fBSolution\fP, std::string > serif::utils::laneemden::solve (double n, \fBIntegrationOptions\fP options = \fR{}\fP)\fR [nodiscard]\fP" .PP Integrate theta'' + 2 theta'/xi + theta^n = 0 from the regular center\&. The central series follows Boudreaux's original power-series recurrence\&. Both dependent variables now advance through the same four Runge–Kutta stages\&. A missing surface is a valid finite-interval result, including the n >= 5 solutions\&. Exhausting the step budget or producing an unrepresentable numerical state returns a failure instead\&. .SH "Author" .PP Generated automatically by Doxygen for SERiF from the source code\&.