soca::Model Class Reference

SOCA model definition. More...

#include <Model.h>

Inheritance diagram for soca::Model:

Collaboration diagram for soca::Model:

Public Member Functions
	Model (const Geometry &, const eckit::Configuration &)
	~Model ()
void	initialize (State &) const
	Prepare model integration. More...
void	step (State &, const ModelBias &) const
	Model integration. More...
int	saveTrajectory (State &, const ModelBias &) const
void	finalize (State &) const
	Finish model integration. More...
const util::Duration &	timeResolution () const
	Utilities. More...
const oops::Variables &	variables () const

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

Private Member Functions
void	print (std::ostream &) const

Private Attributes
int	keyConfig_
util::Duration	tstep_
bool	setup_mom6_
std::unique_ptr< const Geometry >	geom_
const oops::Variables	vars_

Detailed Description

SOCA model definition.

SOCA nonlinear model definition and configuration parameters.

Definition at line 46 of file Model.h.

Constructor & Destructor Documentation

Model()

soca::Model::Model	(	const Geometry &	resol,
		const eckit::Configuration &	model
	)

Definition at line 30 of file Model.cc.

Here is the call graph for this function:

~Model()

soca::Model::~Model

(

)

Definition at line 49 of file Model.cc.

Here is the call graph for this function:

Member Function Documentation

classname()

static const std::string soca::Model::classname ( )

inlinestatic

Definition at line 50 of file Model.h.

finalize()

void soca::Model::finalize

(

State &

xx

)

const

Finish model integration.

Definition at line 69 of file Model.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

initialize()

void soca::Model::initialize

(

State &

xx

)

const

Prepare model integration.

Definition at line 57 of file Model.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

print()

void soca::Model::print ( std::ostream &  os ) const

private

Definition at line 80 of file Model.cc.

saveTrajectory()

int soca::Model::saveTrajectory	(	State &	xx,
		const ModelBias &
	)		const

Definition at line 74 of file Model.cc.

Here is the call graph for this function:

step()

void soca::Model::step	(	State &	xx,
		const ModelBias &
	)		const

Model integration.

Definition at line 62 of file Model.cc.

Here is the call graph for this function:

timeResolution()

const util::Duration& soca::Model::timeResolution ( ) const

inline

Utilities.

Definition at line 66 of file Model.h.

variables()

const oops::Variables& soca::Model::variables ( ) const

inline

Definition at line 67 of file Model.h.

Member Data Documentation

geom_

std::unique_ptr<const Geometry> soca::Model::geom_

private

Definition at line 74 of file Model.h.

keyConfig_

int soca::Model::keyConfig_

private

Definition at line 71 of file Model.h.

setup_mom6_

bool soca::Model::setup_mom6_

private

Definition at line 73 of file Model.h.

tstep_

util::Duration soca::Model::tstep_

private

Definition at line 72 of file Model.h.

vars_

const oops::Variables soca::Model::vars_

private

Definition at line 75 of file Model.h.

---

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

• src/soca/Model/Model.h
• src/soca/Model/Model.cc