FV3 Bundle
fv3jedi::ModelFV3JEDI Class Reference

FV3JEDI model definition. More...

#include <ModelFV3JEDI.h>

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

Public Member Functions

 ModelFV3JEDI (const GeometryFV3JEDI &, const eckit::Configuration &)
 
 ~ModelFV3JEDI ()
 
void initialize (StateFV3JEDI &) const
 Prepare model integration. More...
 
void step (StateFV3JEDI &, const ModelBiasFV3JEDI &) const
 Model integration. More...
 
int saveTrajectory (StateFV3JEDI &, const ModelBiasFV3JEDI &) const
 
void finalize (StateFV3JEDI &) const
 Finish model integration. More...
 
const util::Duration & timeResolution () const
 Utilities. More...
 
const oops::Variablesvariables () const
 
- Public Member Functions inherited from oops::ModelBase< FV3JEDITraits >
 ModelBase ()
 
virtual ~ModelBase ()
 
void initialize (State_ &) const
 
void step (State_ &, const ModelAux_ &) const
 
void finalize (State_ &) const
 

Static Public Member Functions

static const std::string classname ()
 
- Static Public Member Functions inherited from oops::ModelBase< FV3JEDITraits >
static const std::string classname ()
 

Private Member Functions

void print (std::ostream &) const
 

Private Attributes

F90model keyConfig_
 
util::Duration tstep_
 
const GeometryFV3JEDI geom_
 
const oops::Variables vars_
 

Additional Inherited Members

- Protected Member Functions inherited from oops::ModelBase< FV3JEDITraits >
virtual void initialize (typename FV3JEDITraits ::State &) const=0
 
virtual void step (typename FV3JEDITraits ::State &, const typename FV3JEDITraits ::ModelAuxControl &) const=0
 
virtual void finalize (typename FV3JEDITraits ::State &) const=0
 

Detailed Description

FV3JEDI model definition.

FV3JEDI nonlinear model definition and configuration parameters.

Definition at line 43 of file ModelFV3JEDI.h.

Constructor & Destructor Documentation

◆ ModelFV3JEDI()

fv3jedi::ModelFV3JEDI::ModelFV3JEDI ( const GeometryFV3JEDI resol,
const eckit::Configuration &  model 
)

Definition at line 26 of file ModelFV3JEDI.cc.

◆ ~ModelFV3JEDI()

fv3jedi::ModelFV3JEDI::~ModelFV3JEDI ( )

Definition at line 41 of file ModelFV3JEDI.cc.

Here is the call graph for this function:

Member Function Documentation

◆ classname()

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

Definition at line 46 of file ModelFV3JEDI.h.

◆ finalize()

void fv3jedi::ModelFV3JEDI::finalize ( StateFV3JEDI xx) const

Finish model integration.

Definition at line 58 of file ModelFV3JEDI.cc.

Here is the call graph for this function:

◆ initialize()

void fv3jedi::ModelFV3JEDI::initialize ( StateFV3JEDI xx) const

Prepare model integration.

Definition at line 46 of file ModelFV3JEDI.cc.

Here is the call graph for this function:

◆ print()

void fv3jedi::ModelFV3JEDI::print ( std::ostream &  os) const
privatevirtual

Implements oops::ModelBase< FV3JEDITraits >.

Definition at line 71 of file ModelFV3JEDI.cc.

◆ saveTrajectory()

int fv3jedi::ModelFV3JEDI::saveTrajectory ( StateFV3JEDI xx,
const ModelBiasFV3JEDI  
) const

Definition at line 63 of file ModelFV3JEDI.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ step()

void fv3jedi::ModelFV3JEDI::step ( StateFV3JEDI xx,
const ModelBiasFV3JEDI  
) const

Model integration.

Definition at line 51 of file ModelFV3JEDI.cc.

Here is the call graph for this function:

◆ timeResolution()

const util::Duration& fv3jedi::ModelFV3JEDI::timeResolution ( ) const
inlinevirtual

Utilities.

Implements oops::ModelBase< FV3JEDITraits >.

Definition at line 62 of file ModelFV3JEDI.h.

◆ variables()

const oops::Variables& fv3jedi::ModelFV3JEDI::variables ( ) const
inlinevirtual

Implements oops::ModelBase< FV3JEDITraits >.

Definition at line 63 of file ModelFV3JEDI.h.

Member Data Documentation

◆ geom_

const GeometryFV3JEDI fv3jedi::ModelFV3JEDI::geom_
private

Definition at line 69 of file ModelFV3JEDI.h.

◆ keyConfig_

F90model fv3jedi::ModelFV3JEDI::keyConfig_
private

Definition at line 67 of file ModelFV3JEDI.h.

◆ tstep_

util::Duration fv3jedi::ModelFV3JEDI::tstep_
private

Definition at line 68 of file ModelFV3JEDI.h.

◆ vars_

const oops::Variables fv3jedi::ModelFV3JEDI::vars_
private

Definition at line 70 of file ModelFV3JEDI.h.


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