SpECTRE  v2024.04.12
grmhd::ValenciaDivClean::NumericInitialData::VarName< Tag, IsRequired > Struct Template Reference

Name of a variable in the volume data file. Can be optional, in which case a constant value can be supplied instead of a dataset name. More...

#include <NumericInitialData.hpp>

Public Types

using tag = Tag
 
using type = std::conditional_t< is_required, std::string, std::variant< double, std::string > >
 

Static Public Member Functions

static std::string name ()
 

Static Public Attributes

static constexpr bool is_required = IsRequired::value
 
static constexpr Options::String help
 

Detailed Description

template<typename Tag, typename IsRequired>
struct grmhd::ValenciaDivClean::NumericInitialData::VarName< Tag, IsRequired >

Name of a variable in the volume data file. Can be optional, in which case a constant value can be supplied instead of a dataset name.

Member Data Documentation

◆ help

template<typename Tag , typename IsRequired >
constexpr Options::String grmhd::ValenciaDivClean::NumericInitialData::VarName< Tag, IsRequired >::help
staticconstexpr
Initial value:
=
"Name of the variable in the volume data file. For optional variables "
"you may instead specify a double that is used as a constant value "
"on the entire grid."

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