SpECTRE  v2025.08.19
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
domain::creators::time_dependent_options::RotationMapOptions< AllowSettleFoTs > Struct Template Reference

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

#include <RotationMap.hpp>

Classes

struct  DecayTimescale
 
struct  InitialAngularVelocity
 
struct  InitialQuaternions
 

Public Types

using type = Options::Auto< std::variant< RotationMapOptions< AllowSettleFoTs >, FromVolumeFile >, Options::AutoLabel::None >
 
using non_settle_options = tmpl::list< InitialAngularVelocity >
 
using settle_options = tmpl::list< InitialQuaternions, DecayTimescale >
 
using options = tmpl::conditional_t< AllowSettleFoTs, tmpl::list< Options::Alternatives< non_settle_options, settle_options > >, non_settle_options >
 

Public Member Functions

 RotationMapOptions (const std::array< double, 3 > &initial_angular_velocity, const Options::Context &context={})
 
 RotationMapOptions (const std::vector< std::array< double, 4 > > &initial_quaternions, double decay_timescale_in, const Options::Context &context={})
 

Static Public Member Functions

static std::string name ()
 

Public Attributes

std::array< DataVector, 3 > quaternions {}
 
std::array< DataVector, 4 > angles {}
 
std::optional< double > decay_timescale
 

Static Public Attributes

static constexpr Options::String help
 

Detailed Description

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

Class that holds hard coded rotation 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::RotationMapOptions< AllowSettleFoTs >::help
staticconstexpr
Initial value:
= {
"Options for a time-dependent rotation of the coordinates. Specify "
"'None' to not use this map."}
The documentation for this struct was generated from the following file: