FV3 Bundle
oops::Model< MODEL > Class Template Reference

Encapsulates the nonlinear forecast model. More...

#include <Model.h>

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

Public Member Functions

 Model (const Geometry_ &, const eckit::Configuration &)
 
virtual ~Model ()
 
void forecast (State_ &, const ModelAux_ &, const util::Duration &, PostProcessor< State_ > &) const
 
const util::Duration & timeResolution () const
 
const oops::Variablesvariables () const
 

Static Public Member Functions

static const std::string classname ()
 

Private Types

typedef ModelBase< MODEL > ModelBase_
 
typedef Geometry< MODEL > Geometry_
 
typedef ModelAuxControl< MODEL > ModelAux_
 
typedef State< MODEL > State_
 

Private Member Functions

void initialize (State_ &) const
 
void step (State_ &, const ModelAux_ &) const
 
void finalize (State_ &) const
 
void print (std::ostream &) const
 

Private Attributes

boost::scoped_ptr< ModelBase_model_
 

Detailed Description

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

Encapsulates the nonlinear forecast model.

Definition at line 36 of file oops/interface/Model.h.

Member Typedef Documentation

◆ Geometry_

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

Definition at line 40 of file oops/interface/Model.h.

◆ ModelAux_

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

Definition at line 41 of file oops/interface/Model.h.

◆ ModelBase_

template<typename MODEL >
typedef ModelBase<MODEL> oops::Model< MODEL >::ModelBase_
private

Definition at line 39 of file oops/interface/Model.h.

◆ State_

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

Definition at line 42 of file oops/interface/Model.h.

Constructor & Destructor Documentation

◆ Model()

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

Definition at line 70 of file oops/interface/Model.h.

Here is the call graph for this function:

◆ ~Model()

template<typename MODEL >
oops::Model< MODEL >::~Model ( )
virtual

Definition at line 83 of file oops/interface/Model.h.

Member Function Documentation

◆ classname()

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

Definition at line 45 of file oops/interface/Model.h.

Here is the caller graph for this function:

◆ finalize()

template<typename MODEL >
void oops::Model< MODEL >::finalize ( State_ xx) const
private

Definition at line 143 of file oops/interface/Model.h.

◆ forecast()

template<typename MODEL >
void oops::Model< MODEL >::forecast ( State_ xx,
const ModelAux_ maux,
const util::Duration &  len,
PostProcessor< State_ > &  post 
) const

Definition at line 95 of file oops/interface/Model.h.

Here is the call graph for this function:

◆ initialize()

template<typename MODEL >
void oops::Model< MODEL >::initialize ( State_ xx) const
private

Definition at line 123 of file oops/interface/Model.h.

◆ print()

template<typename MODEL >
void oops::Model< MODEL >::print ( std::ostream &  os) const
private

Definition at line 153 of file oops/interface/Model.h.

◆ step()

template<typename MODEL >
void oops::Model< MODEL >::step ( State_ xx,
const ModelAux_ maux 
) const
private

Definition at line 133 of file oops/interface/Model.h.

◆ timeResolution()

template<typename MODEL >
const util::Duration& oops::Model< MODEL >::timeResolution ( ) const
inline

Definition at line 55 of file oops/interface/Model.h.

◆ variables()

template<typename MODEL >
const oops::Variables& oops::Model< MODEL >::variables ( ) const
inline

Definition at line 56 of file oops/interface/Model.h.

Member Data Documentation

◆ model_

template<typename MODEL >
boost::scoped_ptr<ModelBase_> oops::Model< MODEL >::model_
private

Definition at line 64 of file oops/interface/Model.h.


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