serif::model::FixedTotalMass Class Reference

Prescribe total stellar mass while the effective surface-potential level remains an independent solved coordinate. More...

#include <fixed_total_mass.hpp>

Classes
struct	Parameters

Public Types
using	ScalarDescription
using	TargetValue = ScalarDescription::TargetValue
using	ModelDefinition

Public Member Functions
	FixedTotalMass (TargetValue mass)
	Require a positive finite target mass.
	FixedTotalMass (Parameters parameters)
	Construct from named physical parameters.
TargetValue	target () const noexcept
	Inspect the prescribed total mass.

Private Attributes
TargetValue	m_target

Detailed Description

Prescribe total stellar mass while the effective surface-potential level remains an independent solved coordinate.

Member Typedef Documentation

ModelDefinition

using serif::model::FixedTotalMass::ModelDefinition

Initial value:

 SpecificationDefinition<FixedTotalMass, "FixedTotalMass", SpecificationRole::invariant, GeneratedStateKind::multiplier,
                                                        ScalarDescription, Reads<state::Density, state::SurfaceShape>, Changes<equation::SurfaceShapeBalance>>

ScalarDescription

using serif::model::FixedTotalMass::ScalarDescription

Initial value:

 ScalarConstraint<dimensions::Mass, dimensions::GravitationalPotential, dimensions::Mass,
                                                   "fixed_total_mass.multiplier", "Us", "fixed_total_mass.residual", "R_M">

TargetValue

using serif::model::FixedTotalMass::TargetValue = ScalarDescription::TargetValue

Constructor & Destructor Documentation

FixedTotalMass() [1/2]

serif::model::FixedTotalMass::FixedTotalMass ( TargetValue mass )

explicit

Require a positive finite target mass.

Store a physically admissible total mass.

FixedTotalMass() [2/2]

serif::model::FixedTotalMass::FixedTotalMass ( Parameters parameters )

explicit

Construct from named physical parameters.

Delegate named mass parameters to the dimensional constructor.

Member Function Documentation

target()

TargetValue serif::model::FixedTotalMass::target ( ) const

inlinenodiscardnoexcept

Inspect the prescribed total mass.

Member Data Documentation

m_target

TargetValue serif::model::FixedTotalMass::m_target

private

---

The documentation for this class was generated from the following files:

• src/include/serif/model/specifications/fixed_total_mass.hpp
• src/lib/serif/model/specifications.cpp