serif::solver::continuation::PolytropicIndex Struct Reference

#include <stellar_parameters.hpp>

Collaboration diagram for serif::solver::continuation::PolytropicIndex:

Public Types
using	Specification = eos::models::Polytrope
using	Value = double
using	RequiredDependentParameters = ParameterList<PolytropicConstant>

Static Public Member Functions
static double	read (const Specification &value) noexcept
	Read the physical EOS index.
static bool	valid (double value) noexcept
	Match the domain supported by SERiF's barotropic EOS.
static double	starting_value (double) noexcept
	Start with the analytically simple n=1 family member.

Static Public Attributes
static constexpr std::string_view	name = "polytropic index"
static constexpr std::string_view	stable_id = "polytrope.index"

Member Typedef Documentation

RequiredDependentParameters

using serif::solver::continuation::PolytropicIndex::RequiredDependentParameters = ParameterList<PolytropicConstant>

Specification

using serif::solver::continuation::PolytropicIndex::Specification = eos::models::Polytrope

Value

using serif::solver::continuation::PolytropicIndex::Value = double

Member Function Documentation

read()

static double serif::solver::continuation::PolytropicIndex::read ( const Specification & value )

inlinestaticnodiscardnoexcept

Read the physical EOS index.

starting_value()

static double serif::solver::continuation::PolytropicIndex::starting_value ( double )

inlinestaticnodiscardnoexcept

Start with the analytically simple n=1 family member.

valid()

static bool serif::solver::continuation::PolytropicIndex::valid ( double value )

inlinestaticnodiscardnoexcept

Match the domain supported by SERiF's barotropic EOS.

Member Data Documentation

name

std::string_view serif::solver::continuation::PolytropicIndex::name = "polytropic index"

staticconstexpr

stable_id

std::string_view serif::solver::continuation::PolytropicIndex::stable_id = "polytrope.index"

staticconstexpr

---

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

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