.TH "serif::eos::models::Polytrope" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::eos::models::Polytrope
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <polytropic\&.hpp>\fP
.SS "Public Types"

.in +1c
.ti -1c
.RI "using \fBRelations\fP"
.br
.RI "A type alias for the relation catalog that this EOS supports\&. This is used to determine which relations are valid for this EOS\&. "
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBPolytrope\fP (const \fBPolytropeParameters\fP &parameters)"
.br
.RI "Constructs a \fBPolytrope\fP with the given parameters\&. "
.ti -1c
.RI "\fBPolytrope\fP (double n, double K)"
.br
.RI "Constructs a \fBPolytrope\fP with the given polytropic index and constant\&. "
.ti -1c
.RI "double \fBpolytropic_index\fP () const noexcept"
.br
.RI "Returns the polytropic index of the equation of state\&. "
.ti -1c
.RI "double \fBpolytropic_constant\fP () const noexcept"
.br
.RI "Returns the polytropic constant of the equation of state\&. "
.ti -1c
.RI "double \fBenthalpy_scale\fP () const noexcept"
.br
.RI "Returns the enthalpy scale of the equation of state\&. Note that this is calculated at construction time from the polytropic index and constant as h = (n + 1) * K\&. "
.ti -1c
.RI "\fBdimensions::PressureValue\fP \fBevaluate\fP (\fBrelations::PressureFromDensity\fP, \fBdimensions::DensityValue\fP density) const"
.br
.RI "Evaluate the pressure from the density\&. "
.ti -1c
.RI "\fBdimensions::DensityValue\fP \fBevaluate\fP (\fBrelations::DensityFromPressure\fP, \fBdimensions::PressureValue\fP pressure) const"
.br
.RI "Evaluate the density at a nonnegative pressure, including the vacuum trace\&. "
.ti -1c
.RI "\fBdimensions::BarotropicPressurePotentialValue\fP \fBevaluate\fP (\fBrelations::PressurePotentialFromDensity\fP, \fBdimensions::DensityValue\fP density) const"
.br
.RI "Evaluate the pressure primitive; for this EOS it equals the specific enthalpy and vanishes in vacuum\&. "
.ti -1c
.RI "\fBdimensions::PressureValue\fP \fBevaluate\fP (\fBrelations::PressureFromSpecificEnthalpy\fP, \fBdimensions::SpecificEnthalpyValue\fP specific_enthalpy) const"
.br
.RI "Evaluate the pressure from the specific enthalpy\&. "
.ti -1c
.RI "\fBdimensions::SpecificEnthalpyValue\fP \fBevaluate\fP (\fBrelations::SpecificEnthalpyFromDensity\fP, \fBdimensions::DensityValue\fP density) const"
.br
.RI "Evaluate the specific enthalpy from the density\&. "
.ti -1c
.RI "\fBdimensions::SpecificEnthalpyValue\fP \fBevaluate\fP (\fBrelations::SpecificEnthalpyFromPressure\fP, \fBdimensions::PressureValue\fP pressure) const"
.br
.RI "Evaluate the specific enthalpy from the pressure\&. "
.ti -1c
.RI "\fBdimensions::DensityValue\fP \fBevaluate\fP (\fBrelations::DensityFromSpecificEnthalpy\fP, \fBdimensions::SpecificEnthalpyValue\fP specific_enthalpy) const"
.br
.RI "Evaluate the density from the specific enthalpy\&. "
.ti -1c
.RI "\fBdimensions::PartialDerivative\fP< \fBdimensions::MassDensity\fP, \fBdimensions::SpecificEnthalpy\fP > \fBpartial_derivative\fP (\fBrelations::DensityFromSpecificEnthalpy\fP, \fBdimensions::WithRespectTo\fP< \fBdimensions::SpecificEnthalpy\fP >, \fBdimensions::SpecificEnthalpyValue\fP specific_enthalpy) const"
.br
.RI "Evaluate the partial derivative of the density with respect to the specific enthalpy\&. "
.ti -1c
.RI "\fBdimensions::PartialDerivative\fP< \fBdimensions::Pressure\fP, \fBdimensions::SpecificEnthalpy\fP > \fBpartial_derivative\fP (\fBrelations::PressureFromSpecificEnthalpy\fP, \fBdimensions::WithRespectTo\fP< \fBdimensions::SpecificEnthalpy\fP >, \fBdimensions::SpecificEnthalpyValue\fP specific_enthalpy) const"
.br
.RI "Evaluate the partial derivative of the pressure with respect to the specific enthalpy\&. "
.ti -1c
.RI "\fBdimensions::PartialDerivative\fP< \fBdimensions::Pressure\fP, \fBdimensions::MassDensity\fP > \fBpartial_derivative\fP (\fBrelations::PressureFromDensity\fP, \fBdimensions::WithRespectTo\fP< \fBdimensions::MassDensity\fP >, \fBdimensions::DensityValue\fP density) const"
.br
.RI "Evaluate the partial derivative of the pressure with respect to the mass density\&. "
.ti -1c
.RI "\fBdimensions::SecondPartialDerivative\fP< \fBdimensions::Pressure\fP, \fBdimensions::MassDensity\fP, \fBdimensions::MassDensity\fP > \fBsecond_partial_derivative\fP (\fBrelations::PressureFromDensity\fP, \fBdimensions::WithRespectTo\fP< \fBdimensions::MassDensity\fP >, \fBdimensions::WithRespectTo\fP< \fBdimensions::MassDensity\fP >, \fBdimensions::DensityValue\fP density) const"
.br
.RI "Evaluate d²P/dρ²; for n > 1 its vacuum limit is singular and is rejected\&. "
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "double \fBm_polytropic_index\fP"
.br
.RI "The polytropic index of the equation of state\&. "
.ti -1c
.RI "double \fBm_polytropic_constant\fP"
.br
.RI "The polytropic constant of the equation of state\&. "
.ti -1c
.RI "double \fBm_enthalpy_scale\fP"
.br
.RI "The enthalpy scale of the equation of state, calculated as (n + 1) * K\&. "
.in -1c
.SH "Member Typedef Documentation"
.PP 
.SS "using \fBserif::eos::models::Polytrope::Relations\fP"
\fBInitial value:\fP
.nf
 relations::RelationCatalog<
            relations::PressureFromDensity,
            relations::DensityFromPressure,
            relations::PressureFromSpecificEnthalpy,
            relations::SpecificEnthalpyFromDensity,
            relations::SpecificEnthalpyFromPressure,
            relations::DensityFromSpecificEnthalpy,
            relations::PressurePotentialFromDensity
        >
