Abstract linear forecast model used by high level algorithms and applications. More...

#include <LinearModel.h>

Inheritance diagram for oops::LinearModel< MODEL >:

[legend]

Collaboration diagram for oops::LinearModel< MODEL >:

[legend]

Public Member Functions
	LinearModel (const Geometry_ &, const LinearModelParametersBase &)

	LinearModel (const Geometry_ &, const eckit::Configuration &)

virtual	~LinearModel ()

void	forecastTL (Increment_ &dx, const ModelAuxInc_ &, const util::Duration &len, PostProcessor< Increment_ > post=PostProcessor< Increment_ >(), PostProcessorTLAD< MODEL > cost=PostProcessorTLAD< MODEL >(), const bool idmodel=false) const
	Run the linear forecast from increment `dx` for `len` time, with `post` postprocessors. Does not need to be implemented in the subclasses of LinearModelBase. More...

void	forecastAD (Increment_ &dx, ModelAuxInc_ &, const util::Duration &len, PostProcessor< Increment_ > post=PostProcessor< Increment_ >(), PostProcessorTLAD< MODEL > cost=PostProcessorTLAD< MODEL >(), const bool idmodel=false) const
	Run the adjoint linear forecast from increment `dx` for `len` -time, with `post` postprocessors. Note that the clock ticks backwards. Does not need to be implemented in the subclasses of LinearModelBase. More...

void	setTrajectory (const State_ &, State_ &, const ModelAuxCtl_ &)
	Set the trajectory for the linear model. More...

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

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

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

Private Types
typedef LinearModelBase< MODEL >	LinearModelBase_

typedef Geometry< MODEL >	Geometry_

typedef Increment< MODEL >	Increment_

typedef ModelAuxControl< MODEL >	ModelAuxCtl_

typedef ModelAuxIncrement< MODEL >	ModelAuxInc_

typedef State< MODEL >	State_

Private Member Functions
void	initializeTL (Increment_ &) const
	Tangent linear forecast initialization, called before every run. More...

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

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

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

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

void	finalizeAD (Increment_ &) const
	Adjoint forecast finalization; called after each run. More...

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

Private Attributes
std::unique_ptr< LinearModelBase_ >	linearmodel_
	Pointer to the LinearModel implementation. More...

Detailed Description

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

Abstract linear forecast model used by high level algorithms and applications.

Note: to see methods that need to be implemented in a generic linear forecast model implementation, see LinearModelBase class in generic/LinearModelBase.h. To see methods that need to be implemented in a MODEL-specific linear forecast model implementation, see interface::LinearModelBase class in interface/LinearModelBase.h.

Definition at line 45 of file oops/base/LinearModel.h.

Member Typedef Documentation

◆ Geometry_

template<typename MODEL >

typedef Geometry<MODEL> oops::LinearModel< MODEL >::Geometry_

private

Definition at line 49 of file oops/base/LinearModel.h.

◆ Increment_

template<typename MODEL >

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

private

Definition at line 50 of file oops/base/LinearModel.h.

◆ LinearModelBase_

template<typename MODEL >

typedef LinearModelBase<MODEL> oops::LinearModel< MODEL >::LinearModelBase_

private

Definition at line 48 of file oops/base/LinearModel.h.

◆ ModelAuxCtl_

template<typename MODEL >

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

private

Definition at line 51 of file oops/base/LinearModel.h.

◆ ModelAuxInc_

template<typename MODEL >

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

private

Definition at line 52 of file oops/base/LinearModel.h.

◆ State_

template<typename MODEL >

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

private

Definition at line 53 of file oops/base/LinearModel.h.

Constructor & Destructor Documentation

◆ LinearModel() [1/2]

template<typename MODEL >

oops::LinearModel< MODEL >::LinearModel	(	const Geometry_ &	resol,
		const LinearModelParametersBase &	params
	)

Definition at line 112 of file oops/base/LinearModel.h.

Here is the call graph for this function:

◆ LinearModel() [2/2]

template<typename MODEL >

oops::LinearModel< MODEL >::LinearModel	(	const Geometry_ &	resol,
		const eckit::Configuration &	conf
	)

Definition at line 125 of file oops/base/LinearModel.h.

◆ ~LinearModel()

template<typename MODEL >

oops::LinearModel< MODEL >::~LinearModel

virtual

Definition at line 133 of file oops/base/LinearModel.h.

Member Function Documentation

◆ classname()

template<typename MODEL >

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

inlinestatic

Definition at line 56 of file oops/base/LinearModel.h.

Here is the caller graph for this function:

◆ finalizeAD()

template<typename MODEL >

void oops::LinearModel< MODEL >::finalizeAD ( Increment_ & dx ) const

