FV3 Bundle
lorenz95::TLML95 Class Reference

Lorenz 95 linear model definition. More...

#include <TLML95.h>

Inheritance diagram for lorenz95::TLML95:
[legend]
Collaboration diagram for lorenz95::TLML95:
[legend]

Public Member Functions

 TLML95 (const Resolution &, const eckit::Configuration &)
 
 ~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 Resolutionresolution () const
 
const oops::Variablesvariables () const
 
- Public Member Functions inherited from oops::LinearModelBase< L95Traits >
 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< L95Traits >
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 ModelTrajectorygetTrajectory (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
 

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_
 

Additional Inherited Members

- Protected Member Functions inherited from oops::LinearModelBase< L95Traits >
virtual void setTrajectory (const typename L95Traits ::State &, typename L95Traits ::State &, const typename L95Traits ::ModelAuxControl &)=0
 
virtual void initializeTL (typename L95Traits ::Increment &) const=0
 
virtual void stepTL (typename L95Traits ::Increment &, const typename L95Traits ::ModelAuxIncrement &) const=0
 
virtual void finalizeTL (typename L95Traits ::Increment &) const=0
 
virtual void initializeAD (typename L95Traits ::Increment &) const=0
 
virtual void stepAD (typename L95Traits ::Increment &, typename L95Traits ::ModelAuxIncrement &) const=0
 
virtual void finalizeAD (typename L95Traits ::Increment &) const=0
 

Detailed Description

Lorenz 95 linear model definition.

Definition at line 44 of file TLML95.h.

Member Typedef Documentation

◆ trajICst

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

Definition at line 76 of file TLML95.h.

◆ trajIter

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

Definition at line 75 of file TLML95.h.

Constructor & Destructor Documentation

◆ TLML95()

lorenz95::TLML95::TLML95 ( const Resolution resol,
const eckit::Configuration &  tlConf 
)

Definition at line 32 of file src/lorenz95/TLML95.cc.

Here is the call graph for this function:

◆ ~TLML95()

lorenz95::TLML95::~TLML95 ( )

Definition at line 42 of file src/lorenz95/TLML95.cc.

Member Function Documentation

◆ classname()

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

Definition at line 47 of file TLML95.h.

◆ finalizeAD()

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

Definition at line 72 of file src/lorenz95/TLML95.cc.

◆ finalizeTL()

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

Definition at line 70 of file src/lorenz95/TLML95.cc.

◆ getTrajectory()

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

Definition at line 58 of file src/lorenz95/TLML95.cc.

Here is the caller graph for this function:

◆ initializeAD()

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

Definition at line 71 of file src/lorenz95/TLML95.cc.

◆ initializeTL()

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

Run TLM and its adjoint.

Definition at line 69 of file src/lorenz95/TLML95.cc.

◆ print()

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

Implements oops::LinearModelBase< L95Traits >.

Definition at line 176 of file src/lorenz95/TLML95.cc.

◆ resolution()

const Resolution& lorenz95::TLML95::resolution ( ) const
inline

Definition at line 66 of file TLML95.h.

◆ setTrajectory()

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

Model trajectory computation.

Definition at line 49 of file src/lorenz95/TLML95.cc.

Here is the call graph for this function:

◆ stepAD()

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

Definition at line 104 of file src/lorenz95/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 74 of file src/lorenz95/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 155 of file src/lorenz95/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 138 of file src/lorenz95/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< L95Traits >.

Definition at line 65 of file TLML95.h.

◆ variables()

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

Implements oops::LinearModelBase< L95Traits >.

Definition at line 67 of file TLML95.h.

Member Data Documentation

◆ dt_

const double lorenz95::TLML95::dt_
private

Definition at line 81 of file TLML95.h.

◆ lrmodel_

const ModelL95 lorenz95::TLML95::lrmodel_
private

Definition at line 83 of file TLML95.h.

◆ resol_

const Resolution lorenz95::TLML95::resol_
private

Definition at line 79 of file TLML95.h.

◆ traj_

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

Definition at line 82 of file TLML95.h.

◆ tstep_

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

Definition at line 80 of file TLML95.h.

◆ vars_

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

Definition at line 84 of file TLML95.h.


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