SpECTRE  v2024.12.16
domain::creators::time_dependent_options::ExpansionMapOptions< AllowSettleFoTs > Struct Template Reference

Class that holds hard coded expansion map options from the input file. More...

#include <ExpansionMap.hpp>

Classes

struct  AsymptoticVelocityOuterBoundary
 
struct  DecayTimescale
 
struct  DecayTimescaleOuterBoundary
 
struct  InitialValues
 
struct  InitialValuesOuterBoundary
 

Public Types

using type = Options::Auto< std::variant< ExpansionMapOptions< AllowSettleFoTs >, FromVolumeFile >, Options::AutoLabel::None >
 
using common_options = tmpl::list< InitialValues, DecayTimescaleOuterBoundary >
 
using settle_options = tmpl::push_back< common_options, InitialValuesOuterBoundary, DecayTimescale >
 
using non_settle_options = tmpl::push_back< common_options, AsymptoticVelocityOuterBoundary >
 
using options = tmpl::conditional_t< AllowSettleFoTs, tmpl::list< Options::Alternatives< settle_options, non_settle_options > >, non_settle_options >
 

Public Member Functions

 ExpansionMapOptions (const std::array< double, 3 > &initial_values_in, double decay_timescale_outer_boundary_in, const std::array< double, 3 > &initial_values_outer_boundary_in, double decay_timescale_in, const Options::Context &context={})
 
 ExpansionMapOptions (const std::array< double, 3 > &initial_values_in, double decay_timescale_outer_boundary_in, double asymptotic_velocity_outer_boundary_in, const Options::Context &context={})
 

Static Public Member Functions

static std::string name ()
 

Public Attributes

std::array< DataVector, 3 > initial_values {}
 
std::array< DataVector, 3 > initial_values_outer_boundary {}
 
double decay_timescale_outer_boundary {}
 
std::optional< double > decay_timescale
 
std::optional< double > asymptotic_velocity_outer_boundary
 

Static Public Attributes

static constexpr Options::String help
 

Detailed Description

template<bool AllowSettleFoTs>
struct domain::creators::time_dependent_options::ExpansionMapOptions< AllowSettleFoTs >

Class that holds hard coded expansion map options from the input file.

Details

This class can also be used as an option tag with the type type alias, name() function, and help string.

Member Data Documentation

◆ help

template<bool AllowSettleFoTs>
constexpr Options::String domain::creators::time_dependent_options::ExpansionMapOptions< AllowSettleFoTs >::help
staticconstexpr
Initial value:
= {
"Options for a time-dependent expansion of the coordinates. Specify "
"'None' to not use this map."}

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