Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
shammodels::sph::MHDConfig< Tvec > Struct Template Reference

Classes

struct  IdealMHD_constrained_hyper_para
 
struct  None
 
struct  NonIdealMHD
 

Public Types

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

Public Member Functions

void set (Variant v)
 
bool has_B_field ()
 
bool has_psi_field ()
 
bool has_divB_field ()
 
bool has_curlB_field ()
 
bool has_dtdivB_field ()
 
void print_status ()
 

Public Attributes

Variant config = 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 32 of file MHDConfig.hpp.

Member Typedef Documentation

◆ Tscal

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

Definition at line 34 of file MHDConfig.hpp.

◆ Variant

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

Definition at line 53 of file MHDConfig.hpp.

Member Function Documentation

◆ has_B_field()

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

Definition at line 59 of file MHDConfig.hpp.

◆ has_curlB_field()

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

Definition at line 76 of file MHDConfig.hpp.

◆ has_divB_field()

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

Definition at line 71 of file MHDConfig.hpp.

◆ has_dtdivB_field()

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

Definition at line 81 of file MHDConfig.hpp.

◆ has_psi_field()

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

Definition at line 65 of file MHDConfig.hpp.

◆ print_status()

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

Definition at line 86 of file MHDConfig.hpp.

◆ set()

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

Definition at line 57 of file MHDConfig.hpp.

Member Data Documentation

◆ config

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

Definition at line 55 of file MHDConfig.hpp.

◆ dim

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

Definition at line 35 of file MHDConfig.hpp.


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