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)
54 lines
2.4 KiB
Groff
54 lines
2.4 KiB
Groff
.TH "src/lib/serif/utils/laneemden/scaling.cpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/lib/serif/utils/laneemden/scaling.cpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include 'serif/utils/laneemden/scaling\&.hpp'\fP
|
|
.br
|
|
\fR#include <algorithm>\fP
|
|
.br
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include <numbers>\fP
|
|
.br
|
|
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::utils\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::utils::laneemden\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::expected< \fBPhysicalScales\fP, std::string > \fBserif::utils::laneemden::scale_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 > \fBserif::utils::laneemden::scale_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 > \fBserif::utils::laneemden::scale_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 > \fBserif::utils::laneemden::evaluate_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\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|