grmhd::ValenciaDivClean::subcell::TciOptions Struct Reference

Class holding options using by the GRMHD-specific parts of the troubled-cell indicator. More...

#include <TciOptions.hpp>

Classes
struct	AtmosphereDensity
	The density cutoff where if the maximum value of the density in the DG element is below this value we skip primitive recovery and treat the cell as atmosphere. More...
struct	MagneticFieldCutoff
	The cutoff where if the maximum of the magnetic field in an element is below this value we do not apply the Persson TCI to the magnetic field. More...
struct	MinimumValueOfD
	Minimum value of rest-mass density times Lorentz factor before we switch to subcell. Used to identify places where the density has suddenly become negative. More...
struct	MinimumValueOfTildeTau
	Minimum value of \(\tilde{\tau}\) before we switch to subcell. Used to identify places where the energy has suddenly become negative. More...
struct	MinimumValueOfYe
	Minimum value of \(Y_e\) before we switch to subcell. Used to identify places where the electron fraction has suddenly become. More...
struct	SafetyFactorForB
	Safety factor \(\epsilon_B\). More...

Public Types
using	options

Public Member Functions
	TciOptions (double minimum_rest_mass_density_times_lorentz_factor_in, double minimum_ye_in, double minimum_tilde_tau_in, double atmosphere_density_in, double safety_factor_for_magnetic_field_in, std::optional< double > magnetic_field_cutoff_in)
void	pup (PUP::er &p)

Public Attributes
double	minimum_rest_mass_density_times_lorentz_factor
double	minimum_ye {std::numeric_limits<double>::signaling_NaN()}
double	minimum_tilde_tau {std::numeric_limits<double>::signaling_NaN()}
double	atmosphere_density {std::numeric_limits<double>::signaling_NaN()}
double	safety_factor_for_magnetic_field
std::optional< double >	magnetic_field_cutoff

Static Public Attributes
static constexpr Options::String	help

Detailed Description

Class holding options using by the GRMHD-specific parts of the troubled-cell indicator.

Member Typedef Documentation

options

using grmhd::ValenciaDivClean::subcell::TciOptions::options

Initial value:

 
      tmpl::list<MinimumValueOfD, MinimumValueOfYe, MinimumValueOfTildeTau,
                 AtmosphereDensity, SafetyFactorForB, MagneticFieldCutoff>

Member Data Documentation

help

Options::String grmhd::ValenciaDivClean::subcell::TciOptions::help

staticconstexpr

Initial value:

= {
      "Options for the troubled-cell indicator."}

magnetic_field_cutoff

std::optional<double> grmhd::ValenciaDivClean::subcell::TciOptions::magnetic_field_cutoff

Initial value:

{
      std::numeric_limits<double>::signaling_NaN()}

minimum_rest_mass_density_times_lorentz_factor

double grmhd::ValenciaDivClean::subcell::TciOptions::minimum_rest_mass_density_times_lorentz_factor

Initial value:

{
      std::numeric_limits<double>::signaling_NaN()}

safety_factor_for_magnetic_field

double grmhd::ValenciaDivClean::subcell::TciOptions::safety_factor_for_magnetic_field

Initial value:

{
      std::numeric_limits<double>::signaling_NaN()}

---

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

• src/Evolution/Systems/GrMhd/ValenciaDivClean/Subcell/TciOptions.hpp