oops::Model< MODEL > Class Template Reference

Abstract nonlinear forecast model used by high level algorithms and applications. More...

#include <Model.h>

Inheritance diagram for oops::Model< MODEL >:

Collaboration diagram for oops::Model< MODEL >:

Public Member Functions
	Model (const Geometry_ &, const ModelParametersBase &)
	Model (const Geometry_ &, const eckit::Configuration &)
	Model (std::unique_ptr< ModelBase_ >)
virtual	~Model ()
void	forecast (State_ &xx, const ModelAux_ &, const util::Duration &len, PostProcessor< State_ > &post) const
	Run the forecast from state xx for len time, with post postprocessors Does not need to be implemented in the models. More...
const util::Duration &	timeResolution () const
	Time step for running Model's forecast in oops (frequency with which the State will be updated) More...
const oops::Variables &	variables () const
	Model variables (only used in 4DVar) More...

Static Public Member Functions
static const std::string	classname ()

Private Types
typedef ModelBase< MODEL >	ModelBase_
typedef Geometry< MODEL >	Geometry_
typedef ModelAuxControl< MODEL >	ModelAux_
typedef State< MODEL >	State_

Private Member Functions
void	initialize (State_ &) const
	Forecast initialization, called before every forecast run. More...
void	step (State_ &, const ModelAux_ &) const
	Forecast "step", called during forecast run; updates state to the next time. More...
void	finalize (State_ &) const
	Forecast finalization; called after each forecast run. More...
void	print (std::ostream &) const
	Print, used in logging. More...

Private Attributes
std::unique_ptr< ModelBase_ >	model_
	Pointer to the Model implementation. More...

Detailed Description

template<typename MODEL>
class oops::Model< MODEL >

Abstract nonlinear forecast model used by high level algorithms and applications.

Note: to see methods that need to be implemented in a generic forecast model implementation, see ModelBase class in generic/ModelBase.h. To see methods that need to be implemented in a MODEL-specific forecast model implementation, see interface::ModelBase class in interface/ModelBase.h.

Definition at line 43 of file oops/base/Model.h.

Member Typedef Documentation

Geometry_

template<typename MODEL >

typedef Geometry<MODEL> oops::Model< MODEL >::Geometry_

private

Definition at line 47 of file oops/base/Model.h.

ModelAux_

template<typename MODEL >

typedef ModelAuxControl<MODEL> oops::Model< MODEL >::ModelAux_

private

Definition at line 48 of file oops/base/Model.h.

ModelBase_

template<typename MODEL >

typedef ModelBase<MODEL> oops::Model< MODEL >::ModelBase_

private

Definition at line 46 of file oops/base/Model.h.

State_

template<typename MODEL >

typedef State<MODEL> oops::Model< MODEL >::State_

private

Definition at line 49 of file oops/base/Model.h.

Constructor & Destructor Documentation

Model() [1/3]

template<typename MODEL >

oops::Model< MODEL >::Model	(	const Geometry_ &	resol,
		const ModelParametersBase &	params
	)

Definition at line 87 of file oops/base/Model.h.

Here is the call graph for this function:

Model() [2/3]

template<typename MODEL >

oops::Model< MODEL >::Model	(	const Geometry_ &	resol,
		const eckit::Configuration &	conf
	)

Definition at line 100 of file oops/base/Model.h.

Model() [3/3]

template<typename MODEL >

oops::Model< MODEL >::Model ( std::unique_ptr< ModelBase_ >  model )

explicit

Definition at line 107 of file oops/base/Model.h.

~Model()

template<typename MODEL >

oops::Model< MODEL >::~Model

virtual

Definition at line 116 of file oops/base/Model.h.

Member Function Documentation

classname()

template<typename MODEL >

static const std::string oops::Model< MODEL >::classname ( )

inlinestatic

Definition at line 52 of file oops/base/Model.h.

Here is the caller graph for this function:

finalize()

template<typename MODEL >

void oops::Model< MODEL >::finalize ( State_ &  xx ) const

private

Forecast finalization; called after each forecast run.

Definition at line 171 of file oops/base/Model.h.

forecast()

template<typename MODEL >

void oops::Model< MODEL >::forecast	(	State_ &	xx,
		const ModelAux_ &	maux,
		const util::Duration &	len,
		PostProcessor< State_ > &	post
	)		const

Run the forecast from state xx for len time, with post postprocessors Does not need to be implemented in the models.

Definition at line 126 of file oops/base/Model.h.

Here is the call graph for this function:

Here is the caller graph for this function:

initialize()

template<typename MODEL >

void oops::Model< MODEL >::initialize ( State_ &  xx ) const

private

Forecast initialization, called before every forecast run.

Definition at line 151 of file oops/base/Model.h.

print()

template<typename MODEL >

void oops::Model< MODEL >::print ( std::ostream &  os ) const

private

Print, used in logging.

Definition at line 181 of file oops/base/Model.h.

step()

template<typename MODEL >

void oops::Model< MODEL >::step ( State_ &  xx, const ModelAux_ &  maux  ) const

private

Forecast "step", called during forecast run; updates state to the next time.

Definition at line 161 of file oops/base/Model.h.

timeResolution()

template<typename MODEL >

const util::Duration& oops::Model< MODEL >::timeResolution ( ) const

inline

Time step for running Model's forecast in oops (frequency with which the State will be updated)

Definition at line 66 of file oops/base/Model.h.

variables()

template<typename MODEL >

const oops::Variables& oops::Model< MODEL >::variables ( ) const

inline

Model variables (only used in 4DVar)

Definition at line 68 of file oops/base/Model.h.

Member Data Documentation

model_

template<typename MODEL >

std::unique_ptr<ModelBase_> oops::Model< MODEL >::model_

private

Pointer to the Model implementation.

Definition at line 81 of file oops/base/Model.h.

---

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

• oops/base/Model.h