serif::model::FixedCentralDensity Class Reference

Prescribe central density with an independently dimensioned enthalpy phase equation. More...

#include <fixed_central_density.hpp>

Classes
struct	Parameters

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

Public Member Functions
	FixedCentralDensity (TargetValue density)
	Require a positive finite central density.
	FixedCentralDensity (Parameters parameters)
	Construct from named physical parameters.
TargetValue	target () const noexcept
	Inspect the prescribed central density rather than the residual's enthalpy units.

Private Attributes
TargetValue	m_target

Detailed Description

Prescribe central density with an independently dimensioned enthalpy phase equation.

Member Typedef Documentation

ModelDefinition

using serif::model::FixedCentralDensity::ModelDefinition

Initial value:

 SpecificationDefinition<FixedCentralDensity, "FixedCentralDensity", SpecificationRole::phase_condition, GeneratedStateKind::solver_border,
                                                        ScalarDescription, Reads<state::SpecificEnthalpy>, Changes<equation::HydrostaticBalance>>

ScalarDescription

using serif::model::FixedCentralDensity::ScalarDescription

Initial value:

 ScalarConstraint<dimensions::MassDensity, dimensions::SpecificEnthalpy, dimensions::SpecificEnthalpy,
                                                   "fixed_central_density.border", "lambda_rho_c", "fixed_central_density.residual", "R_rho_c">

TargetValue

using serif::model::FixedCentralDensity::TargetValue = ScalarDescription::TargetValue

Constructor & Destructor Documentation

FixedCentralDensity() [1/2]

serif::model::FixedCentralDensity::FixedCentralDensity ( TargetValue density )

explicit

Require a positive finite central density.

Store a physically admissible central density.

FixedCentralDensity() [2/2]

serif::model::FixedCentralDensity::FixedCentralDensity ( Parameters parameters )

explicit

Construct from named physical parameters.

Delegate named central-density parameters to the dimensional constructor.

Member Function Documentation

target()

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

inlinenodiscardnoexcept

Inspect the prescribed central density rather than the residual's enthalpy units.

Member Data Documentation

m_target

TargetValue serif::model::FixedCentralDensity::m_target

private

---

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

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