OOPS
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
oops::PseudoModelState4D< MODEL > Class Template Reference

#include <PseudoModelState4D.h>

Inheritance diagram for oops::PseudoModelState4D< MODEL >:
Inheritance graph
[legend]
Collaboration diagram for oops::PseudoModelState4D< MODEL >:
Collaboration graph
[legend]

Public Member Functions

 PseudoModelState4D (const State4D_ &state4d, const util::Duration &tstep=util::Duration(0))
 
void initialize (State_ &) const override
 initialize forecast More...
 
void step (State_ &, const ModelAux_ &) const override
 one forecast step More...
 
void finalize (State_ &) const override
 finalize forecast More...
 
const util::Duration & timeResolution () const override
 model time step More...
 
const oops::Variables & variables () const override
 model variables More...
 
- Public Member Functions inherited from oops::ModelBase< MODEL >
 ModelBase ()=default
 
virtual ~ModelBase ()=default
 

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 Geometry< MODEL > Geometry_
 
typedef ModelAuxControl< MODEL > ModelAux_
 
typedef State< MODEL > State_
 
typedef State4D< MODEL > State4D_
 

Private Member Functions

void print (std::ostream &) const override
 Print; used for logging. More...
 

Private Attributes

const State4D_ & state4d_
 Reference to 4D state that is used in the model. More...
 
util::Duration tstep_
 Model's time resolution. More...
 
const oops::Variables vars_
 Variables from 4D state. More...
 
size_t currentstate_
 Index of the current state. More...
 

Detailed Description

template<typename MODEL>
class oops::PseudoModelState4D< MODEL >

Generic implementation of the pseudo model initialized with 4D State (steps through time by stepping through states in 4D state)

Definition at line 31 of file oops/generic/PseudoModelState4D.h.

Member Typedef Documentation

◆ Geometry_

template<typename MODEL >
typedef Geometry<MODEL> oops::PseudoModelState4D< MODEL >::Geometry_
private

Definition at line 32 of file oops/generic/PseudoModelState4D.h.

◆ ModelAux_

template<typename MODEL >
typedef ModelAuxControl<MODEL> oops::PseudoModelState4D< MODEL >::ModelAux_
private

Definition at line 33 of file oops/generic/PseudoModelState4D.h.

◆ State4D_

template<typename MODEL >
typedef State4D<MODEL> oops::PseudoModelState4D< MODEL >::State4D_
private

Definition at line 35 of file oops/generic/PseudoModelState4D.h.

◆ State_

template<typename MODEL >
typedef State<MODEL> oops::PseudoModelState4D< MODEL >::State_
private

Definition at line 34 of file oops/generic/PseudoModelState4D.h.

Constructor & Destructor Documentation

◆ PseudoModelState4D()

template<typename MODEL >
oops::PseudoModelState4D< MODEL >::PseudoModelState4D ( const State4D_ &  state4d,
const util::Duration &  tstep = util::Duration(0) 
)

Initialize pseudo model with state4d - 4D state to loop through in the model run and tstep - time resolution of the model

Definition at line 74 of file oops/generic/PseudoModelState4D.h.

Here is the call graph for this function:

Member Function Documentation

◆ classname()

template<typename MODEL >
static const std::string oops::PseudoModelState4D< MODEL >::classname ( )
inlinestatic

Definition at line 38 of file oops/generic/PseudoModelState4D.h.

◆ finalize()

template<typename MODEL >
void oops::PseudoModelState4D< MODEL >::finalize ( State_ &  xx) const
overridevirtual

finalize forecast

Implements oops::ModelBase< MODEL >.

Definition at line 103 of file oops/generic/PseudoModelState4D.h.

◆ initialize()

template<typename MODEL >
void oops::PseudoModelState4D< MODEL >::initialize ( State_ &  xx) const
overridevirtual

initialize forecast

Implements oops::ModelBase< MODEL >.

Definition at line 85 of file oops/generic/PseudoModelState4D.h.

◆ print()

template<typename MODEL >
void oops::PseudoModelState4D< MODEL >::print ( std::ostream &  ) const
overrideprivatevirtual

Print; used for logging.

Implements oops::ModelBase< MODEL >.

Definition at line 110 of file oops/generic/PseudoModelState4D.h.

◆ step()

template<typename MODEL >
void oops::PseudoModelState4D< MODEL >::step ( State_ &  xx,
const ModelAux_ &  merr 
) const
overridevirtual

one forecast step

Implements oops::ModelBase< MODEL >.

Definition at line 94 of file oops/generic/PseudoModelState4D.h.

◆ timeResolution()

template<typename MODEL >
const util::Duration& oops::PseudoModelState4D< MODEL >::timeResolution ( ) const
inlineoverridevirtual

model time step

Implements oops::ModelBase< MODEL >.

Definition at line 53 of file oops/generic/PseudoModelState4D.h.

◆ variables()

template<typename MODEL >
const oops::Variables& oops::PseudoModelState4D< MODEL >::variables ( ) const
inlineoverridevirtual

model variables

Implements oops::ModelBase< MODEL >.

Definition at line 56 of file oops/generic/PseudoModelState4D.h.

Member Data Documentation

◆ currentstate_

template<typename MODEL >
size_t oops::PseudoModelState4D< MODEL >::currentstate_
mutableprivate

Index of the current state.

Definition at line 68 of file oops/generic/PseudoModelState4D.h.

◆ state4d_

template<typename MODEL >
const State4D_& oops::PseudoModelState4D< MODEL >::state4d_
private

Reference to 4D state that is used in the model.

Definition at line 62 of file oops/generic/PseudoModelState4D.h.

◆ tstep_

template<typename MODEL >
util::Duration oops::PseudoModelState4D< MODEL >::tstep_
private

Model's time resolution.

Definition at line 64 of file oops/generic/PseudoModelState4D.h.

◆ vars_

template<typename MODEL >
const oops::Variables oops::PseudoModelState4D< MODEL >::vars_
private

Variables from 4D state.

Definition at line 66 of file oops/generic/PseudoModelState4D.h.

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