.PP
.fi

.PP
A type alias for the relation catalog that this EOS supports\&. This is used to determine which relations are valid for this EOS\&. A polytropic EOS supports the following relations:
.IP "\(bu" 2
\fBPressureFromDensity\fP
.IP "\(bu" 2
\fBDensityFromPressure\fP
.IP "\(bu" 2
\fBPressureFromSpecificEnthalpy\fP
.IP "\(bu" 2
\fBSpecificEnthalpyFromDensity\fP
.IP "\(bu" 2
\fBSpecificEnthalpyFromPressure\fP
.IP "\(bu" 2
\fBDensityFromSpecificEnthalpy\fP
.IP "\(bu" 2
\fBPressurePotentialFromDensity\fP 
.PP

.SH "Constructor & Destructor Documentation"
.PP 
.SS "serif::eos::models::Polytrope::Polytrope (const \fBPolytropeParameters\fP & parameters)\fR [explicit]\fP"

.PP
Constructs a \fBPolytrope\fP with the given parameters\&. 
.PP
\fBParameters\fP
.RS 4
\fIparameters\fP The parameters for the polytropic equation of state\&. 
.RE
.PP

.SS "serif::eos::models::Polytrope::Polytrope (double n, double K)\fR [explicit]\fP"

.PP
Constructs a \fBPolytrope\fP with the given polytropic index and constant\&. 
.PP
\fBParameters\fP
.RS 4
\fIn\fP The polytropic index\&. 
.br
\fIK\fP The polytropic constant\&. 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "double serif::eos::models::Polytrope::enthalpy_scale () const\fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Returns the enthalpy scale of the equation of state\&. Note that this is calculated at construction time from the polytropic index and constant as h = (n + 1) * K\&. 
.PP
\fBReturns\fP
.RS 4
The enthalpy scale\&. 
.RE
.PP

