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)
59 lines
2.1 KiB
Groff
59 lines
2.1 KiB
Groff
.TH "serif::solver::normalization::LaneEmdenApproximation< Mass, CentralDensity >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
.ad l
|
||
.nh
|
||
.SH NAME
|
||
serif::solver::normalization::LaneEmdenApproximation< Mass, CentralDensity > \- Estimate a reference radius from a Lane–Emden shape, mass and central density\&.
|
||
|
||
.SH SYNOPSIS
|
||
.br
|
||
.PP
|
||
.PP
|
||
\fR#include <configuration\&.hpp>\fP
|
||
.SS "Public Attributes"
|
||
|
||
.in +1c
|
||
.ti -1c
|
||
.RI "double \fBn\fP {3\&.0}"
|
||
.br
|
||
.ti -1c
|
||
.RI "Mass \fBmass\fP"
|
||
.br
|
||
.ti -1c
|
||
.RI "CentralDensity \fBcentral_density\fP"
|
||
.br
|
||
.ti -1c
|
||
.RI "\fButils::laneemden::IntegrationOptions\fP \fBintegration\fP {}"
|
||
.br
|
||
.in -1c
|
||
.SH "Detailed Description"
|
||
.PP
|
||
|
||
.SS "template<typename Mass = FromModel, typename CentralDensity = FromModel>
|
||
.br
|
||
requires (std::same_as<Mass, \fBFromModel\fP> || std::same_as<Mass, \fBdimensions::MassValue\fP>) && (std::same_as<CentralDensity, \fBFromModel\fP> || std::same_as<CentralDensity, \fBdimensions::DensityValue\fP>)
|
||
.br
|
||
struct serif::solver::normalization::LaneEmdenApproximation< Mass, CentralDensity >"Estimate a reference radius from a Lane–Emden shape, mass and central density\&.
|
||
|
||
|
||
.PP
|
||
\fBNote\fP
|
||
.RS 4
|
||
These describe the numerical reference star; they never alter the model's EOS or constraints\&.
|
||
.RE
|
||
.PP
|
||
|
||
.SH "Member Data Documentation"
|
||
.PP
|
||
.SS "template<typename Mass = FromModel, typename CentralDensity = FromModel> CentralDensity \fBserif::solver::normalization::LaneEmdenApproximation\fP< Mass, CentralDensity >::central_density"
|
||
|
||
.SS "template<typename Mass = FromModel, typename CentralDensity = FromModel> \fButils::laneemden::IntegrationOptions\fP \fBserif::solver::normalization::LaneEmdenApproximation\fP< Mass, CentralDensity >::integration {}"
|
||
|
||
.SS "template<typename Mass = FromModel, typename CentralDensity = FromModel> Mass \fBserif::solver::normalization::LaneEmdenApproximation\fP< Mass, CentralDensity >::mass"
|
||
|
||
.SS "template<typename Mass = FromModel, typename CentralDensity = FromModel> double \fBserif::solver::normalization::LaneEmdenApproximation\fP< Mass, CentralDensity >::n {3\&.0}"
|
||
|
||
|
||
.SH "Author"
|
||
.PP
|
||
Generated automatically by Doxygen for SERiF from the source code\&.
|