Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
shammodels::basegodunov::SolverConfig< Tvec, TgridVec > Struct Template Reference
Collaboration diagram for shammodels::basegodunov::SolverConfig< Tvec, TgridVec >:

Public Types

using Tscal = shambase::VecComponent<Tvec>
using AMRBlock = amr::AMRBlock<Tvec, TgridVec, NsideBlockPow>
using ExtForceConfig = shammodels::basegodunov::ExtForceConfig<Tvec>

Public Member Functions

void set_eos_gamma (Tscal gamma)
 Set an adiabatic equation of state (kept for backward compatibility).
Tscal get_eos_gamma () const
 Adiabatic index of the hydro step, throws if the hydro step is not adiabatic.
bool is_cooling_on () const
void set_riemann_solver (RiemannSolverMode mode)
 Set the gas Riemann solver.
bool should_compute_rho_mean ()
bool is_dust_on ()
void set_alphas_static (f32 alpha_values)
bool is_gas_passive_scalar_on ()
shamunits::UnitSystem< Tscal > get_unit_sys ()
 The unit system of the config, or the default one (SI) if it is not set.
Tscal get_constant_G ()
Tscal get_constant_4piG ()
bool is_boundary_periodic ()
Tscal get_grav_tol ()
Tscal get_happy_bk_grav_tol ()
bool is_gravity_on ()
bool is_coordinate_field_required ()
bool has_ext_forces ()
void set_units (shamunits::UnitSystem< Tscal > new_sys)
 Set the unit system of the simulation.
void check_config ()
void set_layout (shamrock::patch::PatchDataLayerLayout &pdl)

Public Attributes

Tscal grid_coord_to_pos_fact = 1
EOSConfig< Tvec > eos_config {}
 Equation of state of the gas.
CoolingConfig< Tvec > cooling_config {}
 Cooling of the gas.
RiemannSolverMode riemann_config = HLL
SlopeMode slope_config = VanLeer_sym
bool face_half_time_interpolation = true
AMRInterpMode amr_interp_mode = FIRST_ORDER
DustConfig dust_config {}
DragConfig drag_config {}
BCConfig bc_config {}
PassiveScalarGasConfig npscal_gas_config {}
GravityConfig< Tvec > gravity_config {}
ExtForceConfig ext_force_config {}
 External forces applied to the gas.
AMRMode< Tvec, TgridVec > amr_mode = {}
 AMR refinement mode.
std::optional< shamunits::UnitSystem< Tscal > > unit_sys = {}
 The unit system of the simulation.
PatchSchedulerConfig scheduler_conf = {}
Tscal Csafe = 0.9

Static Public Attributes

static constexpr u32 NsideBlockPow = 1

Detailed Description

template<class Tvec, class TgridVec>
struct shammodels::basegodunov::SolverConfig< Tvec, TgridVec >

Definition at line 221 of file SolverConfig.hpp.

Member Typedef Documentation

◆ AMRBlock

template<class Tvec, class TgridVec>
using shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::AMRBlock = amr::AMRBlock<Tvec, TgridVec, NsideBlockPow>

Definition at line 228 of file SolverConfig.hpp.

◆ ExtForceConfig

template<class Tvec, class TgridVec>
using shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::ExtForceConfig = shammodels::basegodunov::ExtForceConfig<Tvec>

Definition at line 326 of file SolverConfig.hpp.

◆ Tscal

template<class Tvec, class TgridVec>
using shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::Tscal = shambase::VecComponent<Tvec>

Definition at line 223 of file SolverConfig.hpp.

Member Function Documentation

◆ check_config()

template<class Tvec, class TgridVec>
void shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::check_config ( )
inline

Definition at line 365 of file SolverConfig.hpp.

◆ get_constant_4piG()

template<class Tvec, class TgridVec>
Tscal shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::get_constant_4piG ( )
inline

Definition at line 308 of file SolverConfig.hpp.

◆ get_constant_G()

template<class Tvec, class TgridVec>
Tscal shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::get_constant_G ( )
inline

Definition at line 307 of file SolverConfig.hpp.

◆ get_eos_gamma()

template<class Tvec, class TgridVec>
Tscal shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::get_eos_gamma ( ) const
inline

Adiabatic index of the hydro step, throws if the hydro step is not adiabatic.

Definition at line 237 of file SolverConfig.hpp.

Here is the call graph for this function:

◆ get_grav_tol()

template<class Tvec, class TgridVec>
Tscal shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::get_grav_tol ( )
inline

Definition at line 313 of file SolverConfig.hpp.

◆ get_happy_bk_grav_tol()

template<class Tvec, class TgridVec>
Tscal shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::get_happy_bk_grav_tol ( )
inline

Definition at line 314 of file SolverConfig.hpp.

◆ get_unit_sys()

template<class Tvec, class TgridVec>
shamunits::UnitSystem< Tscal > shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::get_unit_sys ( )
inline

The unit system of the config, or the default one (SI) if it is not set.

Definition at line 299 of file SolverConfig.hpp.

◆ has_ext_forces()

template<class Tvec, class TgridVec>
bool shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::has_ext_forces ( )
inline

Definition at line 331 of file SolverConfig.hpp.

◆ is_boundary_periodic()

template<class Tvec, class TgridVec>
bool shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::is_boundary_periodic ( )
inline

Definition at line 311 of file SolverConfig.hpp.

◆ is_cooling_on()

template<class Tvec, class TgridVec>
bool shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::is_cooling_on ( ) const
inline

