Base class for generic implementations of the linearized forecasting models. Use this class as a base class for generic implementations, and interface::LinearModelBase as a base class for MODEL-specific implementations. More...

#include <LinearModelBase.h>

Inheritance diagram for oops::LinearModelBase< MODEL >:

[legend]

Collaboration diagram for oops::LinearModelBase< MODEL >:

[legend]

Public Member Functions
	LinearModelBase ()=default

virtual	~LinearModelBase ()=default

virtual void	initializeTL (Increment_ &) const =0
	Tangent linear initialization, called before every run. More...

virtual void	stepTL (Increment_ &, const ModelAuxInc_ &) const =0
	Tangent linear "step", called during run; updates increment to the next time. More...

virtual void	finalizeTL (Increment_ &) const =0
	Tangent linear finalization; called after each run. More...

virtual void	initializeAD (Increment_ &) const =0
	Tangent linear initialization, called before every run. More...

virtual void	stepAD (Increment_ &, ModelAuxInc_ &) const =0
	Tangent linear "step", called during run; updates increment to the next time. More...

virtual void	finalizeAD (Increment_ &) const =0
	Tangent linear finalization; called after each run. More...

virtual void	setTrajectory (const State_ &, State_ &, const ModelAuxCtl_ &)=0
	Set the trajectory for the linear model, called after each step of the forecast. More...

virtual const util::Duration &	timeResolution () const =0
	Time step for running LinearModel's forecast in oops (frequency with which the increment will be updated) More...

virtual const oops::Variables &	variables () const =0
	LinearModel variables (only used in 4DVar) More...

Static Public Member Functions
static const std::string	classname ()

Private Types
typedef Increment< MODEL >	Increment_

typedef ModelAuxControl< MODEL >	ModelAuxCtl_

typedef ModelAuxIncrement< MODEL >	ModelAuxInc_

typedef State< MODEL >	State_

Private Member Functions
virtual void	print (std::ostream &) const =0
	Print; used for logging. More...

Detailed Description

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

Base class for generic implementations of the linearized forecasting models. Use this class as a base class for generic implementations, and interface::LinearModelBase as a base class for MODEL-specific implementations.

Note: implementations of this interface can opt to extract their settings either from a Configuration object or from a subclass of LinearModelParametersBase.

In the former case, they should provide a constructor with the following signature:

LinearModelBase(const Geometry_ &, const eckit::Configuration &);

In the latter case, the implementer should first define a subclass of LinearModelParametersBase holding the settings of the linear model in question. The implementation of the LinearModelBase interface should then typedef Parameters_ to the name of that subclass and provide a constructor with the following signature:

LinearModelBase(const Geometry_ &, const Parameters_ &);

Definition at line 62 of file generic/LinearModelBase.h.

Member Typedef Documentation

◆ Increment_

template<typename MODEL >

typedef Increment<MODEL> oops::LinearModelBase< MODEL >::Increment_

private

Definition at line 64 of file generic/LinearModelBase.h.

◆ ModelAuxCtl_

template<typename MODEL >

typedef ModelAuxControl<MODEL> oops::LinearModelBase< MODEL >::ModelAuxCtl_

private

Definition at line 65 of file generic/LinearModelBase.h.

◆ ModelAuxInc_

template<typename MODEL >

typedef ModelAuxIncrement<MODEL> oops::LinearModelBase< MODEL >::ModelAuxInc_

private

Definition at line 66 of file generic/LinearModelBase.h.

◆ State_

template<typename MODEL >

typedef State<MODEL> oops::LinearModelBase< MODEL >::State_

private

Definition at line 67 of file generic/LinearModelBase.h.

Constructor & Destructor Documentation

◆ LinearModelBase()

template<typename MODEL >

oops::LinearModelBase< MODEL >::LinearModelBase ( )

default

◆ ~LinearModelBase()

template<typename MODEL >

virtual oops::LinearModelBase< MODEL >::~LinearModelBase ( )

virtualdefault

Reimplemented in oops::interface::LinearModelBase< MODEL >, oops::interface::LinearModelBase< QgTraits >, and oops::interface::LinearModelBase< L95Traits >.

Member Function Documentation

◆ classname()

template<typename MODEL >

static const std::string oops::LinearModelBase< MODEL >::classname ( )

inlinestatic

Definition at line 70 of file generic/LinearModelBase.h.

◆ finalizeAD()

template<typename MODEL >

virtual void oops::LinearModelBase< MODEL >::finalizeAD ( Increment_ & ) const

pure virtual

Tangent linear finalization; called after each run.

Implemented in oops::interface::LinearModelBase< MODEL >, oops::interface::LinearModelBase< QgTraits >, oops::interface::LinearModelBase< L95Traits >, oops::IdentityLinearModel< MODEL >, and oops::interface::LinearModelBase< MODEL >.

