domain::creators::time_dependent_options::ShapeMapOptions< IncludeTransitionEndsAtCube, Object > Struct Template Reference

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

#include <ShapeMapOptions.hpp>

Classes
struct	InitialValues
struct	LMax
struct	SizeInitialValues
struct	TransitionEndsAtCube

Public Types
using	type = Options::Auto< ShapeMapOptions, Options::AutoLabel::None >
using	common_options = tmpl::list< LMax, InitialValues, SizeInitialValues >
using	options = tmpl::conditional_t< IncludeTransitionEndsAtCube, tmpl::push_back< common_options, TransitionEndsAtCube >, common_options >

Static Public Member Functions
static std::string	name ()

Public Attributes
size_t	l_max {}
std::optional< std::variant< KerrSchildFromBoyerLindquist, YlmsFromFile > >	initial_values {}
std::optional< std::array< double, 3 > >	initial_size_values {}
bool	transition_ends_at_cube {false}

Static Public Attributes
static constexpr Options::String	help

Detailed Description

template<bool IncludeTransitionEndsAtCube, domain::ObjectLabel Object>
struct domain::creators::time_dependent_options::ShapeMapOptions< IncludeTransitionEndsAtCube, Object >

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

Template Parameters

IncludeTransitionEndsAtCube	This is mainly added for the domain::creators::BinaryCompactObject domain.
Object	Which object that this shape map represents. Use domain::ObjectLabel::None if there is only a single object in your simulation.

Member Data Documentation

help

template<bool IncludeTransitionEndsAtCube, domain::ObjectLabel Object>

constexpr Options::String domain::creators::time_dependent_options::ShapeMapOptions< IncludeTransitionEndsAtCube, Object >::help

staticconstexpr

Initial value:

= {
      "Options for a time-dependent distortion (shape) map about the "
      "specified object. Specify 'None' to not use this map."}

---

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

• src/Domain/Creators/ShapeMapOptions.hpp