version 3.8
Parameters and runtime configuration

Description

Files

file  loggingparametertree.hh
 A parameter tree that logs which parameters have been used.
 
file  parameters.hh
 The infrastructure to retrieve run-time parameters from Dune::ParameterTrees.
 
file  parameterlist.txt
 List of currently usable run-time parameters.
 

Classes

class  Dumux::LoggingParameterTree
 A parameter tree that logs which parameters have been used. More...
 
class  Dumux::Parameters
 Parameter class managing runtime input parameters. More...
 

Functions

template<typename T = std::string, typename... Args>
Dumux::getParam (Args &&... args)
 A free function to get a parameter from the parameter tree singleton. More...
 
template<typename T = std::string, typename... Args>
Dumux::getParamFromGroup (Args &&... args)
 A free function to get a parameter from the parameter tree singleton with a model group. More...
 
bool Dumux::hasParam (const std::string &param)
 Check whether a key exists in the parameter tree. More...
 
bool Dumux::hasParamInGroup (const std::string &paramGroup, const std::string &param)
 Check whether a key exists in the parameter tree with a model group prefix. More...
 
std::vector< std::string > Dumux::getParamSubGroups (const std::string &subGroupName, const std::string &paramGroup)
 Get a list of sub groups from the parameter tree sorted by relevance. More...
 

Function Documentation

◆ getParam()

template<typename T = std::string, typename... Args>
T Dumux::getParam ( Args &&...  args)
Note
auto endTime = getParam<double>("TimeManager.TEnd");
Once this has been called the first time, you cannot modify the parameter tree anymore

◆ getParamFromGroup()

template<typename T = std::string, typename... Args>
T Dumux::getParamFromGroup ( Args &&...  args)
Note
auto endTime = getParamFromGroup<double>("FreeFlow", "TimeManager.TEnd");
Once this has been called the first time, you cannot modify the parameter tree anymore

◆ getParamSubGroups()

std::vector< std::string > Dumux::getParamSubGroups ( const std::string &  subGroupName,
const std::string &  paramGroup 
)
inline
Returns
A vector of fully qualified subGroup names sorted by descending relevance.

◆ hasParam()

bool Dumux::hasParam ( const std::string &  param)
inline
Note
Once this has been called the first time, you cannot modify the parameter tree anymore

◆ hasParamInGroup()

bool Dumux::hasParamInGroup ( const std::string &  paramGroup,
const std::string &  param 
)
inline
Note
Once this has been called the first time, you cannot modify the parameter tree anymore