FV3 Bundle
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
fv3jedi::TlmFV3JEDI Class Reference

FV3JEDI linear model definition. More...

#include <TlmFV3JEDI.h>

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

Public Member Functions

 TlmFV3JEDI (const GeometryFV3JEDI &, const eckit::Configuration &)
 
 ~TlmFV3JEDI ()
 
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 GeometryFV3JEDI & resolution () const
 
const oops::Variables & variables () 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 Types

typedef std::map< util::DateTime, int >::iterator trajIter
 
typedef std::map< util::DateTime, int >::const_iterator trajICst
 

Private Member Functions

void print (std::ostream &) const override
 

Private Attributes

F90model keyConfig_
 
util::Duration tstep_
 
const GeometryFV3JEDI resol_
 
std::map< util::DateTime, F90traj > traj_
 
const ModelFV3JEDI lrmodel_
 
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 model definition.

FV3JEDI linear model definition and configuration parameters.

Definition at line 39 of file TlmFV3JEDI.h.

Member Typedef Documentation

◆ trajICst

typedef std::map< util::DateTime, int >::const_iterator fv3jedi::TlmFV3JEDI::trajICst
private

Definition at line 69 of file TlmFV3JEDI.h.

◆ trajIter

typedef std::map< util::DateTime, int >::iterator fv3jedi::TlmFV3JEDI::trajIter
private

Definition at line 68 of file TlmFV3JEDI.h.

Constructor & Destructor Documentation

◆ TlmFV3JEDI()

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

Definition at line 31 of file TlmFV3JEDI.cc.

◆ ~TlmFV3JEDI()

fv3jedi::TlmFV3JEDI::~TlmFV3JEDI ( )

Definition at line 47 of file TlmFV3JEDI.cc.

Here is the call graph for this function:

Member Function Documentation

◆ classname()

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

Definition at line 42 of file TlmFV3JEDI.h.

◆ finalizeAD()

void fv3jedi::TlmFV3JEDI::finalizeAD ( IncrementFV3JEDI &  dx) const
override

Definition at line 117 of file TlmFV3JEDI.cc.

Here is the call graph for this function:

◆ finalizeTL()

void fv3jedi::TlmFV3JEDI::finalizeTL ( IncrementFV3JEDI &  dx) const
override

Definition at line 93 of file TlmFV3JEDI.cc.

Here is the call graph for this function:

◆ initializeAD()

void fv3jedi::TlmFV3JEDI::initializeAD ( IncrementFV3JEDI &  dx) const
override

Definition at line 98 of file TlmFV3JEDI.cc.

Here is the call graph for this function:

◆ initializeTL()

void fv3jedi::TlmFV3JEDI::initializeTL ( IncrementFV3JEDI &  dx) const
override

Run TLM and its adjoint.

Definition at line 74 of file TlmFV3JEDI.cc.

Here is the call graph for this function:

◆ print()

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

Implements oops::LinearModelBase< FV3JEDITraits >.

Definition at line 122 of file TlmFV3JEDI.cc.

◆ resolution()

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

Definition at line 63 of file TlmFV3JEDI.h.

◆ setTrajectory()

void fv3jedi::TlmFV3JEDI::setTrajectory ( const StateFV3JEDI &  xx,
StateFV3JEDI &  xlr,
const ModelBiasFV3JEDI &  bias 
)
override

Model trajectory computation.

Definition at line 55 of file TlmFV3JEDI.cc.

Here is the call graph for this function:

◆ stepAD()

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

Definition at line 103 of file TlmFV3JEDI.cc.

Here is the call graph for this function:

◆ stepTL()

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

Definition at line 79 of file TlmFV3JEDI.cc.

Here is the call graph for this function:

◆ timeResolution()

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

Other utilities.

Implements oops::LinearModelBase< FV3JEDITraits >.

Definition at line 62 of file TlmFV3JEDI.h.

◆ variables()

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

Implements oops::LinearModelBase< FV3JEDITraits >.

Definition at line 64 of file TlmFV3JEDI.h.

Member Data Documentation

◆ keyConfig_

F90model fv3jedi::TlmFV3JEDI::keyConfig_
private

Definition at line 72 of file TlmFV3JEDI.h.

◆ linvars_

const oops::Variables fv3jedi::TlmFV3JEDI::linvars_
private

Definition at line 77 of file TlmFV3JEDI.h.

◆ lrmodel_

const ModelFV3JEDI fv3jedi::TlmFV3JEDI::lrmodel_
private

Definition at line 76 of file TlmFV3JEDI.h.

◆ resol_

const GeometryFV3JEDI fv3jedi::TlmFV3JEDI::resol_
private

Definition at line 74 of file TlmFV3JEDI.h.

◆ traj_

std::map< util::DateTime, F90traj> fv3jedi::TlmFV3JEDI::traj_
private

Definition at line 75 of file TlmFV3JEDI.h.

◆ tstep_

util::Duration fv3jedi::TlmFV3JEDI::tstep_
private

Definition at line 73 of file TlmFV3JEDI.h.

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