Base class for MODEL-specific implementations of the Model interface. interface::ModelBase overrides oops::ModelBase methods to pass MODEL-specific implementations of State and ModelAuxControl to the MODEL-specific implementation of Model. More...
#include <ModelBase.h>
Public Member Functions | |
| ModelBase ()=default | |
| virtual | ~ModelBase ()=default |
| void | initialize (oops::State< MODEL > &xx) const final |
| void | step (oops::State< MODEL > &xx, const ModelAuxControl< MODEL > &modelaux) const final |
| Forecast "step", called during forecast run; updates state to the next time. More... | |
| void | finalize (oops::State< MODEL > &xx) const final |
| Forecast finalization; called after each forecast run. More... | |
| virtual void | initialize (State_ &) const =0 |
| Forecast initialization, called before every forecast run. More... | |
| virtual void | step (State_ &, const ModelAux_ &) const =0 |
| Forecast "step", called during forecast run; updates state to the next time. More... | |
| virtual void | finalize (State_ &) const =0 |
| Forecast finalization; called after each forecast run. More... | |
 Public Member Functions inherited from oops::ModelBase< MODEL > | |
| ModelBase ()=default | |
| virtual const util::Duration & | timeResolution () const =0 |
| Time step for running Model's forecast in oops (frequency with which the State will be updated) More... | |
| virtual const oops::Variables & | variables () const =0 |
| Model variables (only used in 4DVar) More... | |
Static Public Member Functions | |
| static const std::string | classname () |
| Static Public Member Functions inherited from oops::ModelBase< MODEL > | |
| static const std::string | classname () |
Private Types | |
| typedef MODEL::ModelAuxControl | ModelAux_ |
| typedef MODEL::State | State_ |
Detailed Description
template<typename MODEL>
class oops::interface::ModelBase< MODEL >
Base class for MODEL-specific implementations of the Model interface. interface::ModelBase overrides oops::ModelBase methods to pass MODEL-specific implementations of State and ModelAuxControl to the MODEL-specific implementation of Model.
Note: implementations of this interface can opt to extract their settings either from a Configuration object or from a subclass of ModelParametersBase.
In the former case, they should provide a constructor with the following signature:
ModelBase(const Geometry_ &, const eckit::Configuration &);
In the latter case, the implementer should first define a subclass of ModelParametersBase holding the settings of the model in question. The implementation of the ModelBase interface should then typedef Parameters_ to the name of that subclass and provide a constructor with the following signature:
ModelBase(const Geometry_ &, const Parameters_ &);
Definition at line 48 of file interface/ModelBase.h.
Member Typedef Documentation
◆ ModelAux_
|
private |
Definition at line 49 of file interface/ModelBase.h.
◆ State_
|
private |
Definition at line 50 of file interface/ModelBase.h.
Constructor & Destructor Documentation
◆ ModelBase()
|
default |
◆ ~ModelBase()
|
virtualdefault |
Reimplemented from oops::ModelBase< MODEL >.
Member Function Documentation
◆ classname()
|
inlinestatic |
Definition at line 53 of file interface/ModelBase.h.
◆ finalize() [1/2]
|
inlinefinalvirtual |
Forecast finalization; called after each forecast run.
Implements oops::ModelBase< MODEL >.
Definition at line 64 of file interface/ModelBase.h.
◆ finalize() [2/2]
|
pure virtual |
Forecast finalization; called after each forecast run.
Implements oops::ModelBase< MODEL >.
◆ initialize() [1/2]
|
inlinefinalvirtual |
Overrides for oops::ModelBase classes, passing MODEL-specific classes to the MODEL-specific implementations of Model
Implements oops::ModelBase< MODEL >.
Definition at line 60 of file interface/ModelBase.h.
◆ initialize() [2/2]
|
pure virtual |
Forecast initialization, called before every forecast run.
Implements oops::ModelBase< MODEL >.
◆ step() [1/2]
|
inlinefinalvirtual |
Forecast "step", called during forecast run; updates state to the next time.
Implements oops::ModelBase< MODEL >.
Definition at line 62 of file interface/ModelBase.h.
◆ step() [2/2]
|
pure virtual |
Forecast "step", called during forecast run; updates state to the next time.
Implements oops::ModelBase< MODEL >.
The documentation for this class was generated from the following file:
