SpECTRE  2021.08.02
Option Groups

Tags used for grouping input file options. More...

Classes

struct  domain::FunctionsOfTime::OptionTags::CubicFunctionOfTimeOverride
 Groups options for reading in FunctionOfTime data from SpEC. More...
 
struct  OptionTags::LimiterGroup
 Holds the OptionTags::Limiter option in the input file. More...
 
struct  GeneralizedHarmonic::OptionTags::Group
 
struct  grmhd::ValenciaDivClean::OptionTags::ValenciaDivCleanGroup
 Groups option tags related to the ValenciaDivClean evolution system. More...
 
struct  evolution::OptionTags::Group
 Groups option tags related to the time evolution, e.g. time step and time stepper. More...
 
struct  evolution::OptionTags::SystemGroup
 Groups option tags related to the evolution system. More...
 
struct  evolution::OptionTags::NumericInitialData
 Holds option tags for importing numeric initial data for an evolution. More...
 
struct  OptionTags::VariableFixingGroup
 Groups the variable fixer configurations in the input file. More...
 
struct  importers::OptionTags::Group
 Groups the data importer configurations in the input file. More...
 
struct  OptionTags::NumericalFluxGroup
 Holds the OptionTags::NumericalFlux option in the input file. More...
 
struct  intrp::OptionTags::InterpolationTargets
 Groups option tags for InterpolationTargets. More...
 
struct  OptionTags::FilteringGroup
 Groups the filtering configurations in the input file. More...
 
struct  OptionTags::AnalyticDataGroup
 Holds the OptionTags::AnalyticData option in the input file. More...
 
struct  OptionTags::AnalyticSolutionGroup
 Holds the OptionTags::AnalyticSolution option in the input file. More...
 

Detailed Description

Tags used for grouping input file options.

An option tag can be placed in a group with other option tags to give the input file more structure. To assign a group to an option tag, set its group type alias to a struct that provides a help string and may override a static name() function:

struct Group {
static constexpr Options::String help = {"Group halp"};
};
struct GroupedTag {
using type = int;
static constexpr Options::String help = {"Tag halp"};
using group = Group;
};
const char *const String
The string used in option structs.
Definition: Options.hpp:32

A number of commonly used groups are listed here.

See also the option parsing guide.