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

Generic implementation of identity linear model. More...

#include <IdentityLinearModel.h>

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

Public Types

typedef IdentityLinearModelParameters Parameters_
 

Public Member Functions

 IdentityLinearModel (const Geometry_ &, const IdentityLinearModelParameters &)
 
void initializeTL (Increment_ &) const override
 initialize tangent linear forecast More...
 
void stepTL (Increment_ &, const ModelAuxInc_ &) const override
 one tangent linear forecast step More...
 
void finalizeTL (Increment_ &) const override
 finalize tangent linear forecast More...
 
void initializeAD (Increment_ &) const override
 initialize tangent linear forecast More...
 
void stepAD (Increment_ &, ModelAuxInc_ &) const override
 one tangent linear forecast step More...
 
void finalizeAD (Increment_ &) const override
 finalize tangent linear forecast More...
 
void setTrajectory (const State_ &, State_ &, const ModelAuxCtl_ &) override
 set trajectory More...
 
const util::Duration & timeResolution () const override
 linear model time step More...
 
const oops::Variables & variables () const override
 linear model variables More...
 
- Public Member Functions inherited from oops::LinearModelBase< MODEL >
 LinearModelBase ()=default
 
virtual ~LinearModelBase ()=default
 

Static Public Member Functions

static const std::string classname ()
 
- Static Public Member Functions inherited from oops::LinearModelBase< MODEL >
static const std::string classname ()
 

Private Types

typedef Geometry< MODEL > Geometry_
 
typedef Increment< MODEL > Increment_
 
typedef ModelAuxControl< MODEL > ModelAuxCtl_
 
typedef ModelAuxIncrement< MODEL > ModelAuxInc_
 
typedef State< MODEL > State_
 

Private Member Functions

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

Private Attributes

const IdentityLinearModelParameters params_
 

Detailed Description

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

Generic implementation of identity linear model.

Definition at line 40 of file IdentityLinearModel.h.

Member Typedef Documentation

◆ Geometry_

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

Definition at line 41 of file IdentityLinearModel.h.

◆ Increment_

template<typename MODEL >
typedef Increment<MODEL> oops::IdentityLinearModel< MODEL >::Increment_
private

Definition at line 42 of file IdentityLinearModel.h.

◆ ModelAuxCtl_

template<typename MODEL >
typedef ModelAuxControl<MODEL> oops::IdentityLinearModel< MODEL >::ModelAuxCtl_
private

Definition at line 43 of file IdentityLinearModel.h.

◆ ModelAuxInc_

template<typename MODEL >
typedef ModelAuxIncrement<MODEL> oops::IdentityLinearModel< MODEL >::ModelAuxInc_
private

Definition at line 44 of file IdentityLinearModel.h.

◆ Parameters_

template<typename MODEL >
typedef IdentityLinearModelParameters oops::IdentityLinearModel< MODEL >::Parameters_

Definition at line 48 of file IdentityLinearModel.h.

◆ State_

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

Definition at line 45 of file IdentityLinearModel.h.

Constructor & Destructor Documentation

◆ IdentityLinearModel()

template<typename MODEL >
oops::IdentityLinearModel< MODEL >::IdentityLinearModel ( const Geometry_ &  resol,
const IdentityLinearModelParameters &  params 
)

Definition at line 84 of file IdentityLinearModel.h.

Member Function Documentation

◆ classname()

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

Definition at line 50 of file IdentityLinearModel.h.

◆ finalizeAD()

template<typename MODEL >
void oops::IdentityLinearModel< MODEL >::finalizeAD ( Increment_ &  dx) const
overridevirtual

finalize tangent linear forecast

Implements oops::LinearModelBase< MODEL >.

Definition at line 133 of file IdentityLinearModel.h.

◆ finalizeTL()

template<typename MODEL >
void oops::IdentityLinearModel< MODEL >::finalizeTL ( Increment_ &  dx) const
overridevirtual

finalize tangent linear forecast

Implements oops::LinearModelBase< MODEL >.

Definition at line 109 of file IdentityLinearModel.h.

◆ initializeAD()

template<typename MODEL >
void oops::IdentityLinearModel< MODEL >::initializeAD ( Increment_ &  dx) const
overridevirtual

initialize tangent linear forecast

Implements oops::LinearModelBase< MODEL >.

Definition at line 116 of file IdentityLinearModel.h.

◆ initializeTL()

template<typename MODEL >
void oops::IdentityLinearModel< MODEL >::initializeTL ( Increment_ &  dx) const
overridevirtual

initialize tangent linear forecast

Implements oops::LinearModelBase< MODEL >.

Definition at line 93 of file IdentityLinearModel.h.

◆ print()

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

Print; used for logging.

Implements oops::LinearModelBase< MODEL >.

Definition at line 77 of file IdentityLinearModel.h.

◆ setTrajectory()

template<typename MODEL >
void oops::IdentityLinearModel< MODEL >::setTrajectory ( const State_ &  x,
State_ &  xlr,
const ModelAuxCtl_ &  maux 
)
overridevirtual

set trajectory

Implements oops::LinearModelBase< MODEL >.

Definition at line 140 of file IdentityLinearModel.h.

◆ stepAD()

template<typename MODEL >
void oops::IdentityLinearModel< MODEL >::stepAD ( Increment_ &  dx,
ModelAuxInc_ &  merr 
) const
overridevirtual

one tangent linear forecast step

Implements oops::LinearModelBase< MODEL >.

Definition at line 123 of file IdentityLinearModel.h.

Here is the call graph for this function:

◆ stepTL()

template<typename MODEL >
void oops::IdentityLinearModel< MODEL >::stepTL ( Increment_ &  dx,
const ModelAuxInc_ &  merr 
) const
overridevirtual

one tangent linear forecast step

Implements oops::LinearModelBase< MODEL >.

Definition at line 100 of file IdentityLinearModel.h.

Here is the call graph for this function:

◆ timeResolution()

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

linear model time step

Implements oops::LinearModelBase< MODEL >.

Definition at line 72 of file IdentityLinearModel.h.

◆ variables()

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

linear model variables

Implements oops::LinearModelBase< MODEL >.

Definition at line 74 of file IdentityLinearModel.h.

Member Data Documentation

◆ params_

template<typename MODEL >
const IdentityLinearModelParameters oops::IdentityLinearModel< MODEL >::params_
private

Definition at line 78 of file IdentityLinearModel.h.

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