#include <aslParametersManager.h>
|
| ParametersManager () |
|
| ~ParametersManager () |
|
void | enable () |
| Enables parameter loader. More...
|
|
template<typename T > |
void | add (UValue< T > parameter, const char *key, const char *description, const char *units) |
| Adds a Parameter to ParametersManager. More...
|
|
template<typename T > |
void | add (UValue< std::map< std::string, T >> parameter, const char *key, const char *description, const char *units) |
| Adds a group of parameters with common prefix to ParametersManager. More...
|
|
template<typename T > |
void | add (UValue< T > parameter, T defaultValue, const char *key, const char *description, const char *units) |
| Adds a Parameter with a default value to ParametersManager. More...
|
|
template<typename T > |
void | addPrefix (const std::string prefix, std::shared_ptr< std::map< std::string, T >> destinationMap) |
|
void | load (std::string paramFile) |
|
std::string | getDir () |
|
This class automatically accomodates newly created Parameters and then can load them from a parameters file. It has to be declared before declaring all the parameters it will manage!
Definition at line 97 of file aslParametersManager.h.
◆ ParametersManager()
asl::ParametersManager::ParametersManager |
( |
| ) |
|
◆ ~ParametersManager()
asl::ParametersManager::~ParametersManager |
( |
| ) |
|
◆ add() [1/3]
template<typename T >
void asl::ParametersManager::add |
( |
UValue< std::map< std::string, T >> |
parameter, |
|
|
const char * |
key, |
|
|
const char * |
description, |
|
|
const char * |
units |
|
) |
| |
◆ add() [2/3]
template<typename T >
void asl::ParametersManager::add |
( |
UValue< T > |
parameter, |
|
|
const char * |
key, |
|
|
const char * |
description, |
|
|
const char * |
units |
|
) |
| |
◆ add() [3/3]
template<typename T >
void asl::ParametersManager::add |
( |
UValue< T > |
parameter, |
|
|
T |
defaultValue, |
|
|
const char * |
key, |
|
|
const char * |
description, |
|
|
const char * |
units |
|
) |
| |
◆ addPrefix()
template<typename T >
void asl::ParametersManager::addPrefix |
( |
const std::string |
prefix, |
|
|
std::shared_ptr< std::map< std::string, T >> |
destinationMap |
|
) |
| |
Adds prefix and the pointer on the respective Parameter's destinationMap
◆ enable()
void asl::ParametersManager::enable |
( |
| ) |
|
Enables parameter loader.
◆ getDir()
std::string asl::ParametersManager::getDir |
( |
| ) |
|
Get the parameters file directory (absolute, with ending slash). It is convenient to write simulation results output together with its respective parameters file into the same directory (whose name might reflect the specifics of the parameters used)
- Examples
- acousticWaves.cc, cubeGravity.cc, cubeIncompressibleGravity.cc, cubePoroelasticGravity.cc, jumpingBox.cc, multiphase_flow.cc, pitot_tube_ice.cc, poroelastic.cc, surfaceFlux.cc, testSMDiff.cc, testSMDiff3C.cc, testSMPhi.cc, and testSMPhiBV.cc.
◆ load()
void asl::ParametersManager::load |
( |
std::string |
paramFile | ) |
|
Loads all previously declared parameters from parameters file paramFile
◆ populateMaps()
void asl::ParametersManager::populateMaps |
( |
boost::program_options::variables_map & |
vm | ) |
|
|
protected |
◆ writeParametersFile()
void asl::ParametersManager::writeParametersFile |
( |
const std::string |
fileName | ) |
|
|
protected |
Wrties all parameters and their default values (if available) to the file fileName
◆ current
◆ parametersFileDirectory
std::string asl::ParametersManager::parametersFileDirectory |
|
protected |
◆ parametersFileStr
std::string asl::ParametersManager::parametersFileStr |
|
protected |
◆ parametersOptions
boost::program_options::options_description asl::ParametersManager::parametersOptions |
|
protected |
◆ prefixes
std::vector<std::shared_ptr<PrefixStore> > asl::ParametersManager::prefixes |
|
protected |
Accomodates prefixes (defined by attached "*" wildcard) using PrefixStore class
Definition at line 141 of file aslParametersManager.h.
The documentation for this class was generated from the following file: