Inheritance diagram for ablate::environment::RunEnvironment::Parameters:

Public Member Functions
Parameters &	OutputDirectory (const std::filesystem::path &path)

Parameters &	TagDirectory (bool tag)

Parameters &	Title (std::string simulationTitle)

Public Member Functions inherited from ablate::parameters::MapParameters
	MapParameters (std::initializer_list< Parameter >)

	MapParameters (std::map< std::string, std::string > values={})

std::optional< std::string >	GetString (std::string paramName) const override

std::unordered_set< std::string >	GetKeys () const override

const std::map< std::string, std::string > &	GetMap () const

template<class T >
void	Insert (std::string key, T value)

Public Member Functions inherited from ablate::parameters::Parameters
template<typename T >
std::optional< T >	Get (std::string paramName) const

template<typename T >
T	Get (std::string paramName, T defaultValue) const

template<typename T >
T	GetExpect (std::string paramName) const

template<typename T >
std::map< std::string, T >	ToMap () const

void	Fill (PetscOptions options) const

template<typename T >
void	Fill (int numberValues, const char const valueNames, T *constantArray) const

template<typename T >
void	Fill (int numberValues, const char const valueNames, T *constantArray, std::map< std::string, T > defaultValues) const

Additional Inherited Members
Static Public Member Functions inherited from ablate::parameters::MapParameters
static std::shared_ptr< MapParameters >	Create (std::initializer_list< Parameter >)

static std::shared_ptr< MapParameters >	Create (const std::map< std::string, std::string > &values)

Protected Attributes inherited from ablate::parameters::MapParameters
std::map< std::string, std::string >	values

Detailed Description

Run time parameters is a simple class that helps set RunEnvironmentParameters when not using an input file

Member Function Documentation

Parameters& ablate::environment::RunEnvironment::Parameters::OutputDirectory ( const std::filesystem::path & path )

inline

directly set the output directory for the parameters

Parameters& ablate::environment::RunEnvironment::Parameters::TagDirectory ( bool tag )

inline

turn on directory tagging

Parameters& ablate::environment::RunEnvironment::Parameters::Title ( std::string simulationTitle )

inline

set the name for the simulation

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