Lorenz 95 linear model definition. More...

#include <TLML95.h>

Inheritance diagram for lorenz95::TLML95:

[legend]

Collaboration diagram for lorenz95::TLML95:

[legend]

Public Types
typedef TLML95Parameters	Parameters_

Public Member Functions
	TLML95 (const Resolution &, const Parameters_ &)

	~TLML95 ()

void	setTrajectory (const StateL95 &, StateL95 &, const ModelBias &) override
	Model trajectory computation. More...

void	initializeTL (IncrementL95 &) const override
	Run TLM and its adjoint. More...

void	stepTL (IncrementL95 &, const ModelBiasCorrection &) const override

void	finalizeTL (IncrementL95 &) const override

void	initializeAD (IncrementL95 &) const override

void	stepAD (IncrementL95 &, ModelBiasCorrection &) const override

void	finalizeAD (IncrementL95 &) const override

const util::Duration &	timeResolution () const override
	Other utilities. More...

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

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

virtual	~LinearModelBase ()=default

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

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

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

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

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

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

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

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

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

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

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

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

void	setTrajectory (const oops::State< L95Traits > &xx, oops::State< L95Traits > &xxtraj, const ModelAuxControl< L95Traits > &modelaux) final
	Set the trajectory for the linear model, called after each step of the forecast. 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...

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

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

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

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

Private Types
typedef std::map< util::DateTime, ModelTrajectory * >::iterator	trajIter

typedef std::map< util::DateTime, ModelTrajectory * >::const_iterator	trajICst

Private Member Functions
const ModelTrajectory *	getTrajectory (const util::DateTime &) const

void	tendenciesTL (const FieldL95 &, const double &, const FieldL95 &, FieldL95 &) const

void	tendenciesAD (FieldL95 &, double &, const FieldL95 &, const FieldL95 &) const

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

Private Attributes
const Resolution	resol_

const util::Duration	tstep_

const double	dt_

std::map< util::DateTime, ModelTrajectory * >	traj_

const ModelL95	lrmodel_

const oops::Variables	vars_

Detailed Description

Lorenz 95 linear model definition.

Definition at line 58 of file TLML95.h.

Member Typedef Documentation

◆ Parameters_

typedef TLML95Parameters lorenz95::TLML95::Parameters_

Definition at line 61 of file TLML95.h.

◆ trajICst

typedef std::map< util::DateTime, ModelTrajectory * >::const_iterator lorenz95::TLML95::trajICst

private

Definition at line 91 of file TLML95.h.

◆ trajIter

typedef std::map< util::DateTime, ModelTrajectory * >::iterator lorenz95::TLML95::trajIter

private

Definition at line 90 of file TLML95.h.

Constructor & Destructor Documentation

◆ TLML95()

lorenz95::TLML95::TLML95	(	const Resolution &	resol,
		const Parameters_ &	params
	)

Definition at line 36 of file TLML95.cc.

◆ ~TLML95()

lorenz95::TLML95::~TLML95 ( )

Definition at line 46 of file TLML95.cc.

Member Function Documentation

◆ classname()

static const std::string lorenz95::TLML95::classname ( )

inlinestatic

Definition at line 63 of file TLML95.h.

◆ finalizeAD()

void lorenz95::TLML95::finalizeAD ( IncrementL95 & ) const

override

Definition at line 76 of file TLML95.cc.

◆ finalizeTL()

void lorenz95::TLML95::finalizeTL ( IncrementL95 & ) const

override

Definition at line 74 of file TLML95.cc.

◆ getTrajectory()

const ModelTrajectory * lorenz95::TLML95::getTrajectory ( const util::DateTime & tt ) const

private

Definition at line 62 of file TLML95.cc.

Here is the caller graph for this function:

◆ initializeAD()

void lorenz95::TLML95::initializeAD ( IncrementL95 & ) const

override

Definition at line 75 of file TLML95.cc.

◆ initializeTL()

void lorenz95::TLML95::initializeTL ( IncrementL95 & ) const

override

Run TLM and its adjoint.

Definition at line 73 of file TLML95.cc.

◆ print()

void lorenz95::TLML95::print ( std::ostream & ) const

overrideprivatevirtual

Print, used in logging.

Implements oops::interface::LinearModelBase< L95Traits >.

Definition at line 188 of file TLML95.cc.

◆ setTrajectory()

void lorenz95::TLML95::setTrajectory	(	const StateL95 &	xx,
		StateL95 &	,
		const ModelBias &	bias
	)

override

Model trajectory computation.

Definition at line 53 of file TLML95.cc.

Here is the call graph for this function:

◆ stepAD()

void lorenz95::TLML95::stepAD	(	IncrementL95 &	xx,
		ModelBiasCorrection &	bias
	)		const

override

Definition at line 108 of file TLML95.cc.

Here is the call graph for this function:

◆ stepTL()

void lorenz95::TLML95::stepTL	(	IncrementL95 &	xx,
		const ModelBiasCorrection &	bias
	)		const

override

Definition at line 78 of file TLML95.cc.

Here is the call graph for this function:

◆ tendenciesAD()

void lorenz95::TLML95::tendenciesAD	(	FieldL95 &	xx,
		double &	bias,
		const FieldL95 &	xtraj,
		const FieldL95 &	dx
	)		const

private

Definition at line 164 of file TLML95.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tendenciesTL()

void lorenz95::TLML95::tendenciesTL	(	const FieldL95 &	xx,
		const double &	bias,
		const FieldL95 &	xtraj,
		FieldL95 &	dx
	)		const

private

Definition at line 147 of file TLML95.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ timeResolution()

const util::Duration& lorenz95::TLML95::timeResolution ( ) const

inlineoverridevirtual

Other utilities.

Implements oops::LinearModelBase< MODEL >.

Definition at line 81 of file TLML95.h.

◆ variables()

const oops::Variables& lorenz95::TLML95::variables ( ) const

inlineoverridevirtual

LinearModel variables (only used in 4DVar)

Implements oops::LinearModelBase< MODEL >.

Definition at line 82 of file TLML95.h.

Member Data Documentation

◆ dt_

const double lorenz95::TLML95::dt_

private

Definition at line 96 of file TLML95.h.

◆ lrmodel_

const ModelL95 lorenz95::TLML95::lrmodel_

private

Definition at line 98 of file TLML95.h.

◆ resol_

const Resolution lorenz95::TLML95::resol_

private

Definition at line 94 of file TLML95.h.

◆ traj_

std::map< util::DateTime, ModelTrajectory * > lorenz95::TLML95::traj_

private

Definition at line 97 of file TLML95.h.

◆ tstep_

const util::Duration lorenz95::TLML95::tstep_

private

Definition at line 95 of file TLML95.h.

◆ vars_

const oops::Variables lorenz95::TLML95::vars_

private

Definition at line 99 of file TLML95.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Parameters_

◆ trajICst

◆ trajIter

Constructor & Destructor Documentation

◆ TLML95()

◆ ~TLML95()

Member Function Documentation

◆ classname()

◆ finalizeAD()

◆ finalizeTL()

◆ getTrajectory()

◆ initializeAD()

◆ initializeTL()

◆ print()

◆ setTrajectory()

◆ stepAD()

◆ stepTL()

◆ tendenciesAD()

◆ tendenciesTL()

◆ timeResolution()

◆ variables()

Member Data Documentation

◆ dt_

◆ lrmodel_

◆ resol_

◆ traj_

◆ tstep_

◆ vars_