Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
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>

Public Member Functions

void set_eos_gamma (Tscal gamma)
bool should_compute_rho_mean ()
bool is_dust_on ()
void set_alphas_static (f32 alpha_values)
bool is_gas_passive_scalar_on ()
Tscal get_constant_G ()
bool is_boundary_periodic ()
Tscal get_constant_4piG ()
Tscal get_grav_tol ()
bool is_gravity_on ()
bool is_coordinate_field_required ()
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 eos_gamma = 5. / 3.
Tscal grid_coord_to_pos_fact = 1
RiemannSolverMode riemann_config = HLL
SlopeMode slope_config = VanLeer_sym
bool face_half_time_interpolation = true
DustConfig dust_config {}
DragConfig drag_config {}
BCConfig bc_config {}
PassiveScalarGasConfig npscal_gas_config {}
GravityConfig< Tvec > gravity_config {}
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 161 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 170 of file SolverConfig.hpp.

◆ Tscal

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

Definition at line 163 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 266 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 226 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 215 of file SolverConfig.hpp.

◆ get_grav_tol()

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

Definition at line 230 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 224 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 232 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 187 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 207 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 231 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 190 of file SolverConfig.hpp.

◆ set_eos_gamma()

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

Definition at line 172 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_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 249 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 178 of file SolverConfig.hpp.

Member Data Documentation

◆ amr_mode

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

AMR refinement mode.

Definition at line 239 of file SolverConfig.hpp.

◆ bc_config

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

Definition at line 199 of file SolverConfig.hpp.

◆ Csafe

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

Definition at line 260 of file SolverConfig.hpp.

◆ drag_config

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

Definition at line 185 of file SolverConfig.hpp.

◆ dust_config

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

Definition at line 184 of file SolverConfig.hpp.

◆ eos_gamma

template<class Tvec, class TgridVec>
Tscal shammodels::basegodunov::SolverConfig< Tvec, TgridVec >::eos_gamma = 5. / 3.

Definition at line 165 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 176 of file SolverConfig.hpp.

◆ gravity_config

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

Definition at line 225 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 167 of file SolverConfig.hpp.

◆ npscal_gas_config

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

Definition at line 205 of file SolverConfig.hpp.

◆ NsideBlockPow

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

Definition at line 169 of file SolverConfig.hpp.

◆ riemann_config

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

Definition at line 174 of file SolverConfig.hpp.

◆ scheduler_conf

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

Definition at line 254 of file SolverConfig.hpp.

◆ slope_config

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

Definition at line 175 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 246 of file SolverConfig.hpp.

The documentation for this struct was generated from the following files:
Generated on for Shamrock by doxygen 1.15.0