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

Cooling of the gas, applied on top of the (adiabatic) equation of state. More...

#include <shammodels/ramses/include/shammodels/ramses/config/CoolingConfig.hpp>

Classes

struct  None
 No cooling. More...
struct  InstantBarotropic
 Instantaneous cooling onto a barotrope (RAMSES-like). More...

Public Types

using Tscal = shambase::VecComponent<Tvec>
using Variant = std::variant<None, InstantBarotropic>

Public Member Functions

void set_none ()
void set_instant_barotropic (Tscal rho0, Tscal cs0, Tscal gamma0)
bool is_cooling_on () const
void check_config () const
 Throws std::invalid_argument if the parameters of the cooling are invalid.

Public Attributes

Variant config = None{}

Detailed Description

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

Cooling of the gas, applied on top of the (adiabatic) equation of state.

Definition at line 34 of file CoolingConfig.hpp.

Member Typedef Documentation

◆ Tscal

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

Definition at line 35 of file CoolingConfig.hpp.

◆ Variant

template<class Tvec>
using shammodels::basegodunov::CoolingConfig< Tvec >::Variant = std::variant<None, InstantBarotropic>

Definition at line 59 of file CoolingConfig.hpp.

Member Function Documentation

◆ check_config()

template<class Tvec>
void shammodels::basegodunov::CoolingConfig< Tvec >::check_config ( ) const
inline

Throws std::invalid_argument if the parameters of the cooling are invalid.

Definition at line 71 of file CoolingConfig.hpp.

Here is the call graph for this function:

◆ is_cooling_on()

template<class Tvec>
bool shammodels::basegodunov::CoolingConfig< Tvec >::is_cooling_on ( ) const
inline

Definition at line 68 of file CoolingConfig.hpp.

◆ set_instant_barotropic()

template<class Tvec>
void shammodels::basegodunov::CoolingConfig< Tvec >::set_instant_barotropic ( Tscal rho0,
Tscal cs0,
Tscal gamma0 )
inline

Definition at line 64 of file CoolingConfig.hpp.

◆ set_none()

template<class Tvec>
void shammodels::basegodunov::CoolingConfig< Tvec >::set_none ( )
inline

Definition at line 63 of file CoolingConfig.hpp.

Member Data Documentation

◆ config

template<class Tvec>
Variant shammodels::basegodunov::CoolingConfig< Tvec >::config = None{}

Definition at line 61 of file CoolingConfig.hpp.


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