The parameters system. More...
Collaboration diagram for Parameters:
Detailed DescriptionThe parameters system. Parameters allow to specify values at runtime (either via command line arguments or by means of a .INI file) and thus cannot be used to specify types as properties can. Also all parameters fall back to the value of the property of the same as the parameter, so this property must exist and be defined. Function Documentation◆ get()
template<class TypeTag , template< class, class > class Property>
Retrieve a runtime parameter. The default value is specified via the property system. Example: // Retrieves value UpwindWeight, default
// is taken from the property UpwindWeight
::Opm::Parameters::get<TypeTag, Properties::UpwindWeight>();
Referenced by Opm::VcfvStencil< Scalar, GridView >::updateScvGeometry(). ◆ parseCommandLineOptions()
template<class TypeTag , class PositionalArgumentCallback >
Parse the parameters provided on the command line. This function does some basic syntax checks.
References Opm::Parameters::parseKey_(), and Opm::Parameters::transformKey_(). ◆ parseParameterFile()
template<class TypeTag >
Read the parameters from an INI-style file. This function does some basic syntax checks. References Opm::Parameters::parseKey_(), Opm::Parameters::parseQuotedValue_(), Opm::Parameters::parseUnquotedValue_(), Opm::Parameters::removeLeadingSpace_(), and Opm::Parameters::transformKey_(). ◆ printUnused()
template<class TypeTag >
Print the list of unused run-time parameters.
References Opm::Parameters::getFlattenedKeyList_(). ◆ printUsage()
template<class TypeTag >
Print a usage message for all run-time parameters.
References Opm::Parameters::breakLines_(), Opm::Parameters::getTtyWidth_(), Opm::Parameters::ParamInfo::paramName, Opm::Parameters::printParamUsage_(), and Opm::Parameters::ParamInfo::usageString. ◆ printValues()
template<class TypeTag >
Print values of the run-time parameters.
References Opm::Parameters::getFlattenedKeyList_(). ◆ registerParam()
template<class TypeTag , template< class, class > class Param>
Register a run-time parameter. In OPM, parameters can only be used after they have been registered. Example: // Registers a run-time parameter "UpwindWeight"
and the description "Relative weight of the upwind node."
registerParam<TypeTag,UpwindWeight>("Relative weight of the upwind node.");
References Opm::Parameters::ParamInfo::compileTimeValue, Opm::Parameters::ParamInfo::isHidden, Opm::Parameters::ParamInfo::paramName, Opm::Parameters::ParamInfo::paramTypeName, and Opm::Parameters::ParamInfo::usageString. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||