parametersystem.hh File Reference

This file provides the infrastructure to retrieve run-time parameters. More...

#include <ewoms/common/propertysystem.hh>
#include <opm/common/ErrorMacros.hpp>
#include <opm/common/Exceptions.hpp>
#include <opm/material/common/ClassName.hpp>
#include <dune/common/parametertree.hh>
#include <map>
#include <list>
#include <sstream>
#include <string>
#include <iostream>
#include <unordered_map>
Include dependency graph for parametersystem.hh:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define EWOMS_REGISTER_PARAM(TypeTag, ParamType, ParamName, Description)
 Register a run-time parameter. More...
 
#define EWOMS_END_PARAM_REGISTRATION(TypeTag)   ::Ewoms::Parameters::endParamRegistration<TypeTag>()
 Indicate that all parameters are registered for a given type tag. More...
 
#define EWOMS_GET_PARAM(TypeTag, ParamType, ParamName)
 Retrieve a runtime parameter. More...
 

Functions

template<class TypeTag >
void printUsage (const std::string &progName, const std::string &errorMsg="", bool handleHelp=true, std::ostream &os=std::cerr)
 Print a usage message for all run-time parameters. More...
 
template<class TypeTag >
std::string parseCommandLineOptions (int argc, char **argv, bool handleHelp=true)
 Parse the parameters provided on the command line. More...
 
template<class TypeTag >
void printValues (std::ostream &os=std::cout)
 Print values of the run-time parameters. More...
 
template<class TypeTag >
bool printUnused (std::ostream &os=std::cout)
 Print the list of unused run-time parameters. More...
 

Detailed Description

This file provides the infrastructure to retrieve run-time parameters.

Internally, runtime parameters are implemented using Dune::ParameterTree with the default value taken from the property system.