OOPS
oops::VariableChangeParametersBase Class Reference

Base class of classes storing parameters controlling specific variable changes. More...

#include <VariableChangeParametersBase.h>

Inheritance diagram for oops::VariableChangeParametersBase:
Collaboration diagram for oops::VariableChangeParametersBase:

Public Attributes

OptionalParameter< std::string > variableChange {"variable change", this}
 Variable change type. More...
 
OptionalParameter< VariablesinputVariables {"input variables", this}
 
OptionalParameter< VariablesoutputVariables {"output variables", this}
 

Detailed Description

Base class of classes storing parameters controlling specific variable changes.

Definition at line 21 of file VariableChangeParametersBase.h.

Member Data Documentation

◆ inputVariables

OptionalParameter<Variables> oops::VariableChangeParametersBase::inputVariables {"input variables", this}

Definition at line 34 of file VariableChangeParametersBase.h.

◆ outputVariables

OptionalParameter<Variables> oops::VariableChangeParametersBase::outputVariables {"output variables", this}

Definition at line 35 of file VariableChangeParametersBase.h.

◆ variableChange

OptionalParameter<std::string> oops::VariableChangeParametersBase::variableChange {"variable change", this}

Variable change type.

Note
This parameter is marked as optional because it is only required in certain circumstances (e.g. when variable change parameters are deserialized into a VariableChangeParametersWrapper and used by VariableChangeFactory to instantiate a variable change whose type is determined at runtime), but not others (e.g. in tests written with a particular variable change in mind). VariableChangeParametersWrapper will throw an exception if this parameter is not provided.

Definition at line 32 of file VariableChangeParametersBase.h.


The documentation for this class was generated from the following file: