Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
shammodels::basegodunov::EOSConfig< Tvec > Struct Template Reference

Equation of state of the gas, each alternative maps to a shammath FluidStateSpec. More...

#include <shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp>

Classes

struct  Adiabatic
 Ideal gas equation of state, see shammath::FluidStateAdiabatic. More...
struct  Barotropic
 Isothermal below rho_crit and adiabatic above, see shammath::FluidStateBarotropic. More...

Public Types

using Tscal = shambase::VecComponent<Tvec>
using Variant = std::variant<Adiabatic, Barotropic>

Public Member Functions

void set_adiabatic (Tscal gamma)
void set_barotropic (Tscal rho_crit, Tscal cs0, Tscal gamma)
bool is_hydro_adiabatic () const
 True if the hydro step is the adiabatic one.

Public Attributes

Variant config = Adiabatic{}

Detailed Description

template<class Tvec>
struct shammodels::basegodunov::EOSConfig< Tvec >

Equation of state of the gas, each alternative maps to a shammath FluidStateSpec.

The solver supports the Adiabatic alternative only for now. The RAMSES-like reset of the internal energy onto a barotrope is a cooling, see CoolingConfig::InstantBarotropic.

Definition at line 163 of file SolverConfig.hpp.

Member Typedef Documentation

◆ Tscal

template<class Tvec>
using shammodels::basegodunov::EOSConfig< Tvec >::Tscal = shambase::VecComponent<Tvec>

Definition at line 164 of file SolverConfig.hpp.

◆ Variant

template<class Tvec>
using shammodels::basegodunov::EOSConfig< Tvec >::Variant = std::variant<Adiabatic, Barotropic>

Definition at line 186 of file SolverConfig.hpp.

Member Function Documentation

◆ is_hydro_adiabatic()

template<class Tvec>
bool shammodels::basegodunov::EOSConfig< Tvec >::is_hydro_adiabatic ( ) const
inline

True if the hydro step is the adiabatic one.

Definition at line 196 of file SolverConfig.hpp.

◆ set_adiabatic()

template<class Tvec>
void shammodels::basegodunov::EOSConfig< Tvec >::set_adiabatic ( Tscal gamma)
inline

Definition at line 190 of file SolverConfig.hpp.

◆ set_barotropic()

template<class Tvec>
void shammodels::basegodunov::EOSConfig< Tvec >::set_barotropic ( Tscal rho_crit,
Tscal cs0,
Tscal gamma )
inline

Definition at line 191 of file SolverConfig.hpp.

Member Data Documentation

◆ config

template<class Tvec>
Variant shammodels::basegodunov::EOSConfig< Tvec >::config = Adiabatic{}

Definition at line 188 of file SolverConfig.hpp.


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