Base class for MODEL-specific implementations of the LinearModel interface. interface::LinearModelBase overrides oops::LinearModelBase methods to pass MODEL-specific implementations of State, Increment and ModelAuxIncrement to the MODEL-specific implementation of LinearModel. More...

#include <LinearModelBase.h>

Inheritance diagram for oops::interface::LinearModelBase< MODEL >:

[legend]

Collaboration diagram for oops::interface::LinearModelBase< MODEL >:

[legend]

Public Member Functions
	LinearModelBase ()=default

virtual	~LinearModelBase ()=default

void	initializeTL (oops::Increment< MODEL > &dx) const final

void	stepTL (oops::Increment< MODEL > &dx, const ModelAuxIncrement< MODEL > &modelaux) const final
	Tangent linear "step", called during run; updates increment to the next time. More...

void	finalizeTL (oops::Increment< MODEL > &dx) const final
	Tangent linear finalization; called after each run. More...

void	initializeAD (oops::Increment< MODEL > &dx) const final
	Tangent linear initialization, called before every run. More...

void	stepAD (oops::Increment< MODEL > &dx, ModelAuxIncrement< MODEL > &modelaux) const final
	Tangent linear "step", called during run; updates increment to the next time. More...

void	finalizeAD (oops::Increment< MODEL > &dx) const final
	Tangent linear finalization; called after each run. More...

void	setTrajectory (const oops::State< MODEL > &xx, oops::State< MODEL > &xxtraj, const ModelAuxControl< MODEL > &modelaux) final
	Set the trajectory for the linear model, called after each step of the forecast. More...

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

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

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

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

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

virtual void	finalizeAD (Increment_ &) const =0
	Adjoint forecast 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. The incoming State is output from the nonlinear forecast. The adjustable State is interpolated to the resolution of the linear model. More...

void	print (std::ostream &) const =0
	Print, used in logging. More...

Public Member Functions inherited from oops::LinearModelBase< MODEL >
	LinearModelBase ()=default

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 ()

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

Private Types
typedef MODEL::Increment	Increment_

typedef MODEL::ModelAuxControl	ModelAuxCtl_

typedef MODEL::ModelAuxIncrement	ModelAuxInc_

typedef MODEL::State	State_

Detailed Description

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

Base class for MODEL-specific implementations of the LinearModel interface. interface::LinearModelBase overrides oops::LinearModelBase methods to pass MODEL-specific implementations of State, Increment and ModelAuxIncrement to the MODEL-specific implementation of LinearModel.

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 50 of file interface/LinearModelBase.h.

Member Typedef Documentation

◆ Increment_

template<typename MODEL >

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

private

Definition at line 51 of file interface/LinearModelBase.h.

◆ ModelAuxCtl_

template<typename MODEL >

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

private

Definition at line 52 of file interface/LinearModelBase.h.

◆ ModelAuxInc_

template<typename MODEL >

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

private

Definition at line 53 of file interface/LinearModelBase.h.

◆ State_

template<typename MODEL >

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

private

Definition at line 54 of file interface/LinearModelBase.h.

Constructor & Destructor Documentation

◆ LinearModelBase()

template<typename MODEL >

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

default

◆ ~LinearModelBase()

template<typename MODEL >

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

virtualdefault

Reimplemented from oops::LinearModelBase< MODEL >.

Member Function Documentation

◆ classname()

template<typename MODEL >

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

inlinestatic

Definition at line 57 of file interface/LinearModelBase.h.

◆ finalizeAD() [1/2]

template<typename MODEL >

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

pure virtual

Adjoint forecast finalization; called after each run.

Implements oops::LinearModelBase< MODEL >.

◆ finalizeAD() [2/2]

template<typename MODEL >

void oops::interface::LinearModelBase< MODEL >::finalizeAD ( oops::Increment< MODEL > & ) const

inlinefinalvirtual

Tangent linear finalization; called after each run.

Implements oops::LinearModelBase< MODEL >.

Definition at line 75 of file interface/LinearModelBase.h.

◆ finalizeTL() [1/2]

template<typename MODEL >

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

pure virtual

Tangent linear forecast finalization; called after each run.

Implements oops::LinearModelBase< MODEL >.

◆ finalizeTL() [2/2]

template<typename MODEL >

