serif::solver::continuation::AngularMomentum Struct Reference

#include <stellar_parameters.hpp>

Collaboration diagram for serif::solver::continuation::AngularMomentum:

Public Types
using	Specification = model::FixedAngularMomentum
using	Value = dimensions::AngularMomentumValue

Static Public Member Functions
static Value	read (const Specification &value) noexcept
	Read the prescribed angular momentum, independently of solved angular velocity.
static bool	valid (Value value) noexcept
	Match the nonnegative rotation prescription.
static Value	starting_value (Value) noexcept
	Start from the nonrotating family member.

Static Public Attributes
static constexpr std::string_view	name = "angular momentum"
static constexpr std::string_view	stable_id = "fixed_angular_momentum.target"

Member Typedef Documentation

Specification

using serif::solver::continuation::AngularMomentum::Specification = model::FixedAngularMomentum

Value

using serif::solver::continuation::AngularMomentum::Value = dimensions::AngularMomentumValue

Member Function Documentation

read()

static Value serif::solver::continuation::AngularMomentum::read ( const Specification & value )

inlinestaticnodiscardnoexcept

Read the prescribed angular momentum, independently of solved angular velocity.

starting_value()

static Value serif::solver::continuation::AngularMomentum::starting_value ( Value )

inlinestaticnodiscardnoexcept

Start from the nonrotating family member.

valid()

static bool serif::solver::continuation::AngularMomentum::valid ( Value value )

inlinestaticnodiscardnoexcept

Match the nonnegative rotation prescription.

Member Data Documentation

name

std::string_view serif::solver::continuation::AngularMomentum::name = "angular momentum"

staticconstexpr

stable_id

std::string_view serif::solver::continuation::AngularMomentum::stable_id = "fixed_angular_momentum.target"

staticconstexpr

---

The documentation for this struct was generated from the following file:

• src/include/serif/solver/continuation/stellar_parameters.hpp