FV3 Bundle
fv3jedi::TlmIdFV3JEDI Class Reference

FV3JEDI linear identity model definition. More...

#include <TlmIdFV3JEDI.h>

Inheritance diagram for fv3jedi::TlmIdFV3JEDI:
[legend]
Collaboration diagram for fv3jedi::TlmIdFV3JEDI:
[legend]

Public Member Functions

 TlmIdFV3JEDI (const GeometryFV3JEDI &, const eckit::Configuration &)
 
 ~TlmIdFV3JEDI ()
 
void setTrajectory (const StateFV3JEDI &, StateFV3JEDI &, const ModelBiasFV3JEDI &) override
 Model trajectory computation. More...
 
void initializeTL (IncrementFV3JEDI &) const override
 Run TLM and its adjoint. More...
 
void stepTL (IncrementFV3JEDI &, const ModelBiasIncrementFV3JEDI &) const override
 
void finalizeTL (IncrementFV3JEDI &) const override
 
void initializeAD (IncrementFV3JEDI &) const override
 
void stepAD (IncrementFV3JEDI &, ModelBiasIncrementFV3JEDI &) const override
 
void finalizeAD (IncrementFV3JEDI &) const override
 
const util::Duration & timeResolution () const override
 Other utilities. More...
 
const GeometryFV3JEDIresolution () const
 
const oops::Variablesvariables () const override
 
- Public Member Functions inherited from oops::LinearModelBase< FV3JEDITraits >
 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< FV3JEDITraits >
static const std::string classname ()
 

Private Member Functions

void print (std::ostream &) const override
 

Private Attributes

int keyConfig_
 
util::Duration tstep_
 
const GeometryFV3JEDI resol_
 
const oops::Variables linvars_
 

Additional Inherited Members

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

Detailed Description

FV3JEDI linear identity model definition.

FV3JEDI linear identity model definition and configuration parameters.

Definition at line 36 of file TlmIdFV3JEDI.h.

Constructor & Destructor Documentation

◆ TlmIdFV3JEDI()

fv3jedi::TlmIdFV3JEDI::TlmIdFV3JEDI ( const GeometryFV3JEDI resol,
const eckit::Configuration &  tlConf 
)

Definition at line 29 of file TlmIdFV3JEDI.cc.

◆ ~TlmIdFV3JEDI()

fv3jedi::TlmIdFV3JEDI::~TlmIdFV3JEDI ( )

Definition at line 45 of file TlmIdFV3JEDI.cc.

Here is the call graph for this function:

Member Function Documentation

◆ classname()

static const std::string fv3jedi::TlmIdFV3JEDI::classname ( )
inlinestatic

Definition at line 39 of file TlmIdFV3JEDI.h.

◆ finalizeAD()

void fv3jedi::TlmIdFV3JEDI::finalizeAD ( IncrementFV3JEDI dx) const
override

Definition at line 75 of file TlmIdFV3JEDI.cc.

◆ finalizeTL()

void fv3jedi::TlmIdFV3JEDI::finalizeTL ( IncrementFV3JEDI dx) const
override

Definition at line 62 of file TlmIdFV3JEDI.cc.

◆ initializeAD()

void fv3jedi::TlmIdFV3JEDI::initializeAD ( IncrementFV3JEDI dx) const
override

Definition at line 66 of file TlmIdFV3JEDI.cc.

◆ initializeTL()

void fv3jedi::TlmIdFV3JEDI::initializeTL ( IncrementFV3JEDI dx) const
override

Run TLM and its adjoint.

Definition at line 53 of file TlmIdFV3JEDI.cc.

◆ print()

void fv3jedi::TlmIdFV3JEDI::print ( std::ostream &  os) const
overrideprivatevirtual

Implements oops::LinearModelBase< FV3JEDITraits >.

Definition at line 79 of file TlmIdFV3JEDI.cc.

◆ resolution()

const GeometryFV3JEDI& fv3jedi::TlmIdFV3JEDI::resolution ( ) const
inline

Definition at line 61 of file TlmIdFV3JEDI.h.

◆ setTrajectory()

void fv3jedi::TlmIdFV3JEDI::setTrajectory ( const StateFV3JEDI ,
StateFV3JEDI ,
const ModelBiasFV3JEDI  
)
override

Model trajectory computation.

Definition at line 50 of file TlmIdFV3JEDI.cc.

◆ stepAD()

void fv3jedi::TlmIdFV3JEDI::stepAD ( IncrementFV3JEDI dx,
ModelBiasIncrementFV3JEDI  
) const
override

Definition at line 70 of file TlmIdFV3JEDI.cc.

Here is the call graph for this function:

◆ stepTL()

void fv3jedi::TlmIdFV3JEDI::stepTL ( IncrementFV3JEDI dx,
const ModelBiasIncrementFV3JEDI  
) const
override

Definition at line 57 of file TlmIdFV3JEDI.cc.

Here is the call graph for this function:

◆ timeResolution()

const util::Duration& fv3jedi::TlmIdFV3JEDI::timeResolution ( ) const
inlineoverridevirtual

Other utilities.

Implements oops::LinearModelBase< FV3JEDITraits >.

Definition at line 60 of file TlmIdFV3JEDI.h.

◆ variables()

const oops::Variables& fv3jedi::TlmIdFV3JEDI::variables ( ) const
inlineoverridevirtual

Implements oops::LinearModelBase< FV3JEDITraits >.

Definition at line 62 of file TlmIdFV3JEDI.h.

Member Data Documentation

◆ keyConfig_

int fv3jedi::TlmIdFV3JEDI::keyConfig_
private

Definition at line 68 of file TlmIdFV3JEDI.h.

◆ linvars_

const oops::Variables fv3jedi::TlmIdFV3JEDI::linvars_
private

Definition at line 71 of file TlmIdFV3JEDI.h.

◆ resol_

const GeometryFV3JEDI fv3jedi::TlmIdFV3JEDI::resol_
private

Definition at line 70 of file TlmIdFV3JEDI.h.

◆ tstep_

util::Duration fv3jedi::TlmIdFV3JEDI::tstep_
private

Definition at line 69 of file TlmIdFV3JEDI.h.


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