domain::creators::time_dependent_options::FromVolumeFileShapeSize< Object > Struct Template Reference

Specialized version of FromVolumeFile for the shape map. More...

#include <ShapeMap.hpp>

Classes
struct	CoefficientTruncationLimit
struct	LMax

Public Types
using	options
Public Types inherited from domain::creators::time_dependent_options::FromVolumeFile
using	options = tmpl::list<H5Filename, SubfileName>

Public Member Functions
	FromVolumeFileShapeSize (const std::optional< size_t > &l_max_in, double coefficient_truncation_limit_in, bool transition_ends_at_cube_in, std::string h5_filename, std::string subfile_name, const Options::Context &context={})
Public Member Functions inherited from domain::creators::time_dependent_options::FromVolumeFile
	FromVolumeFile (std::string h5_filename, std::string subfile_name, bool replay=false)
FunctionsOfTimeMap	retrieve_function_of_time (const std::unordered_set< std::string > &function_of_time_names, double time) const
bool	replay () const
	Whether the function of time from the volume file should just be replayed (read in and unmodified), or not.

Public Attributes
std::optional< size_t >	l_max {}
double	coefficient_truncation_limit {0.0}
bool	transition_ends_at_cube {}

Additional Inherited Members
Static Public Attributes inherited from domain::creators::time_dependent_options::FromVolumeFile
static constexpr Options::String	help

Detailed Description

template<ObjectLabel Object>
struct domain::creators::time_dependent_options::FromVolumeFileShapeSize< Object >

Specialized version of FromVolumeFile for the shape map.

Details

This is needed because the regular FromVolumeFile doesn't have options for domain settings like TransitionEndsAtCube or LMax.

Member Typedef Documentation

options

template<ObjectLabel Object>

using domain::creators::time_dependent_options::FromVolumeFileShapeSize< Object >::options

Initial value:

 tmpl::push_front<FromVolumeFile::options, LMax,
                                   CoefficientTruncationLimit,
                                   detail::TransitionEndsAtCube>

---

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

• src/Domain/Creators/TimeDependentOptions/ShapeMap.hpp