lorenz95::ModelL95 Class Reference

Lorenz 95 model configuration and computations. More...

#include <ModelL95.h>

Inheritance diagram for lorenz95::ModelL95:

Collaboration diagram for lorenz95::ModelL95:

Public Types
typedef ModelL95Parameters	Parameters_

Public Member Functions
	ModelL95 (const Resolution &, const ModelL95Parameters &)
	~ModelL95 ()
void	initialize (StateL95 &) const
void	step (StateL95 &, const ModelBias &) const
void	finalize (StateL95 &) const
void	stepRK (FieldL95 &, const ModelBias &, ModelTrajectory &) const
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...
Public Member Functions inherited from oops::interface::ModelBase< L95Traits >
	ModelBase ()=default
virtual	~ModelBase ()=default
void	initialize (oops::State< L95Traits > &xx) const final
virtual void	initialize (State_ &) const=0
	Forecast initialization, called before every forecast run. More...
void	step (oops::State< L95Traits > &xx, const ModelAuxControl< L95Traits > &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< L95Traits > &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< L95Traits >
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...
void	tendencies (const FieldL95 &, const double &, FieldL95 &) const

Private Attributes
const Resolution	resol_
const double	f_
const util::Duration	tstep_
const double	dt_
const oops::Variables	vars_

Detailed Description

Lorenz 95 model configuration and computations.

Definition at line 50 of file ModelL95.h.

Member Typedef Documentation

Parameters_

typedef ModelL95Parameters lorenz95::ModelL95::Parameters_

Definition at line 53 of file ModelL95.h.

Constructor & Destructor Documentation

ModelL95()

lorenz95::ModelL95::ModelL95	(	const Resolution &	resol,
		const ModelL95Parameters &	params
	)

Definition at line 31 of file ModelL95.cc.

~ModelL95()

lorenz95::ModelL95::~ModelL95

(

)

Definition at line 41 of file ModelL95.cc.

Member Function Documentation

classname()

static const std::string lorenz95::ModelL95::classname ( )

inlinestatic

Definition at line 55 of file ModelL95.h.

finalize()

void lorenz95::ModelL95::finalize

(

StateL95 &

)

const

Definition at line 47 of file ModelL95.cc.

initialize()

void lorenz95::ModelL95::initialize

(

StateL95 &

)

const

Definition at line 46 of file ModelL95.cc.

print()

void lorenz95::ModelL95::print ( std::ostream &  ) const

privatevirtual

Print; used for logging.

Implements oops::ModelBase< MODEL >.

Definition at line 116 of file ModelL95.cc.

step()

void lorenz95::ModelL95::step	(	StateL95 &	xx,
		const ModelBias &	bias
	)		const

Definition at line 49 of file ModelL95.cc.

Here is the call graph for this function:

stepRK()

void lorenz95::ModelL95::stepRK	(	FieldL95 &	xx,
		const ModelBias &	bias,
		ModelTrajectory &	traj
	)		const

Definition at line 56 of file ModelL95.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

tendencies()

void lorenz95::ModelL95::tendencies ( const FieldL95 &  xx, const double &  bias, FieldL95 &  dx  ) const

private

Definition at line 94 of file ModelL95.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

timeResolution()

const util::Duration& lorenz95::ModelL95::timeResolution ( ) const

inlinevirtual

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

Implements oops::ModelBase< MODEL >.

Definition at line 67 of file ModelL95.h.

variables()

const oops::Variables& lorenz95::ModelL95::variables ( ) const

inlinevirtual

Model variables (only used in 4DVar)

Implements oops::ModelBase< MODEL >.

Definition at line 68 of file ModelL95.h.

Member Data Documentation

dt_

const double lorenz95::ModelL95::dt_

private

Definition at line 78 of file ModelL95.h.

f_

const double lorenz95::ModelL95::f_

private

Definition at line 76 of file ModelL95.h.

resol_

const Resolution lorenz95::ModelL95::resol_

private

Definition at line 75 of file ModelL95.h.

tstep_

const util::Duration lorenz95::ModelL95::tstep_

private

Definition at line 77 of file ModelL95.h.

vars_

const oops::Variables lorenz95::ModelL95::vars_

private

Definition at line 79 of file ModelL95.h.

---

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

• ModelL95.h
• ModelL95.cc