Encapsulates the linear forecast model. More...

#include <LinearModelId.h>

Inheritance diagram for oops::LinearModelId< MODEL >:

Collaboration diagram for oops::LinearModelId< MODEL >:

Public Member Functions
	LinearModelId (const Geometry_ &, const eckit::Configuration &)

	~LinearModelId ()

void	setTrajectory (const State_ &, State_ &, const ModelAux_ &) override

void	initializeTL (Increment_ &) const override

void	stepTL (Increment_ &dx, const ModelAuxIncr_ &) const override

void	finalizeTL (Increment_ &) const override

void	initializeAD (Increment_ &) const override

void	stepAD (Increment_ &dx, ModelAuxIncr_ &) const override

void	finalizeAD (Increment_ &) const override

const util::Duration &	timeResolution () const override

const oops::Variables &	variables () const override

void	print (std::ostream &) const override

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

virtual	~LinearModelBase ()

void	setTrajectory (const State_ &, State_ &, const ModelAux_ &)

void	initializeTL (Increment_ &) const

void	stepTL (Increment_ &, const ModelAuxIncr_ &) const

void	finalizeTL (Increment_ &) const

void	initializeAD (Increment_ &) const

void	stepAD (Increment_ &, ModelAuxIncr_ &) const

void	finalizeAD (Increment_ &) const

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::Geometry	Geometry_

typedef MODEL::ModelAuxControl	ModelAux_

typedef MODEL::ModelAuxIncrement	ModelAuxIncr_

typedef MODEL::State	State_

Private Attributes
const Geometry_	resol_

const util::Duration	tstep_

const Variables	vars_

Additional Inherited Members
Protected Member Functions inherited from oops::LinearModelBase< MODEL >
virtual void	setTrajectory (const typename MODEL::State &, typename MODEL::State &, const typename MODEL::ModelAuxControl &)=0

virtual void	initializeTL (typename MODEL::Increment &) const =0

virtual void	stepTL (typename MODEL::Increment &, const typename MODEL::ModelAuxIncrement &) const =0

virtual void	finalizeTL (typename MODEL::Increment &) const =0

virtual void	initializeAD (typename MODEL::Increment &) const =0

virtual void	stepAD (typename MODEL::Increment &, typename MODEL::ModelAuxIncrement &) const =0

virtual void	finalizeAD (typename MODEL::Increment &) const =0

Detailed Description

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

Encapsulates the linear forecast model.

Generic implementation of the identity linear model.

Definition at line 44 of file LinearModelId.h.

Member Typedef Documentation

◆ Geometry_

template<typename MODEL >

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

private

Definition at line 46 of file LinearModelId.h.

◆ Increment_

template<typename MODEL >

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

private

Definition at line 45 of file LinearModelId.h.

◆ ModelAux_

template<typename MODEL >

typedef MODEL::ModelAuxControl oops::LinearModelId< MODEL >::ModelAux_

private

Definition at line 47 of file LinearModelId.h.

◆ ModelAuxIncr_

template<typename MODEL >

typedef MODEL::ModelAuxIncrement oops::LinearModelId< MODEL >::ModelAuxIncr_

private

Definition at line 48 of file LinearModelId.h.

◆ State_

template<typename MODEL >

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

private

Definition at line 49 of file LinearModelId.h.

Constructor & Destructor Documentation

◆ LinearModelId()

template<typename MODEL >

oops::LinearModelId< MODEL >::LinearModelId	(	const Geometry_ &	resol,
		const eckit::Configuration &	tlConf
	)

Definition at line 84 of file LinearModelId.h.

◆ ~LinearModelId()

template<typename MODEL >

oops::LinearModelId< MODEL >::~LinearModelId ( )

Definition at line 94 of file LinearModelId.h.

Member Function Documentation

◆ classname()

template<typename MODEL >

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

inlinestatic

Definition at line 52 of file LinearModelId.h.

◆ finalizeAD()

template<typename MODEL >

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

override

Definition at line 151 of file LinearModelId.h.

Here is the call graph for this function:

◆ finalizeTL()

template<typename MODEL >

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

override

Definition at line 126 of file LinearModelId.h.

Here is the call graph for this function:

◆ initializeAD()

template<typename MODEL >

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

override

Definition at line 134 of file LinearModelId.h.

Here is the call graph for this function:

◆ initializeTL()

template<typename MODEL >

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

override

Definition at line 109 of file LinearModelId.h.

Here is the call graph for this function:

◆ print()

template<typename MODEL >

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

inlineoverridevirtual

Implements oops::LinearModelBase< MODEL >.

Definition at line 73 of file LinearModelId.h.

◆ setTrajectory()

template<typename MODEL >

void oops::LinearModelId< MODEL >::setTrajectory	(	const State_ &	xx,
		State_ &	xlr,
		const ModelAux_ &	maux
	)

override

Definition at line 101 of file LinearModelId.h.

◆ stepAD()

template<typename MODEL >

void oops::LinearModelId< MODEL >::stepAD	(	Increment_ &	dx,
		ModelAuxIncr_ &	merr
	)		const

override

Definition at line 142 of file LinearModelId.h.

Here is the call graph for this function:

◆ stepTL()

template<typename MODEL >

void oops::LinearModelId< MODEL >::stepTL	(	Increment_ &	dx,
		const ModelAuxIncr_ &	merr
	)		const

override

Definition at line 117 of file LinearModelId.h.

Here is the call graph for this function:

◆ timeResolution()

template<typename MODEL >

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

inlineoverridevirtual

Implements oops::LinearModelBase< MODEL >.

Definition at line 71 of file LinearModelId.h.

◆ variables()

template<typename MODEL >

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

inlineoverridevirtual

Implements oops::LinearModelBase< MODEL >.

Definition at line 72 of file LinearModelId.h.

Member Data Documentation

◆ resol_

template<typename MODEL >

const Geometry_ oops::LinearModelId< MODEL >::resol_

private

Definition at line 76 of file LinearModelId.h.

◆ tstep_

template<typename MODEL >

const util::Duration oops::LinearModelId< MODEL >::tstep_

private

Definition at line 77 of file LinearModelId.h.

◆ vars_

template<typename MODEL >

const Variables oops::LinearModelId< MODEL >::vars_

private

Definition at line 78 of file LinearModelId.h.

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

LinearModelId.h

Public Member Functions

Static Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ Geometry_

◆ Increment_

◆ ModelAux_

◆ ModelAuxIncr_

◆ State_

Constructor & Destructor Documentation

◆ LinearModelId()

◆ ~LinearModelId()

Member Function Documentation

◆ classname()

◆ finalizeAD()

◆ finalizeTL()

◆ initializeAD()

◆ initializeTL()

◆ print()

◆ setTrajectory()

◆ stepAD()

◆ stepTL()

◆ timeResolution()

◆ variables()

Member Data Documentation

◆ resol_

◆ tstep_

◆ vars_

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