void oops::interface::LinearModelBase< MODEL >::finalizeTL ( oops::Increment< MODEL > & ) const

inlinefinalvirtual

Tangent linear finalization; called after each run.

Implements oops::LinearModelBase< MODEL >.

Definition at line 68 of file interface/LinearModelBase.h.

◆ initializeAD() [1/2]

template<typename MODEL >

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

pure virtual

Adjoint forecast initialization, called before every run.

Implements oops::LinearModelBase< MODEL >.

◆ initializeAD() [2/2]

template<typename MODEL >

void oops::interface::LinearModelBase< MODEL >::initializeAD ( oops::Increment< MODEL > & ) const

inlinefinalvirtual

Tangent linear initialization, called before every run.

Implements oops::LinearModelBase< MODEL >.

Definition at line 71 of file interface/LinearModelBase.h.

◆ initializeTL() [1/2]

template<typename MODEL >

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

pure virtual

Tangent linear forecast initialization, called before every run.

Implements oops::LinearModelBase< MODEL >.

◆ initializeTL() [2/2]

template<typename MODEL >

void oops::interface::LinearModelBase< MODEL >::initializeTL ( oops::Increment< MODEL > & dx ) const

inlinefinalvirtual

Overrides for oops::LinearModelBase classes, passing MODEL-specific classes to the MODEL-specific implementations of LinearModel

Implements oops::LinearModelBase< MODEL >.

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

◆ print()

template<typename MODEL >

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

pure virtual

Print, used in logging.

Implements oops::LinearModelBase< MODEL >.

Implemented in qg::TlmQG, and lorenz95::TLML95.

◆ setTrajectory() [1/2]

template<typename MODEL >

void oops::interface::LinearModelBase< MODEL >::setTrajectory	(	const oops::State< MODEL > &	,
		oops::State< MODEL > &	,
		const ModelAuxControl< MODEL > &
	)

inlinefinalvirtual

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

Implements oops::LinearModelBase< MODEL >.

Definition at line 78 of file interface/LinearModelBase.h.

◆ setTrajectory() [2/2]

template<typename MODEL >

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

pure virtual

Set the trajectory for the linear model, called after each step of the forecast. The incoming State is output from the nonlinear forecast. The adjustable State is interpolated to the resolution of the linear model.

Implements oops::LinearModelBase< MODEL >.

◆ stepAD() [1/2]

template<typename MODEL >

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

pure virtual

Adjoint forecast "step", called during run; updates increment to the previous time.

Implements oops::LinearModelBase< MODEL >.

◆ stepAD() [2/2]

template<typename MODEL >

void oops::interface::LinearModelBase< MODEL >::stepAD	(	oops::Increment< MODEL > &	,
		ModelAuxIncrement< MODEL > &
	)		const

inlinefinalvirtual

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

Implements oops::LinearModelBase< MODEL >.

Definition at line 73 of file interface/LinearModelBase.h.

◆ stepTL() [1/2]

template<typename MODEL >

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

pure virtual

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

Implements oops::LinearModelBase< MODEL >.

◆ stepTL() [2/2]

template<typename MODEL >

void oops::interface::LinearModelBase< MODEL >::stepTL	(	oops::Increment< MODEL > &	,
		const ModelAuxIncrement< MODEL > &
	)		const

inlinefinalvirtual

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

Implements oops::LinearModelBase< MODEL >.

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

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

interface/LinearModelBase.h

Public Member Functions

Static Public Member Functions

Private Types

Detailed Description

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

Member Typedef Documentation

◆ Increment_

◆ ModelAuxCtl_

◆ ModelAuxInc_

◆ State_

Constructor & Destructor Documentation

◆ LinearModelBase()

◆ ~LinearModelBase()

Member Function Documentation

◆ classname()

◆ finalizeAD() [1/2]

◆ finalizeAD() [2/2]

◆ finalizeTL() [1/2]

◆ finalizeTL() [2/2]

◆ initializeAD() [1/2]

◆ initializeAD() [2/2]

◆ initializeTL() [1/2]

◆ initializeTL() [2/2]

◆ print()

◆ setTrajectory() [1/2]

◆ setTrajectory() [2/2]

◆ stepAD() [1/2]

◆ stepAD() [2/2]

◆ stepTL() [1/2]

◆ stepTL() [2/2]

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