Definition at line 251 of file SolverConfig.hpp.

◆ is_coordinate_field_required()

template<class Tvec, class TgridVec>
bool shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::is_coordinate_field_required ( )
inline

Definition at line 316 of file SolverConfig.hpp.

◆ is_dust_on()

template<class Tvec, class TgridVec>
bool shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::is_dust_on ( )
inline

Definition at line 270 of file SolverConfig.hpp.

◆ is_gas_passive_scalar_on()

template<class Tvec, class TgridVec>
bool shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::is_gas_passive_scalar_on ( )
inline

Definition at line 290 of file SolverConfig.hpp.

◆ is_gravity_on()

template<class Tvec, class TgridVec>
bool shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::is_gravity_on ( )
inline

Definition at line 315 of file SolverConfig.hpp.

◆ set_alphas_static()

template<class Tvec, class TgridVec>
void shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::set_alphas_static ( f32 alpha_values)
inline

Definition at line 273 of file SolverConfig.hpp.

◆ set_eos_gamma()

template<class Tvec, class TgridVec>
void shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::set_eos_gamma ( Tscal gamma)
inline

Set an adiabatic equation of state (kept for backward compatibility).

Definition at line 234 of file SolverConfig.hpp.

◆ set_layout()

template<class Tvec, class TgridVec>
void shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::set_layout ( shamrock::patch::PatchDataLayerLayout & pdl)
inline

Definition at line 31 of file SolverConfig.cpp.

◆ set_riemann_solver()

template<class Tvec, class TgridVec>
void shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::set_riemann_solver ( RiemannSolverMode mode)
inline

Set the gas Riemann solver.

Definition at line 259 of file SolverConfig.hpp.

◆ set_units()

template<class Tvec, class TgridVec>
void shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::set_units ( shamunits::UnitSystem< Tscal > new_sys)
inline

Set the unit system of the simulation.

Definition at line 348 of file SolverConfig.hpp.

◆ should_compute_rho_mean()

template<class Tvec, class TgridVec>
bool shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::should_compute_rho_mean ( )
inline

Definition at line 261 of file SolverConfig.hpp.

Member Data Documentation

◆ amr_interp_mode

template<class Tvec, class TgridVec>
AMRInterpMode shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::amr_interp_mode = FIRST_ORDER

Definition at line 256 of file SolverConfig.hpp.

◆ amr_mode

template<class Tvec, class TgridVec>
AMRMode<Tvec, TgridVec> shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::amr_mode = {}

AMR refinement mode.

Definition at line 338 of file SolverConfig.hpp.

◆ bc_config

template<class Tvec, class TgridVec>
BCConfig shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::bc_config {}

Definition at line 282 of file SolverConfig.hpp.

◆ cooling_config

template<class Tvec, class TgridVec>
CoolingConfig<Tvec> shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::cooling_config {}

Cooling of the gas.

Definition at line 249 of file SolverConfig.hpp.

◆ Csafe

template<class Tvec, class TgridVec>
Tscal shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::Csafe = 0.9

Definition at line 359 of file SolverConfig.hpp.

◆ drag_config

template<class Tvec, class TgridVec>
DragConfig shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::drag_config {}

Definition at line 268 of file SolverConfig.hpp.

◆ dust_config

template<class Tvec, class TgridVec>
DustConfig shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::dust_config {}

Definition at line 267 of file SolverConfig.hpp.

◆ eos_config

template<class Tvec, class TgridVec>
EOSConfig<Tvec> shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::eos_config {}

Equation of state of the gas.

Definition at line 231 of file SolverConfig.hpp.

◆ ext_force_config

template<class Tvec, class TgridVec>
ExtForceConfig shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::ext_force_config {}

External forces applied to the gas.

Definition at line 329 of file SolverConfig.hpp.

◆ face_half_time_interpolation

template<class Tvec, class TgridVec>
bool shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::face_half_time_interpolation = true

Definition at line 255 of file SolverConfig.hpp.

◆ gravity_config

template<class Tvec, class TgridVec>
GravityConfig<Tvec> shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::gravity_config {}

Definition at line 312 of file SolverConfig.hpp.

◆ grid_coord_to_pos_fact

template<class Tvec, class TgridVec>
Tscal shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::grid_coord_to_pos_fact = 1

Definition at line 225 of file SolverConfig.hpp.

◆ npscal_gas_config

template<class Tvec, class TgridVec>
PassiveScalarGasConfig shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::npscal_gas_config {}

Definition at line 288 of file SolverConfig.hpp.

◆ NsideBlockPow

template<class Tvec, class TgridVec>
u32 shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::NsideBlockPow = 1
staticconstexpr

Definition at line 227 of file SolverConfig.hpp.

◆ riemann_config

template<class Tvec, class TgridVec>
RiemannSolverMode shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::riemann_config = HLL

Definition at line 253 of file SolverConfig.hpp.

◆ scheduler_conf

template<class Tvec, class TgridVec>
PatchSchedulerConfig shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::scheduler_conf = {}

Definition at line 353 of file SolverConfig.hpp.

◆ slope_config

template<class Tvec, class TgridVec>
SlopeMode shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::slope_config = VanLeer_sym

Definition at line 254 of file SolverConfig.hpp.

◆ unit_sys

template<class Tvec, class TgridVec>
std::optional<shamunits::UnitSystem<Tscal> > shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::unit_sys = {}

The unit system of the simulation.

Definition at line 345 of file SolverConfig.hpp.


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