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

Encapsulates a pseudo forecast model. More...

#include <PseudoModel.h>

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

Public Member Functions

 PseudoModel (const Geometry_ &, const eckit::Configuration &)
 
 ~PseudoModel ()
 
void initialize (State_ &) const override
 
void step (State_ &, const ModelAux_ &) const override
 
void finalize (State_ &) const override
 
const util::Duration & timeResolution () const override
 
void print (std::ostream &) const override
 
- Public Member Functions inherited from oops::ModelBase< MODEL >
 ModelBase ()
 
virtual ~ModelBase ()
 
void initialize (State_ &) const
 
void step (State_ &, const ModelAux_ &) const
 
void finalize (State_ &) const
 
virtual const oops::Variables & variables () const =0
 

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

Private Attributes

const Geometry_ resol_
 
const util::Duration tstep_
 

Additional Inherited Members

- Protected Member Functions inherited from oops::ModelBase< MODEL >
virtual void initialize (typename MODEL::State &) const =0
 
virtual void step (typename MODEL::State &, const typename MODEL::ModelAuxControl &) const =0
 
virtual void finalize (typename MODEL::State &) const =0
 

Detailed Description

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

Encapsulates a pseudo forecast model.

Generic implementation of the pseudo model.

Definition at line 37 of file PseudoModel.h.

Member Typedef Documentation

◆ Geometry_

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

Definition at line 38 of file PseudoModel.h.

◆ ModelAux_

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

Definition at line 39 of file PseudoModel.h.

◆ State_

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

Definition at line 40 of file PseudoModel.h.

Constructor & Destructor Documentation

◆ PseudoModel()

template<typename MODEL >
oops::PseudoModel< MODEL >::PseudoModel ( const Geometry_ &  resol,
const eckit::Configuration &  tlConf 
)

Definition at line 65 of file PseudoModel.h.

◆ ~PseudoModel()

template<typename MODEL >
oops::PseudoModel< MODEL >::~PseudoModel ( )

Definition at line 74 of file PseudoModel.h.

Member Function Documentation

◆ classname()

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

Definition at line 43 of file PseudoModel.h.

◆ finalize()

template<typename MODEL >
void oops::PseudoModel< MODEL >::finalize ( State_ &  xx) const
override

Definition at line 98 of file PseudoModel.h.

Here is the call graph for this function:

◆ initialize()

template<typename MODEL >
void oops::PseudoModel< MODEL >::initialize ( State_ &  xx) const
override

Definition at line 81 of file PseudoModel.h.

Here is the call graph for this function:

◆ print()

template<typename MODEL >
void oops::PseudoModel< MODEL >::print ( std::ostream &  ) const
inlineoverridevirtual

Implements oops::ModelBase< MODEL >.

Definition at line 55 of file PseudoModel.h.

◆ step()

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

Definition at line 89 of file PseudoModel.h.

Here is the call graph for this function:

◆ timeResolution()

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

Implements oops::ModelBase< MODEL >.

Definition at line 54 of file PseudoModel.h.

Member Data Documentation

◆ resol_

template<typename MODEL >
const Geometry_ oops::PseudoModel< MODEL >::resol_
private

Definition at line 58 of file PseudoModel.h.

◆ tstep_

template<typename MODEL >
const util::Duration oops::PseudoModel< MODEL >::tstep_
private

Definition at line 59 of file PseudoModel.h.

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