.SS "\fBDensityValue\fP serif::eos::models::Polytrope::evaluate (\fBrelations::DensityFromPressure\fP , \fBdimensions::PressureValue\fP pressure) const\fR [nodiscard]\fP"

.PP
Evaluate the density at a nonnegative pressure, including the vacuum trace\&. 
.SS "\fBDensityValue\fP serif::eos::models::Polytrope::evaluate (\fBrelations::DensityFromSpecificEnthalpy\fP , \fBdimensions::SpecificEnthalpyValue\fP specific_enthalpy) const\fR [nodiscard]\fP"

.PP
Evaluate the density from the specific enthalpy\&. 
.PP
\fBParameters\fP
.RS 4
\fIrelation\fP The relation to evaluate (note that this is not used in the function but is used to constrain the overload being called)\&. 
.br
\fIspecific_enthalpy\fP The specific enthalpy value to evaluate the density from\&. 
.RE
.PP

.SS "\fBPressureValue\fP serif::eos::models::Polytrope::evaluate (\fBrelations::PressureFromDensity\fP , \fBdimensions::DensityValue\fP density) const\fR [nodiscard]\fP"

.PP
Evaluate the pressure from the density\&. 
.PP
\fBParameters\fP
.RS 4
\fIrelation\fP The relation to evaluate (note that this is not used in the function but is used to constrain the overload being called)\&. 
.br
\fIdensity\fP The density value to evaluate the pressure from\&. 
.RE
.PP

.SS "\fBPressureValue\fP serif::eos::models::Polytrope::evaluate (\fBrelations::PressureFromSpecificEnthalpy\fP , \fBdimensions::SpecificEnthalpyValue\fP specific_enthalpy) const\fR [nodiscard]\fP"

.PP
Evaluate the pressure from the specific enthalpy\&. 
.PP
\fBParameters\fP
.RS 4
\fIrelation\fP The relation to evaluate (note that this is not used in the function but is used to constrain the overload being called)\&. 
.br
\fIspecific_enthalpy\fP The specific enthalpy value to evaluate the pressure from\&. 
.RE
.PP

.SS "\fBBarotropicPressurePotentialValue\fP serif::eos::models::Polytrope::evaluate (\fBrelations::PressurePotentialFromDensity\fP , \fBdimensions::DensityValue\fP density) const\fR [nodiscard]\fP"

.PP
Evaluate the pressure primitive; for this EOS it equals the specific enthalpy and vanishes in vacuum\&. Reuse the polytropic enthalpy relation, which is also this EOS's pressure primitive\&. 
.SS "\fBSpecificEnthalpyValue\fP serif::eos::models::Polytrope::evaluate (\fBrelations::SpecificEnthalpyFromDensity\fP , \fBdimensions::DensityValue\fP density) const\fR [nodiscard]\fP"

.PP
Evaluate the specific enthalpy from the density\&. 
.PP
\fBParameters\fP
.RS 4
\fIrelation\fP The relation to evaluate (note that this is not used in the function but is used to constrain the overload being called)\&. 
.br
\fIdensity\fP The density value to evaluate the specific enthalpy from\&. 
.RE
.PP

.SS "\fBSpecificEnthalpyValue\fP serif::eos::models::Polytrope::evaluate (\fBrelations::SpecificEnthalpyFromPressure\fP , \fBdimensions::PressureValue\fP pressure) const\fR [nodiscard]\fP"

.PP
Evaluate the specific enthalpy from the pressure\&. 
.PP
\fBParameters\fP
.RS 4
\fIrelation\fP The relation to evaluate (note that this is not used in the function but is used to constrain the overload being called)\&. 
.br
\fIpressure\fP The pressure value to evaluate the specific enthalpy from\&. 
.RE
.PP

.SS "\fBPartialDerivative\fP< \fBMassDensity\fP, \fBSpecificEnthalpy\fP > serif::eos::models::Polytrope::partial_derivative (\fBrelations::DensityFromSpecificEnthalpy\fP , \fBdimensions::WithRespectTo\fP< \fBdimensions::SpecificEnthalpy\fP > , \fBdimensions::SpecificEnthalpyValue\fP specific_enthalpy) const\fR [nodiscard]\fP"

