SpECTRE  v2024.09.29
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< NumDerivs > Struct Template Reference

Class to be used as an option for initializing rotation map coefficients. More...

#include <RotationMap.hpp>

Classes

struct  DecayTimescale
 
struct  InitialAngles
 
struct  InitialQuaternions
 

Public Types

using type = Options::Auto< RotationMapOptions, Options::AutoLabel::None >
 
using options = tmpl::list< InitialQuaternions, InitialAngles, DecayTimescale >
 

Public Member Functions

 RotationMapOptions (std::variant< std::vector< std::array< double, 4 > >, FromVolumeFile< names::Rotation > > initial_quaternions, std::optional< std::vector< std::array< double, 3 > > > initial_angles, std::optional< double > decay_timescale_in, const Options::Context &context={})
 

Static Public Member Functions

static std::string name ()
 

Public Attributes

std::array< DataVector, NumDerivs+1 > quaternions {}
 
std::array< DataVector, NumDerivs+1 > angles {}
 
std::optional< double > decay_timescale {}
 

Static Public Attributes

static constexpr Options::String help
 

Detailed Description

template<size_t NumDerivs>
struct domain::creators::time_dependent_options::RotationMapOptions< NumDerivs >

Class to be used as an option for initializing rotation map coefficients.

Member Data Documentation

◆ help

template<size_t NumDerivs>
constexpr Options::String domain::creators::time_dependent_options::RotationMapOptions< NumDerivs >::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: