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

Generic implementation of identity model. More...

#include <IdentityModel.h>

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

Public Types

typedef IdentityModelParameters Parameters_
 

Public Member Functions

 IdentityModel (const Geometry_ &, const IdentityModelParameters &)
 
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_
 

Private Member Functions

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

Private Attributes

const IdentityModelParameters params_
 

Detailed Description

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

Generic implementation of identity model.

Definition at line 36 of file IdentityModel.h.

Member Typedef Documentation

◆ Geometry_

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

Definition at line 37 of file IdentityModel.h.

◆ ModelAux_

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

Definition at line 38 of file IdentityModel.h.

◆ Parameters_

template<typename MODEL >
typedef IdentityModelParameters oops::IdentityModel< MODEL >::Parameters_

Definition at line 42 of file IdentityModel.h.

◆ State_

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

Definition at line 39 of file IdentityModel.h.

Constructor & Destructor Documentation

◆ IdentityModel()

template<typename MODEL >
oops::IdentityModel< MODEL >::IdentityModel ( const Geometry_ &  resol,
const IdentityModelParameters &  params 
)

Definition at line 68 of file IdentityModel.h.

Member Function Documentation

◆ classname()

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

Definition at line 44 of file IdentityModel.h.

◆ finalize()

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

finalize forecast

Implements oops::ModelBase< MODEL >.

Definition at line 92 of file IdentityModel.h.

◆ initialize()

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

initialize forecast

Implements oops::ModelBase< MODEL >.

Definition at line 76 of file IdentityModel.h.

◆ print()

template<typename MODEL >
void oops::IdentityModel< MODEL >::print ( std::ostream &  ) const
inlineoverrideprivatevirtual

Print; used for logging.

Implements oops::ModelBase< MODEL >.

Definition at line 61 of file IdentityModel.h.

◆ step()

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

one forecast step

Implements oops::ModelBase< MODEL >.

Definition at line 83 of file IdentityModel.h.

Here is the call graph for this function:

◆ timeResolution()

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

model time step

Implements oops::ModelBase< MODEL >.

Definition at line 56 of file IdentityModel.h.

◆ variables()

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

model variables

Implements oops::ModelBase< MODEL >.

Definition at line 58 of file IdentityModel.h.

Member Data Documentation

◆ params_

template<typename MODEL >
const IdentityModelParameters oops::IdentityModel< MODEL >::params_
private

Definition at line 62 of file IdentityModel.h.

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