FV3 Bundle
qg::ModelQG Class Reference

QG model definition. More...

#include <ModelQG.h>

Inheritance diagram for qg::ModelQG:
[legend]
Collaboration diagram for qg::ModelQG:
[legend]

Public Member Functions

 ModelQG (const GeometryQG &, const eckit::Configuration &)
 
 ~ModelQG ()
 
void initialize (StateQG &) const
 Prepare model integration. More...
 
void step (StateQG &, const ModelBias &) const
 Model integration. More...
 
int saveTrajectory (StateQG &, const ModelBias &) const
 
void finalize (StateQG &) const
 Finish model integration. More...
 
const util::Duration & timeResolution () const
 Utilities. More...
 
const oops::Variablesvariables () const
 
- Public Member Functions inherited from oops::ModelBase< QgTraits >
 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< QgTraits >
static const std::string classname ()
 

Private Member Functions

void print (std::ostream &) const
 

Private Attributes

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

Additional Inherited Members

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

Detailed Description

QG model definition.

QG nonlinear model definition and configuration parameters.

Definition at line 45 of file ModelQG.h.

Constructor & Destructor Documentation

◆ ModelQG()

qg::ModelQG::ModelQG ( const GeometryQG resol,
const eckit::Configuration &  model 
)

Definition at line 30 of file ModelQG.cc.

◆ ~ModelQG()

qg::ModelQG::~ModelQG ( )

Definition at line 41 of file ModelQG.cc.

Here is the call graph for this function:

Member Function Documentation

◆ classname()

static const std::string qg::ModelQG::classname ( )
inlinestatic

Definition at line 48 of file ModelQG.h.

◆ finalize()

void qg::ModelQG::finalize ( StateQG xx) const

Finish model integration.

Definition at line 60 of file ModelQG.cc.

Here is the call graph for this function:

◆ initialize()

void qg::ModelQG::initialize ( StateQG xx) const

Prepare model integration.

Definition at line 46 of file ModelQG.cc.

Here is the call graph for this function:

◆ print()

void qg::ModelQG::print ( std::ostream &  os) const
privatevirtual

Implements oops::ModelBase< QgTraits >.

Definition at line 75 of file ModelQG.cc.

◆ saveTrajectory()

int qg::ModelQG::saveTrajectory ( StateQG xx,
const ModelBias  
) const

Definition at line 65 of file ModelQG.cc.

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

◆ step()

void qg::ModelQG::step ( StateQG xx,
const ModelBias  
) const

Model integration.

Definition at line 52 of file ModelQG.cc.

Here is the call graph for this function:

◆ timeResolution()

const util::Duration& qg::ModelQG::timeResolution ( ) const
inlinevirtual

Utilities.

Implements oops::ModelBase< QgTraits >.

Definition at line 64 of file ModelQG.h.

◆ variables()

const oops::Variables& qg::ModelQG::variables ( ) const
inlinevirtual

Implements oops::ModelBase< QgTraits >.

Definition at line 65 of file ModelQG.h.

Member Data Documentation

◆ geom_

const GeometryQG qg::ModelQG::geom_
private

Definition at line 71 of file ModelQG.h.

◆ keyConfig_

F90model qg::ModelQG::keyConfig_
private

Definition at line 69 of file ModelQG.h.

◆ tstep_

util::Duration qg::ModelQG::tstep_
private

Definition at line 70 of file ModelQG.h.

◆ vars_

const oops::Variables qg::ModelQG::vars_
private

Definition at line 72 of file ModelQG.h.


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