dune-fem
2.4.1-rc
|
#include </local/tomalk/somewhere/tmp/dune-fem/dune/fem/io/parameter/reader.hh>
Public Member Functions | |
BasicParameterReader (Parameter parameter=Parameter()) | |
bool | exists (const std::string &key) const |
check, whether a parameter is defined More... | |
template<class T > | |
void | get (const std::string &key, T &value) const |
get mandatory parameter More... | |
template<class T > | |
void | get (const std::string &key, const T &defaultValue, T &value) const |
get optional parameter More... | |
void | get (const std::string &key, const char *defaultValue, std::string &value) const |
get optional parameter (special case for string) More... | |
template<class T , class Validator > | |
void | getValid (const std::string &key, const Validator &validator, T &value) const |
get mandatory parameter More... | |
template<class T , class Validator > | |
void | getValid (const std::string &key, const T &defaultValue, const Validator &validator, T &value) const |
get optional parameter More... | |
template<class T > | |
T | getValue (const std::string &key) const |
get mandatory parameter More... | |
template<class T > | |
T | getValue (const std::string &key, const T &defaultValue) const |
get optional parameter More... | |
template<class T , class Validator > | |
T | getValidValue (const std::string &key, const Validator &validator) const |
get optional parameter More... | |
template<class T , class Validator > | |
T | getValidValue (const std::string &key, const T &defaultValue, const Validator &validator) const |
get optional parameter More... | |
template<int n> | |
int | getEnum (const std::string &key, const std::string(&values)[n]) const |
template<int n> | |
int | getEnum (const std::string &key, const std::string(&values)[n], int defaultValue) const |
Protected Attributes | |
Parameter | parameter_ |
|
inlineexplicit |
|
inline |
check, whether a parameter is defined
[in] | key | name of the parameter to check |
Referenced by Dune::Fem::IOInterface::defaultGridKey(), and Dune::Fem::Parameter::exists().
|
inline |
get mandatory parameter
[in] | key | name of the parameter to get |
[out] | value | value of the parameter |
Referenced by Dune::Fem::Parameter::get().
|
inline |
get optional parameter
[in] | key | name of the parameter to get |
[in] | defaultValue | default value for this parameter |
[out] | value | value of the parameter |
|
inline |
get optional parameter (special case for string)
[in] | key | name of the parameter to get |
[in] | defaultValue | default value for this parameter |
[out] | value | value of the parameter |
|
inline |
|
inline |
|
inline |
get mandatory parameter
[in] | key | name of the parameter to get |
[in] | validator | validator for the parameter value |
[out] | value | value of the parameter |
Referenced by Dune::Fem::Parameter::getValid(), and Dune::Fem::BasicParameterReader< std::function< const std::string *(const std::string &, const std::string *) > >::getValidValue().
|
inline |
get optional parameter
[in] | key | name of the parameter to get |
[in] | defaultValue | default value for this parameter |
[in] | validator | validator for the parameter value |
[out] | value | value of the parameter |
|
inline |
get optional parameter
[in] | key | name of the parameter to get |
[in] | validator | validator for the parameter value |
Referenced by Dune::Fem::TimeProvider< Grid::Traits::CollectiveCommunication >::getCflFactor(), Dune::Fem::TimeProvider< Grid::Traits::CollectiveCommunication >::getUpdateStep(), and Dune::Fem::Parameter::getValidValue().
|
inline |
get optional parameter
[in] | key | name of the parameter to get |
[in] | defaultValue | default value for this parameter |
[in] | validator | validator for the parameter value |
|
inline |
get mandatory parameter
[in] | key | name of the parameter to get |
Referenced by Dune::Fem::DataOutputParameters::absolutePath(), DuneODE::ImplicitRungeKuttaSolverParameters::cflMax(), DuneODE::ImplicitRungeKuttaSolverParameters::cflStart(), Dune::Fem::CheckPointerParameters::checkPointPrefix(), Dune::Fem::CheckPointerParameters::checkPointStep(), Dune::Fem::DataOutputParameters::conformingoutput(), Dune::Fem::Parameter::getValue(), DuneODE::ImplicitRungeKuttaSolverParameters::iterations(), Dune::Fem::NewtonParameter::linAbsTolParameter(), Dune::Fem::NewtonParameter::linearSolverVerbose(), Dune::Fem::NewtonParameter::linReductionParameter(), Dune::Fem::DataWriterParameters::macroGridName(), Dune::Fem::NewtonParameter::maxIterationsParameter(), Dune::Fem::NewtonParameter::maxLinearIterationsParameter(), Dune::Fem::CheckPointerParameters::maxNumberOfCheckPoints(), Dune::Fem::NewtonParameter::newtonVerbose(), Dune::Fem::DataOutputParameters::path(), DuneODE::PIDTimeStepControl::PIDTimeStepControl(), Dune::Fem::DataOutputParameters::prefix(), Dune::Fem::DataOutputParameters::savecount(), Dune::Fem::DataOutputParameters::savestep(), Dune::Fem::DataOutputParameters::subsamplingLevel(), DuneODE::ImplicitRungeKuttaSolverParameters::tolerance(), and Dune::Fem::NewtonParameter::toleranceParameter().
|
inline |
get optional parameter
[in] | key | name of the parameter to get |
[in] | defaultValue | default value for this parameter |
|
protected |
Referenced by Dune::Fem::BasicParameterReader< std::function< const std::string *(const std::string &, const std::string *) > >::exists(), Dune::Fem::BasicParameterReader< std::function< const std::string *(const std::string &, const std::string *) > >::get(), Dune::Fem::BasicParameterReader< std::function< const std::string *(const std::string &, const std::string *) > >::getEnum(), and Dune::Fem::BasicParameterReader< std::function< const std::string *(const std::string &, const std::string *) > >::getValid().