Files
MeanField_SERiF/docs/man/man3/serif_model_FixedCentralDensity.3

102 lines
3.0 KiB
Groff
Raw Permalink Normal View History

.TH "serif::model::FixedCentralDensity" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::model::FixedCentralDensity \- Prescribe central density with an independently dimensioned enthalpy phase equation\&.
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <fixed_central_density\&.hpp>\fP
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBParameters\fP"
.br
.in -1c
.SS "Public Types"
.in +1c
.ti -1c
.RI "using \fBScalarDescription\fP"
.br
.ti -1c
.RI "using \fBTargetValue\fP = ScalarDescription::TargetValue"
.br
.ti -1c
.RI "using \fBModelDefinition\fP"
.br
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBFixedCentralDensity\fP (\fBTargetValue\fP density)"
.br
.RI "Require a positive finite central density\&. "
.ti -1c
.RI "\fBFixedCentralDensity\fP (\fBParameters\fP parameters)"
.br
.RI "Construct from named physical parameters\&. "
.ti -1c
.RI "\fBTargetValue\fP \fBtarget\fP () const noexcept"
.br
.RI "Inspect the prescribed central density rather than the residual's enthalpy units\&. "
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBTargetValue\fP \fBm_target\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Prescribe central density with an independently dimensioned enthalpy phase equation\&.
.SH "Member Typedef Documentation"
.PP
.SS "using \fBserif::model::FixedCentralDensity::ModelDefinition\fP"
\fBInitial value:\fP
.nf
SpecificationDefinition<FixedCentralDensity, "FixedCentralDensity", SpecificationRole::phase_condition, GeneratedStateKind::solver_border,
ScalarDescription, Reads<state::SpecificEnthalpy>, Changes<equation::HydrostaticBalance>>
.PP
.fi
.SS "using \fBserif::model::FixedCentralDensity::ScalarDescription\fP"
\fBInitial value:\fP
.nf
ScalarConstraint<dimensions::MassDensity, dimensions::SpecificEnthalpy, dimensions::SpecificEnthalpy,
"fixed_central_density\&.border", "lambda_rho_c", "fixed_central_density\&.residual", "R_rho_c">
.PP
.fi
.SS "using \fBserif::model::FixedCentralDensity::TargetValue\fP = ScalarDescription::TargetValue"
.SH "Constructor & Destructor Documentation"
.PP
.SS "serif::model::FixedCentralDensity::FixedCentralDensity (\fBTargetValue\fP density)\fR [explicit]\fP"
.PP
Require a positive finite central density\&. Store a physically admissible central density\&.
.SS "serif::model::FixedCentralDensity::FixedCentralDensity (\fBParameters\fP parameters)\fR [explicit]\fP"
.PP
Construct from named physical parameters\&. Delegate named central-density parameters to the dimensional constructor\&.
.SH "Member Function Documentation"
.PP
.SS "\fBTargetValue\fP serif::model::FixedCentralDensity::target () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Inspect the prescribed central density rather than the residual's enthalpy units\&.
.SH "Member Data Documentation"
.PP
.SS "\fBTargetValue\fP serif::model::FixedCentralDensity::m_target\fR [private]\fP"
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.