soca::State Class Reference

SOCA model state. More...

#include <State.h>

Inheritance diagram for soca::State:

Collaboration diagram for soca::State:

Public Member Functions
	State (const Geometry &, const oops::Variables &, const util::DateTime &)
	Constructor, destructor. More...
	State (const Geometry &, const eckit::Configuration &)
	State (const Geometry &, const State &)
	State (const State &)
virtual	~State ()
State &	operator= (const State &)
	Basic operators. More...
void	updateTime (const util::Duration &dt)
	Needed by PseudoModel. More...
void	rotate2north (const oops::Variables &, const oops::Variables &) const
	Rotations. More...
void	rotate2grid (const oops::Variables &, const oops::Variables &) const
void	logtrans (const oops::Variables &) const
	Logarithmic and exponential transformations. More...
void	expontrans (const oops::Variables &) const
State &	operator+= (const Increment &)
	Interactions with Increment. More...
void	read (const eckit::Configuration &)
	I/O and diagnostics. More...
void	write (const eckit::Configuration &) const
double	norm () const
const util::DateTime &	validTime () const
util::DateTime &	validTime ()
size_t	serialSize () const override
	Serialize and deserialize. More...
void	serialize (std::vector< double > &) const override
void	deserialize (const std::vector< double > &, size_t &) override
int &	toFortran ()
const int &	toFortran () const
std::shared_ptr< const Geometry >	geometry () const
const oops::Variables &	variables () const
void	zero ()
	Other. More...
void	accumul (const double &, const State &)

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

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

Private Attributes
F90flds	keyFlds_
std::shared_ptr< const Geometry >	geom_
oops::Variables	vars_
util::DateTime	time_

Detailed Description

SOCA model state.

A State contains everything that is needed to propagate the state forward in time.

Definition at line 46 of file State.h.

Constructor & Destructor Documentation

State() [1/4]

soca::State::State	(	const Geometry &	geom,
		const oops::Variables &	vars,
		const util::DateTime &	vt
	)

Constructor, destructor.

Definition at line 33 of file State.cc.

Here is the call graph for this function:

State() [2/4]

soca::State::State	(	const Geometry &	geom,
		const eckit::Configuration &	file
	)

Definition at line 41 of file State.cc.

Here is the call graph for this function:

State() [3/4]

soca::State::State	(	const Geometry &	geom,
		const State &	other
	)

Definition at line 53 of file State.cc.

Here is the call graph for this function:

State() [4/4]

soca::State::State

(

const State &

other

)

Definition at line 61 of file State.cc.

Here is the call graph for this function:

~State()

soca::State::~State ( )

virtual

Definition at line 69 of file State.cc.

Here is the call graph for this function:

Member Function Documentation

accumul()

void soca::State::accumul	(	const double &	zz,
		const State &	xx
	)

Definition at line 193 of file State.cc.

Here is the call graph for this function:

classname()

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

inlinestatic

Definition at line 50 of file State.h.

deserialize()

void soca::State::deserialize ( const std::vector< double > &  vect, size_t &  index  )

override

Definition at line 174 of file State.cc.

Here is the call graph for this function:

expontrans()

void soca::State::expontrans

(

const oops::Variables &

trvar

)

const

Definition at line 211 of file State.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

geometry()

std::shared_ptr< const Geometry > soca::State::geometry

(

)

const

Definition at line 222 of file State.cc.

logtrans()

void soca::State::logtrans

(

const oops::Variables &

trvar

)

const

Logarithmic and exponential transformations.

Definition at line 205 of file State.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

norm()

double soca::State::norm

(

)

const

Definition at line 197 of file State.cc.

Here is the call graph for this function:

operator+=()

State & soca::State::operator+=

(

const Increment &

dx

)

Interactions with Increment.

Interactions with Increments.

Definition at line 100 of file State.cc.

Here is the call graph for this function:

operator=()

State & soca::State::operator=

(

const State &

rhs

)

Basic operators.

Definition at line 76 of file State.cc.

Here is the call graph for this function:

print()

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

overrideprivate

Definition at line 124 of file State.cc.

Here is the call graph for this function:

read()

void soca::State::read

(

const eckit::Configuration &

files

)

I/O and diagnostics.

Definition at line 112 of file State.cc.

Here is the call graph for this function:

rotate2grid()

void soca::State::rotate2grid	(	const oops::Variables &	u,
		const oops::Variables &	v
	)		const

Definition at line 91 of file State.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

rotate2north()

void soca::State::rotate2north	(	const oops::Variables &	u,
		const oops::Variables &	v
	)		const

Rotations.

Definition at line 84 of file State.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

serialize()

void soca::State::serialize ( std::vector< double > &  vect ) const

override

Definition at line 157 of file State.cc.

Here is the call graph for this function:

serialSize()

size_t soca::State::serialSize ( ) const

override

Serialize and deserialize.

Serialization.

Definition at line 143 of file State.cc.

Here is the call graph for this function:

toFortran() [1/2]

int& soca::State::toFortran ( )

inline

Definition at line 88 of file State.h.

Here is the caller graph for this function:

toFortran() [2/2]

const int& soca::State::toFortran ( ) const

inline

Definition at line 89 of file State.h.

updateTime()

void soca::State::updateTime ( const util::Duration &  dt )

inline

Needed by PseudoModel.

Definition at line 62 of file State.h.

validTime() [1/2]

util::DateTime & soca::State::validTime

(

)

Definition at line 220 of file State.cc.

validTime() [2/2]

const util::DateTime & soca::State::validTime

(

)

const

Definition at line 218 of file State.cc.

Here is the caller graph for this function:

variables()

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

inline

Definition at line 91 of file State.h.

Here is the caller graph for this function:

write()

void soca::State::write

(

const eckit::Configuration &

files

)

const

Definition at line 119 of file State.cc.

Here is the call graph for this function:

zero()

void soca::State::zero

(

)

Other.

For accumulator.

Definition at line 189 of file State.cc.

Here is the call graph for this function:

Member Data Documentation

geom_

std::shared_ptr<const Geometry> soca::State::geom_

private

Definition at line 102 of file State.h.

keyFlds_

F90flds soca::State::keyFlds_

private

Definition at line 100 of file State.h.

time_

util::DateTime soca::State::time_

private

Definition at line 104 of file State.h.

vars_

oops::Variables soca::State::vars_

private

Definition at line 103 of file State.h.

---

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

• src/soca/State/State.h
• src/soca/State/State.cc