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. Macro Definition Documentation
Indicate that all parameters are registered for a given type tag. If
Value:
(::Ewoms::Parameters::get<TypeTag, ParamType, PTAG(ParamName)>(#ParamName, \
#ParamName))
Retrieve a runtime parameter. The default value is specified via the property system. Example: Referenced by Ewoms::NewtonMethod< TypeTag >::begin_(), Ewoms::BlackOilNewtonMethod< TypeTag >::BlackOilNewtonMethod(), Ewoms::DarcyExtensiveQuantities< TypeTag >::calculateBoundaryGradients_(), Ewoms::DarcyExtensiveQuantities< TypeTag >::calculateGradients_(), Ewoms::CubeGridManager< TypeTag >::CubeGridManager(), Ewoms::DgfGridManager< TypeTag >::DgfGridManager(), Ewoms::DiscreteFractureModel< TypeTag >::DiscreteFractureModel(), Ewoms::FvBaseDiscretization< TypeTag >::enableIntensiveQuantitiesCache_(), Ewoms::FvBaseDiscretization< TypeTag >::enableThermodynamicHints_(), Ewoms::NewtonMethod< TypeTag >::end_(), Ewoms::MultiPhaseBaseModel< TypeTag >::finishInit(), Ewoms::ThreadManager< TypeTag >::init(), Ewoms::NewtonMethod< TypeTag >::maxIterations_(), Ewoms::NcpNewtonMethod< TypeTag >::NcpNewtonMethod(), Ewoms::NewtonMethod< TypeTag >::NewtonMethod(), Ewoms::FvBaseProblem< TypeTag >::nextTimeStepSize(), Ewoms::FvBaseAdLocalLinearizer< TypeTag >::numericDifferenceMethod_(), Ewoms::FvBaseFdLocalLinearizer< TypeTag >::numericDifferenceMethod_(), Ewoms::PvsModel< TypeTag >::PvsModel(), Ewoms::Simulator< TypeTag >::run(), Ewoms::SimplexGridManager< TypeTag >::SimplexGridManager(), Ewoms::Simulator< TypeTag >::Simulator(), Ewoms::Linear::ParallelAmgBackend< TypeTag >::solve(), Ewoms::Linear::ParallelIterativeSolverBackend< TypeTag >::solve(), start(), Ewoms::StokesProblem< TypeTag >::StokesProblem(), Ewoms::NewtonMethod< TypeTag >::targetIterations_(), Ewoms::FvBaseProblem< TypeTag >::timeIntegration(), Ewoms::FlashIntensiveQuantities< TypeTag >::update(), Ewoms::NewtonMethod< TypeTag >::updateError_(), Ewoms::NewtonMethod< TypeTag >::verbose_(), and Ewoms::NewtonMethod< TypeTag >::writeConvergence_().
Value:
::Ewoms::Parameters::registerParam<TypeTag, ParamType, PTAG(ParamName)>( \
#ParamName, #ParamName, Description)
Register a run-time parameter. In OPM, parameters can only be used after they have been registered. Example: Referenced by Ewoms::BlackOilNewtonMethod< TypeTag >::registerParameters(), Ewoms::ThreadManager< TypeTag >::registerParameters(), Ewoms::DgfGridManager< TypeTag >::registerParameters(), Ewoms::NcpNewtonMethod< TypeTag >::registerParameters(), Ewoms::StokesLocalResidual< TypeTag >::registerParameters(), Ewoms::SimplexGridManager< TypeTag >::registerParameters(), Ewoms::StokesProblem< TypeTag >::registerParameters(), Ewoms::VtkPhasePresenceModule< TypeTag >::registerParameters(), Ewoms::CubeGridManager< TypeTag >::registerParameters(), Ewoms::VtkPrimaryVarsModule< TypeTag >::registerParameters(), Ewoms::VtkTemperatureModule< TypeTag >::registerParameters(), Ewoms::MultiPhaseBaseProblem< TypeTag >::registerParameters(), Ewoms::VtkDiffusionModule< TypeTag >::registerParameters(), Ewoms::VtkEnergyModule< TypeTag >::registerParameters(), Ewoms::VtkBlackOilModule< TypeTag >::registerParameters(), Ewoms::VtkCompositionModule< TypeTag >::registerParameters(), Ewoms::VtkDiscreteFractureModule< TypeTag >::registerParameters(), Ewoms::FvBaseProblem< TypeTag >::registerParameters(), Ewoms::VtkMultiPhaseModule< TypeTag >::registerParameters(), Ewoms::Simulator< TypeTag >::registerParameters(), Ewoms::Linear::ParallelAmgBackend< TypeTag >::registerParameters(), Ewoms::FvBaseLinearizer< TypeTag >::registerParameters(), Ewoms::FvBaseFdLocalLinearizer< TypeTag >::registerParameters(), Ewoms::NewtonMethod< TypeTag >::registerParameters(), Ewoms::FlashModel< TypeTag >::registerParameters(), Ewoms::Linear::ParallelIterativeSolverBackend< TypeTag >::registerParameters(), Ewoms::PvsModel< TypeTag >::registerParameters(), and Ewoms::FvBaseDiscretization< TypeTag >::registerParameters(). Function Documentation
template<class TypeTag >
Parse the parameters provided on the command line. This function does some basic syntax checks.
References GET_PROP.
template<class TypeTag >
Print the list of unused run-time parameters.
References GET_PROP.
template<class TypeTag >
Print a usage message for all run-time parameters.
References GET_PROP, and GET_PROP_VALUE.
template<class TypeTag >
Print values of the run-time parameters.
References GET_PROP. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||