Opm::Parameters Namespace Reference
Typedef Documentation◆ PositionalArgumentCallback
Callback function for command line parsing. Function Documentation◆ endRegistration()
Indicate that all parameters are registered for a given type tag. If registerParam is called after the invocation of ◆ Get()
template<class Param >
Retrieve a runtime parameter. The default value is specified in the parameter struct. Example: // Retrieves value UpwindWeight, default
// is taken from the property UpwindWeight
::Opm::Parameters::get<::Opm::Parameters::UpwindWeight>();
References Opm::Parameters::detail::Get_(). Referenced by Opm::GroundWaterProblem< TypeTag >::finishInit(), Opm::FvBaseProblem< TypeTag >::nextTimeStepSize(), and Opm::NcpNewtonMethod< TypeTag >::preSolve_(). ◆ getLists()
Retrieves the lists of parameters specified at runtime and their values. The two arguments besides the TypeTag are assumed to be STL containers which store std::pair<std::string, std::string>. ◆ Hide()
template<class Param >
Indicate that a given parameter should not be mentioned in the help message. This allows to deal with unused parameters References Opm::Parameters::detail::Hide_(). ◆ IsRegistrationOpen()
Query whether parameter registration is open or not.
◆ IsSet()
template<class Param >
Returns true if a parameter has been specified at runtime, false otherwise. If the parameter in question has not been registered, this throws an exception. References Opm::Parameters::detail::IsSet_(). ◆ parseCommandLineOptions()
Parse the parameters provided on the command line. This function does some basic syntax checks.
◆ parseParameterFile()
Read the parameters from an INI-style file. This function does some basic syntax checks. ◆ printUnused()
Print the list of unused run-time parameters.
◆ printUsage()
Print a usage message for all run-time parameters.
◆ printValues()
Print values of the run-time parameters.
Referenced by Opm::SimulatorFullyImplicitBlackoil< TypeTag >::getHeader(), and Opm::Main::initialize_(). ◆ Register()
template<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."
Register<UpwindWeight>("Relative weight of the upwind node.");
References Opm::Parameters::detail::Register_(). ◆ reset()
Reset parameter system. Referenced by Opm::FingerProblem< TypeTag >::finishInit(), and Opm::Main::runDynamic(). ◆ SetDefault()
template<class Param >
Set a runtime parameter. Override the default value specified. Example: // Set the value UpwindWeight
::Opm::Parameters::Set<::Opm::Parameters::UpwindWeight>(3.0);
References Opm::Parameters::detail::SetDefault_(). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||