.PP
Evaluate the partial derivative of the density with respect to the specific enthalpy\&. 
.PP
\fBParameters\fP
.RS 4
\fIrelation\fP The relation to evaluate (note that this is not used in the function but is used to constrain the overload being called)\&. 
.br
\fIwith_respect_to\fP The quantity to take the partial derivative with respect to (note that this is not used in the function but is used to constrain the overload being called)\&. 
.br
\fIspecific_enthalpy\fP The specific enthalpy value to evaluate the partial derivative from\&. 
.RE
.PP

.SS "\fBPartialDerivative\fP< \fBPressure\fP, \fBMassDensity\fP > serif::eos::models::Polytrope::partial_derivative (\fBrelations::PressureFromDensity\fP , \fBdimensions::WithRespectTo\fP< \fBdimensions::MassDensity\fP > , \fBdimensions::DensityValue\fP density) const\fR [nodiscard]\fP"

.PP
Evaluate the partial derivative of the pressure with respect to the mass density\&. 
.PP
\fBParameters\fP
.RS 4
\fIrelation\fP The relation to evaluate (note that this is not used in the function but is used to constrain the overload being called)\&. 
.br
\fIwith_respect_to\fP The quantity to take the partial derivative with respect to (note that this is not used in the function but is used to constrain the overload being called)\&. 
.br
\fIdensity\fP The density value to evaluate the partial derivative from\&. 
.RE
.PP

.SS "\fBPartialDerivative\fP< \fBPressure\fP, \fBSpecificEnthalpy\fP > serif::eos::models::Polytrope::partial_derivative (\fBrelations::PressureFromSpecificEnthalpy\fP , \fBdimensions::WithRespectTo\fP< \fBdimensions::SpecificEnthalpy\fP > , \fBdimensions::SpecificEnthalpyValue\fP specific_enthalpy) const\fR [nodiscard]\fP"

.PP
Evaluate the partial derivative of the pressure with respect to the specific enthalpy\&. 
.PP
\fBParameters\fP
.RS 4
\fIrelation\fP The relation to evaluate (note that this is not used in the function but is used to constrain the overload being called)\&. 
.br
\fIwith_respect_to\fP The quantity to take the partial derivative with respect to (note that this is not used in the function but is used to constrain the overload being called)\&. 
.br
\fIspecific_enthalpy\fP The specific enthalpy value to evaluate the partial derivative from\&. 
.RE
.PP

.SS "double serif::eos::models::Polytrope::polytropic_constant () const\fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Returns the polytropic constant of the equation of state\&. 
.PP
\fBReturns\fP
.RS 4
The polytropic constant\&. 
.RE
.PP

.SS "double serif::eos::models::Polytrope::polytropic_index () const\fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Returns the polytropic index of the equation of state\&. 
.PP
\fBReturns\fP
.RS 4
The polytropic index\&. 
.RE
.PP

.SS "\fBSecondPartialDerivative\fP< \fBPressure\fP, \fBMassDensity\fP, \fBMassDensity\fP > serif::eos::models::Polytrope::second_partial_derivative (\fBrelations::PressureFromDensity\fP , \fBdimensions::WithRespectTo\fP< \fBdimensions::MassDensity\fP > , \fBdimensions::WithRespectTo\fP< \fBdimensions::MassDensity\fP > , \fBdimensions::DensityValue\fP density) const\fR [nodiscard]\fP"

.PP
Evaluate d²P/dρ²; for n > 1 its vacuum limit is singular and is rejected\&. 
.SH "Member Data Documentation"
.PP 
.SS "double serif::eos::models::Polytrope::m_enthalpy_scale\fR [private]\fP"

.PP
The enthalpy scale of the equation of state, calculated as (n + 1) * K\&. 
.SS "double serif::eos::models::Polytrope::m_polytropic_constant\fR [private]\fP"

.PP
The polytropic constant of the equation of state\&. 
.SS "double serif::eos::models::Polytrope::m_polytropic_index\fR [private]\fP"

.PP
The polytropic index of the equation of state\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for SERiF from the source code\&.