private

Adjoint forecast finalization; called after each run.

Definition at line 273 of file oops/base/LinearModel.h.

◆ finalizeTL()

template<typename MODEL >

void oops::LinearModel< MODEL >::finalizeTL ( Increment_ & dx ) const

private

Tangent linear forecast finalization; called after each run.

Definition at line 243 of file oops/base/LinearModel.h.

◆ forecastAD()

template<typename MODEL >

void oops::LinearModel< MODEL >::forecastAD	(	Increment_ &	dx,
		ModelAuxInc_ &	maux,
		const util::Duration &	len,
		PostProcessor< Increment_ >	post = `PostProcessor<Increment_>()`,
		PostProcessorTLAD< MODEL >	cost = `PostProcessorTLAD<MODEL>()`,
		const bool	idmodel = `false`
	)		const

Run the adjoint linear forecast from increment dx for len -time, with post postprocessors. Note that the clock ticks backwards. Does not need to be implemented in the subclasses of LinearModelBase.

Definition at line 183 of file oops/base/LinearModel.h.

Here is the call graph for this function:

◆ forecastTL()

template<typename MODEL >

void oops::LinearModel< MODEL >::forecastTL	(	Increment_ &	dx,
		const ModelAuxInc_ &	maux,
		const util::Duration &	len,
		PostProcessor< Increment_ >	post = `PostProcessor<Increment_>()`,
		PostProcessorTLAD< MODEL >	cost = `PostProcessorTLAD<MODEL>()`,
		const bool	idmodel = `false`
	)		const

Run the linear forecast from increment dx for len time, with post postprocessors. Does not need to be implemented in the subclasses of LinearModelBase.

Definition at line 143 of file oops/base/LinearModel.h.

Here is the call graph for this function:

◆ initializeAD()

template<typename MODEL >

void oops::LinearModel< MODEL >::initializeAD ( Increment_ & dx ) const

private

Adjoint forecast initialization, called before every run.

Definition at line 253 of file oops/base/LinearModel.h.

◆ initializeTL()

template<typename MODEL >

void oops::LinearModel< MODEL >::initializeTL ( Increment_ & dx ) const

private

Tangent linear forecast initialization, called before every run.

Definition at line 223 of file oops/base/LinearModel.h.

◆ print()

template<typename MODEL >

void oops::LinearModel< MODEL >::print ( std::ostream & os ) const

private

Print, used in logging.

Definition at line 283 of file oops/base/LinearModel.h.

◆ setTrajectory()

template<typename MODEL >

void oops::LinearModel< MODEL >::setTrajectory	(	const State_ &	xx,
		State_ &	xtraj,
		const ModelAuxCtl_ &	maux
	)

Set the trajectory for the linear model.

Definition at line 293 of file oops/base/LinearModel.h.

◆ stepAD()

template<typename MODEL >

void oops::LinearModel< MODEL >::stepAD	(	Increment_ &	dx,
		ModelAuxInc_ &	maux
	)		const

private

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

Definition at line 263 of file oops/base/LinearModel.h.

◆ stepTL()

template<typename MODEL >

void oops::LinearModel< MODEL >::stepTL	(	Increment_ &	dx,
		const ModelAuxInc_ &	maux
	)		const

private

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

Definition at line 233 of file oops/base/LinearModel.h.

◆ timeResolution()

template<typename MODEL >

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

inline

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

Definition at line 84 of file oops/base/LinearModel.h.

◆ variables()

template<typename MODEL >

const oops::Variables& oops::LinearModel< MODEL >::variables ( ) const

inline

LinearModel variables (only used in 4DVar)

Definition at line 86 of file oops/base/LinearModel.h.

Member Data Documentation

◆ linearmodel_

template<typename MODEL >

std::unique_ptr<LinearModelBase_> oops::LinearModel< MODEL >::linearmodel_

private

Pointer to the LinearModel implementation.

Definition at line 106 of file oops/base/LinearModel.h.

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

oops/base/LinearModel.h

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ Geometry_

◆ Increment_

◆ LinearModelBase_

◆ ModelAuxCtl_

◆ ModelAuxInc_

◆ State_

Constructor & Destructor Documentation

◆ LinearModel() [1/2]

◆ LinearModel() [2/2]

◆ ~LinearModel()

Member Function Documentation

◆ classname()

◆ finalizeAD()

◆ finalizeTL()

◆ forecastAD()

◆ forecastTL()

◆ initializeAD()

◆ initializeTL()

◆ print()

◆ setTrajectory()

◆ stepAD()

◆ stepTL()

◆ timeResolution()

◆ variables()

Member Data Documentation

◆ linearmodel_

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