◆ finalizeTL()

template<typename MODEL >

virtual void oops::LinearModelBase< MODEL >::finalizeTL ( Increment_ & ) const

pure virtual

Tangent linear finalization; called after each run.

Implemented in oops::interface::LinearModelBase< MODEL >, oops::interface::LinearModelBase< QgTraits >, oops::interface::LinearModelBase< L95Traits >, oops::IdentityLinearModel< MODEL >, and oops::interface::LinearModelBase< MODEL >.

◆ initializeAD()

template<typename MODEL >

virtual void oops::LinearModelBase< MODEL >::initializeAD ( Increment_ & ) const

pure virtual

Tangent linear initialization, called before every run.

Implemented in oops::interface::LinearModelBase< MODEL >, oops::interface::LinearModelBase< QgTraits >, oops::interface::LinearModelBase< L95Traits >, oops::IdentityLinearModel< MODEL >, and oops::interface::LinearModelBase< MODEL >.

◆ initializeTL()

template<typename MODEL >

virtual void oops::LinearModelBase< MODEL >::initializeTL ( Increment_ & ) const

pure virtual

Tangent linear initialization, called before every run.

Implemented in oops::interface::LinearModelBase< MODEL >, oops::interface::LinearModelBase< QgTraits >, oops::interface::LinearModelBase< L95Traits >, oops::IdentityLinearModel< MODEL >, and oops::interface::LinearModelBase< MODEL >.

◆ print()

template<typename MODEL >

virtual void oops::LinearModelBase< MODEL >::print ( std::ostream & ) const

privatepure virtual

Print; used for logging.

Implemented in oops::interface::LinearModelBase< QgTraits >, oops::interface::LinearModelBase< L95Traits >, oops::IdentityLinearModel< MODEL >, qg::TlmQG, lorenz95::TLML95, and oops::interface::LinearModelBase< MODEL >.

◆ setTrajectory()

template<typename MODEL >

virtual void oops::LinearModelBase< MODEL >::setTrajectory	(	const State_ &	,
		State_ &	,
		const ModelAuxCtl_ &
	)

pure virtual

Set the trajectory for the linear model, called after each step of the forecast.

Implemented in oops::interface::LinearModelBase< MODEL >, oops::interface::LinearModelBase< QgTraits >, oops::interface::LinearModelBase< L95Traits >, oops::IdentityLinearModel< MODEL >, and oops::interface::LinearModelBase< MODEL >.

◆ stepAD()

template<typename MODEL >

virtual void oops::LinearModelBase< MODEL >::stepAD	(	Increment_ &	,
		ModelAuxInc_ &
	)		const

pure virtual

Tangent linear "step", called during run; updates increment to the next time.

Implemented in oops::interface::LinearModelBase< MODEL >, oops::interface::LinearModelBase< QgTraits >, oops::interface::LinearModelBase< L95Traits >, oops::IdentityLinearModel< MODEL >, and oops::interface::LinearModelBase< MODEL >.

◆ stepTL()

template<typename MODEL >

virtual void oops::LinearModelBase< MODEL >::stepTL	(	Increment_ &	,
		const ModelAuxInc_ &
	)		const

pure virtual

Tangent linear "step", called during run; updates increment to the next time.

Implemented in oops::interface::LinearModelBase< MODEL >, oops::interface::LinearModelBase< QgTraits >, oops::interface::LinearModelBase< L95Traits >, oops::IdentityLinearModel< MODEL >, and oops::interface::LinearModelBase< MODEL >.

◆ timeResolution()

template<typename MODEL >

virtual const util::Duration& oops::LinearModelBase< MODEL >::timeResolution ( ) const

pure virtual

Time step for running LinearModel's forecast in oops (frequency with which the increment will be updated)

Implemented in oops::IdentityLinearModel< MODEL >, qg::TlmQG, and lorenz95::TLML95.

◆ variables()

template<typename MODEL >

virtual const oops::Variables& oops::LinearModelBase< MODEL >::variables ( ) const

pure virtual

LinearModel variables (only used in 4DVar)

Implemented in oops::IdentityLinearModel< MODEL >, qg::TlmQG, and lorenz95::TLML95.

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

generic/LinearModelBase.h

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Detailed Description

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

Member Typedef Documentation

◆ Increment_

◆ ModelAuxCtl_

◆ ModelAuxInc_

◆ State_

Constructor & Destructor Documentation

◆ LinearModelBase()

◆ ~LinearModelBase()

Member Function Documentation

◆ classname()

◆ finalizeAD()

◆ finalizeTL()

◆ initializeAD()

◆ initializeTL()

◆ print()

◆ setTrajectory()

◆ stepAD()

◆ stepTL()

◆ timeResolution()

◆ variables()

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