qg::ModelQG Class Reference

QG model definition. More...

#include <ModelQG.h>

Inheritance diagram for qg::ModelQG:

Collaboration diagram for qg::ModelQG:

Public Types
typedef ModelQgParameters	Parameters_

Public Member Functions
	ModelQG (const GeometryQG &, const ModelQgParameters &)
	~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::Variables &	variables () const
	Model variables (only used in 4DVar) More...
Public Member Functions inherited from oops::interface::ModelBase< QgTraits >
	ModelBase ()=default
virtual	~ModelBase ()=default
void	initialize (oops::State< QgTraits > &xx) const final
virtual void	initialize (State_ &) const=0
	Forecast initialization, called before every forecast run. More...
void	step (oops::State< QgTraits > &xx, const ModelAuxControl< QgTraits > &modelaux) const final
	Forecast "step", called during forecast run; updates state to the next time. More...
virtual void	step (State_ &, const ModelAux_ &) const=0
	Forecast "step", called during forecast run; updates state to the next time. More...
void	finalize (oops::State< QgTraits > &xx) const final
	Forecast finalization; called after each forecast run. More...
virtual void	finalize (State_ &) const=0
	Forecast finalization; called after each forecast run. More...
Public Member Functions inherited from oops::ModelBase< MODEL >
	ModelBase ()=default

Static Public Member Functions
static const std::string	classname ()
Static Public Member Functions inherited from oops::interface::ModelBase< QgTraits >
static const std::string	classname ()
Static Public Member Functions inherited from oops::ModelBase< MODEL >
static const std::string	classname ()

Private Member Functions
void	print (std::ostream &) const
	Print; used for logging. More...

Private Attributes
F90model	keyConfig_
ModelQgParameters	params_
const GeometryQG	geom_
const oops::Variables	vars_

Detailed Description

QG model definition.

QG nonlinear model definition and configuration parameters.

Definition at line 59 of file ModelQG.h.

Member Typedef Documentation

Parameters_

typedef ModelQgParameters qg::ModelQG::Parameters_

Definition at line 62 of file ModelQG.h.

Constructor & Destructor Documentation

ModelQG()

qg::ModelQG::ModelQG	(	const GeometryQG &	resol,
		const ModelQgParameters &	params
	)

Definition at line 29 of file ModelQG.cc.

Here is the call graph for this function:

~ModelQG()

qg::ModelQG::~ModelQG

(

)

Definition at line 38 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 64 of file ModelQG.h.

finalize()

void qg::ModelQG::finalize

(

StateQG &

xx

)

const

Finish model integration.

Definition at line 56 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 43 of file ModelQG.cc.

Here is the call graph for this function:

print()

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

privatevirtual

Print; used for logging.

Implements oops::ModelBase< MODEL >.

Definition at line 72 of file ModelQG.cc.

saveTrajectory()

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

Definition at line 61 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 48 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< MODEL >.

Definition at line 80 of file ModelQG.h.

variables()

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

inlinevirtual

Model variables (only used in 4DVar)

Implements oops::ModelBase< MODEL >.

Definition at line 81 of file ModelQG.h.

Member Data Documentation

geom_

const GeometryQG qg::ModelQG::geom_

private

Definition at line 87 of file ModelQG.h.

keyConfig_

F90model qg::ModelQG::keyConfig_

private

Definition at line 85 of file ModelQG.h.

params_

ModelQgParameters qg::ModelQG::params_

private

Definition at line 86 of file ModelQG.h.

vars_

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

private

Definition at line 88 of file ModelQG.h.

---

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

• ModelQG.h
• ModelQG.cc