69 lines
2.1 KiB
Groff
69 lines
2.1 KiB
Groff
|
|
.TH "serif::solver::continuation::PolytropicConstant" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::solver::continuation::PolytropicConstant
|
||
|
|
.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
|
||
|
|
.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 dimensional numerical coefficient in the current physical units\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "static bool \fBvalid\fP (double value) noexcept"
|
||
|
|
.br
|
||
|
|
.RI "A finite positive coefficient gives positive pressure at positive density\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Static Public Attributes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "static constexpr std::string_view \fBname\fP = 'polytropic constant'"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "static constexpr std::string_view \fBstable_id\fP = 'polytrope\&.constant'"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Member Typedef Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "using \fBserif::solver::continuation::PolytropicConstant::Specification\fP = \fBeos::models::Polytrope\fP"
|
||
|
|
|
||
|
|
.SS "using \fBserif::solver::continuation::PolytropicConstant::Value\fP = double"
|
||
|
|
|
||
|
|
.SH "Member Function Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "static double serif::solver::continuation::PolytropicConstant::read (const \fBSpecification\fP & value)\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Read the dimensional numerical coefficient in the current physical units\&.
|
||
|
|
.SS "static bool serif::solver::continuation::PolytropicConstant::valid (double value)\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
A finite positive coefficient gives positive pressure at positive density\&.
|
||
|
|
.SH "Member Data Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "std::string_view serif::solver::continuation::PolytropicConstant::name = 'polytropic constant'\fR [static]\fP, \fR [constexpr]\fP"
|
||
|
|
|
||
|
|
.SS "std::string_view serif::solver::continuation::PolytropicConstant::stable_id = 'polytrope\&.constant'\fR [static]\fP, \fR [constexpr]\fP"
|
||
|
|
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|