.TH "serif::model::FixedTotalMass" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::model::FixedTotalMass \- Prescribe total stellar mass while the effective surface-potential level remains an independent solved coordinate\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <fixed_total_mass\&.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 "\fBFixedTotalMass\fP (\fBTargetValue\fP mass)"
.br
.RI "Require a positive finite target mass\&. "
.ti -1c
.RI "\fBFixedTotalMass\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 total mass\&. "
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "\fBTargetValue\fP \fBm_target\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Prescribe total stellar mass while the effective surface-potential level remains an independent solved coordinate\&. 
.SH "Member Typedef Documentation"
.PP 
.SS "using \fBserif::model::FixedTotalMass::ModelDefinition\fP"
\fBInitial value:\fP
.nf
 SpecificationDefinition<FixedTotalMass, "FixedTotalMass", SpecificationRole::invariant, GeneratedStateKind::multiplier,
                                                        ScalarDescription, Reads<state::Density, state::SurfaceShape>, Changes<equation::SurfaceShapeBalance>>
.PP
.fi

.SS "using \fBserif::model::FixedTotalMass::ScalarDescription\fP"
\fBInitial value:\fP
.nf
 ScalarConstraint<dimensions::Mass, dimensions::GravitationalPotential, dimensions::Mass,
                                                   "fixed_total_mass\&.multiplier", "Us", "fixed_total_mass\&.residual", "R_M">
.PP
.fi

.SS "using \fBserif::model::FixedTotalMass::TargetValue\fP = ScalarDescription::TargetValue"

.SH "Constructor & Destructor Documentation"
.PP 
.SS "serif::model::FixedTotalMass::FixedTotalMass (\fBTargetValue\fP mass)\fR [explicit]\fP"

.PP
Require a positive finite target mass\&. Store a physically admissible total mass\&. 
.SS "serif::model::FixedTotalMass::FixedTotalMass (\fBParameters\fP parameters)\fR [explicit]\fP"

.PP
Construct from named physical parameters\&. Delegate named mass parameters to the dimensional constructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBTargetValue\fP serif::model::FixedTotalMass::target () const\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"

.PP
Inspect the prescribed total mass\&. 
.SH "Member Data Documentation"
.PP 
.SS "\fBTargetValue\fP serif::model::FixedTotalMass::m_target\fR [private]\fP"


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