SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
domain::creators::time_dependent_options::TranslationMapOptions< Dim > Struct Template Reference

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

#include <TranslationMap.hpp>

Classes

struct  InitialValues

Public Types

using type
using options = tmpl::list<InitialValues>

Public Member Functions

 TranslationMapOptions (const std::array< std::array< double, Dim >, 3 > &initial_values_in, const Options::Context &context={})

Static Public Member Functions

static std::string name ()

Public Attributes

std::array< DataVector, 3 > initial_values {}

Static Public Attributes

static constexpr Options::String help

Detailed Description

template<size_t Dim>
struct domain::creators::time_dependent_options::TranslationMapOptions< Dim >

Class that holds hard coded translation 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 Typedef Documentation

◆ type

template<size_t Dim>
using domain::creators::time_dependent_options::TranslationMapOptions< Dim >::type
Initial value:
A class indicating that a parsed value can be automatically computed instead of specified.
Definition Auto.hpp:44
'None' label
Definition Auto.hpp:26
Read in FunctionOfTime coefficients from an H5 file and volume subfile.
Definition FromVolumeFile.hpp:27

Member Data Documentation

◆ help

template<size_t Dim>
Options::String domain::creators::time_dependent_options::TranslationMapOptions< Dim >::help
staticconstexpr
Initial value:
= {
"Options for a time-dependent translation of the coordinates. Specify "
"'None' to not use this map."}

The documentation for this struct was generated from the following file:
  • src/Domain/Creators/TimeDependentOptions/TranslationMap.hpp