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)
82 lines
2.6 KiB
Groff
82 lines
2.6 KiB
Groff
.TH "serif::solver::continuation::PolytropicIndex" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::continuation::PolytropicIndex
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <stellar_parameters\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBSpecification\fP = \fBeos::models::Polytrope\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBValue\fP = double"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBRequiredDependentParameters\fP = \fBParameterList\fP<\fBPolytropicConstant\fP>"
|
|
.br
|
|
.in -1c
|
|
.SS "Static Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static double \fBread\fP (const \fBSpecification\fP &value) noexcept"
|
|
.br
|
|
.RI "Read the physical EOS index\&. "
|
|
.ti -1c
|
|
.RI "static bool \fBvalid\fP (double value) noexcept"
|
|
.br
|
|
.RI "Match the domain supported by SERiF's barotropic EOS\&. "
|
|
.ti -1c
|
|
.RI "static double \fBstarting_value\fP (double) noexcept"
|
|
.br
|
|
.RI "Start with the analytically simple n=1 family member\&. "
|
|
.in -1c
|
|
.SS "Static Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBname\fP = 'polytropic index'"
|
|
.br
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBstable_id\fP = 'polytrope\&.index'"
|
|
.br
|
|
.in -1c
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "using \fBserif::solver::continuation::PolytropicIndex::RequiredDependentParameters\fP = \fBParameterList\fP<\fBPolytropicConstant\fP>"
|
|
|
|
.SS "using \fBserif::solver::continuation::PolytropicIndex::Specification\fP = \fBeos::models::Polytrope\fP"
|
|
|
|
.SS "using \fBserif::solver::continuation::PolytropicIndex::Value\fP = double"
|
|
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "static double serif::solver::continuation::PolytropicIndex::read (const \fBSpecification\fP & value)\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Read the physical EOS index\&.
|
|
.SS "static double serif::solver::continuation::PolytropicIndex::starting_value (double )\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Start with the analytically simple n=1 family member\&.
|
|
.SS "static bool serif::solver::continuation::PolytropicIndex::valid (double value)\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
|
|
|
.PP
|
|
Match the domain supported by SERiF's barotropic EOS\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "std::string_view serif::solver::continuation::PolytropicIndex::name = 'polytropic index'\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.SS "std::string_view serif::solver::continuation::PolytropicIndex::stable_id = 'polytrope\&.index'\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|