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 <ShapeMap.hpp>

Classes
struct	CoefficientTruncationLimit
struct	InitialValues
struct	LMax
struct	SizeInitialValues

Public Types
using	type
using	common_options
using	options

Public Member Functions
	ShapeMapOptions (size_t l_max_in, std::optional< std::variant< KerrSchildFromBoyerLindquist, YlmsFromFile, YlmsFromSpEC > > initial_values_in, std::optional< std::array< double, 3 > > initial_size_values_in=std::nullopt, double coefficient_truncation_limit_in=0.0, const Options::Context &context={})
	ShapeMapOptions (size_t l_max_in, std::optional< std::variant< KerrSchildFromBoyerLindquist, YlmsFromFile, YlmsFromSpEC > > initial_values_in, std::optional< std::array< double, 3 > > initial_size_values_in, double coefficient_truncation_limit_in, bool transition_ends_at_cube_in, const Options::Context &context={})

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

Public Attributes
size_t	l_max {}
std::optional< std::variant< KerrSchildFromBoyerLindquist, YlmsFromFile, YlmsFromSpEC > >	initial_values
std::optional< std::array< double, 3 > >	initial_size_values
double	coefficient_truncation_limit {0.0}
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.

Details

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

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 Typedef Documentation

common_options

template<bool IncludeTransitionEndsAtCube, domain::ObjectLabel Object>

using domain::creators::time_dependent_options::ShapeMapOptions< IncludeTransitionEndsAtCube, Object >::common_options

Initial value:

 tmpl::list<LMax, InitialValues, SizeInitialValues,
                                    CoefficientTruncationLimit>

options

template<bool IncludeTransitionEndsAtCube, domain::ObjectLabel Object>

using domain::creators::time_dependent_options::ShapeMapOptions< IncludeTransitionEndsAtCube, Object >::options

Initial value:

 tmpl::conditional_t<
      IncludeTransitionEndsAtCube,
      tmpl::push_back<common_options, detail::TransitionEndsAtCube>,
      common_options>

type

template<bool IncludeTransitionEndsAtCube, domain::ObjectLabel Object>

using domain::creators::time_dependent_options::ShapeMapOptions< IncludeTransitionEndsAtCube, Object >::type

Initial value:

 Options::Auto<
      std::variant<ShapeMapOptions<IncludeTransitionEndsAtCube, Object>,
                   FromVolumeFileShapeSize<Object>>,
      Options::AutoLabel::None>

Member Data Documentation

help

template<bool IncludeTransitionEndsAtCube, domain::ObjectLabel Object>

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/TimeDependentOptions/ShapeMap.hpp