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

Classes

struct  None
struct  IdealMhdConstrainedHyperPara
struct  NonIdealMHD

Public Types

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

Public Member Functions

void set (Variant v)
bool do_nimhd ()
bool has_b_field ()
bool has_psi_field ()
bool has_div_b_field ()
bool has_curl_b_field ()
bool has_dtdiv_b_field ()
void print_status ()
void check_config ()

Public Attributes

Variant configMHD = None{}

Static Public Attributes

static constexpr u32 dim = shambase::VectorProperties<Tvec>::dimension

Detailed Description

template<class Tvec>
struct shammodels::sph::MHDConfig< Tvec >

Definition at line 33 of file MHDConfig.hpp.

Member Typedef Documentation

◆ Tscal

template<class Tvec>
using shammodels::sph::MHDConfig< Tvec >::Tscal = shambase::VecComponent<Tvec>

Definition at line 35 of file MHDConfig.hpp.

◆ Variant

template<class Tvec>
using shammodels::sph::MHDConfig< Tvec >::Variant = std::variant<None, IdealMhdConstrainedHyperPara, NonIdealMHD>

Definition at line 57 of file MHDConfig.hpp.

Member Function Documentation

◆ check_config()

template<class Tvec>
void shammodels::sph::MHDConfig< Tvec >::check_config ( )
inline

Definition at line 122 of file MHDConfig.hpp.

◆ do_nimhd()

template<class Tvec>
bool shammodels::sph::MHDConfig< Tvec >::do_nimhd ( )
inline

Definition at line 63 of file MHDConfig.hpp.

◆ has_b_field()

template<class Tvec>
bool shammodels::sph::MHDConfig< Tvec >::has_b_field ( )
inline

Definition at line 68 of file MHDConfig.hpp.

◆ has_curl_b_field()

template<class Tvec>
bool shammodels::sph::MHDConfig< Tvec >::has_curl_b_field ( )
inline

Definition at line 85 of file MHDConfig.hpp.

◆ has_div_b_field()

template<class Tvec>
bool shammodels::sph::MHDConfig< Tvec >::has_div_b_field ( )
inline

Definition at line 80 of file MHDConfig.hpp.

◆ has_dtdiv_b_field()

template<class Tvec>
bool shammodels::sph::MHDConfig< Tvec >::has_dtdiv_b_field ( )
inline

Definition at line 90 of file MHDConfig.hpp.

◆ has_psi_field()

template<class Tvec>
bool shammodels::sph::MHDConfig< Tvec >::has_psi_field ( )
inline

Definition at line 74 of file MHDConfig.hpp.

◆ print_status()

template<class Tvec>
void shammodels::sph::MHDConfig< Tvec >::print_status ( )
inline

Definition at line 95 of file MHDConfig.hpp.

◆ set()

template<class Tvec>
void shammodels::sph::MHDConfig< Tvec >::set ( Variant v)
inline

Definition at line 61 of file MHDConfig.hpp.

Member Data Documentation

◆ configMHD

template<class Tvec>
Variant shammodels::sph::MHDConfig< Tvec >::configMHD = None{}

Definition at line 59 of file MHDConfig.hpp.

◆ dim

template<class Tvec>
u32 shammodels::sph::MHDConfig< Tvec >::dim = shambase::VectorProperties<Tvec>::dimension
staticconstexpr

Definition at line 36 of file MHDConfig.hpp.


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