domain::creators::time_dependent_options::FromVolumeFile Struct Reference

Read in FunctionOfTime coefficients from an H5 file and volume subfile. More...

#include <FromVolumeFile.hpp>

Classes
struct	H5Filename
struct	SubfileName

Public Types
using	options = tmpl::list<H5Filename, SubfileName>

Public Member Functions
	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.

Static Public Attributes
static constexpr Options::String	help

Detailed Description

Read in FunctionOfTime coefficients from an H5 file and volume subfile.

Details

The H5 file will only be accessed in the retrieve_function_of_time function.

Member Function Documentation

retrieve_function_of_time()

FunctionsOfTimeMap domain::creators::time_dependent_options::FromVolumeFile::retrieve_function_of_time	(	const std::unordered_set< std::string > &	function_of_time_names,
		double	time ) const

Returns: clones of all global functions of time in function_of_time_names

Details

If a value for time is specified, will ensure that time is within the domain::FunctionsOfTime::FunctionOfTime::time_bounds() of each function of time.

Member Data Documentation

help

Options::String domain::creators::time_dependent_options::FromVolumeFile::help

staticconstexpr

Initial value:

                                  =
"Read function of time coefficients from a volume subfile of an H5 file."

---

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

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