Encapsulates the model state. More...

#include <State.h>

Inheritance diagram for oops::State< MODEL >:

Collaboration diagram for oops::State< MODEL >:

Public Member Functions
	State (const Geometry_ &, const Variables &, const util::DateTime &)
	Constructor, destructor. More...

	State (const Geometry_ &, const Variables &, const eckit::Configuration &)

	State (const Geometry_ &, const State &)

	State (const State &)

	~State ()

State &	operator= (const State &)

State_ &	state ()
	Interfacing. More...

const State_ &	state () const

void	getValues (const Locations_ &, const Variables &, GeoVaLs_ &) const
	Get state values at observation locations. More...

void	getValues (const Locations_ &, const Variables &, GeoVaLs_ &, InterpolatorTraj_ &) const

const util::DateTime	validTime () const
	Time. More...

void	read (const eckit::Configuration &)
	I/O and diagnostics. More...

void	write (const eckit::Configuration &) const

double	norm () const

Geometry_	geometry () const

GridPoint	getPoint (const GeometryIterator_ &iter) const

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

Protected Member Functions
void	zero ()

void	accumul (const double &, const State &)

Private Types
typedef MODEL::State	State_

typedef Geometry< MODEL >	Geometry_

typedef GeometryIterator< MODEL >	GeometryIterator_

typedef GeoVaLs< MODEL >	GeoVaLs_

typedef InterpolatorTraj< MODEL >	InterpolatorTraj_

typedef Locations< MODEL >	Locations_

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

Private Attributes
boost::scoped_ptr< State_ >	state_

Detailed Description

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

Encapsulates the model state.

Definition at line 39 of file oops/interface/State.h.

Member Typedef Documentation

◆ Geometry_

template<typename MODEL>

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

private

Definition at line 42 of file oops/interface/State.h.

◆ GeometryIterator_

template<typename MODEL>

typedef GeometryIterator<MODEL> oops::State< MODEL >::GeometryIterator_

private

Definition at line 43 of file oops/interface/State.h.

◆ GeoVaLs_

template<typename MODEL>

typedef GeoVaLs<MODEL> oops::State< MODEL >::GeoVaLs_

private

Definition at line 44 of file oops/interface/State.h.

◆ InterpolatorTraj_

template<typename MODEL>

typedef InterpolatorTraj<MODEL> oops::State< MODEL >::InterpolatorTraj_

private

Definition at line 45 of file oops/interface/State.h.

◆ Locations_

template<typename MODEL>

typedef Locations<MODEL> oops::State< MODEL >::Locations_

private

Definition at line 46 of file oops/interface/State.h.

◆ State_

template<typename MODEL>

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

private

Definition at line 41 of file oops/interface/State.h.

Constructor & Destructor Documentation

◆ State() [1/4]

template<typename MODEL >

oops::State< MODEL >::State	(	const Geometry_ &	resol,
		const Variables &	vars,
		const util::DateTime &	time
	)

Constructor, destructor.

Definition at line 90 of file oops/interface/State.h.

Here is the call graph for this function:

◆ State() [2/4]

template<typename MODEL >

oops::State< MODEL >::State	(	const Geometry_ &	resol,
		const Variables &	vars,
		const eckit::Configuration &	conf
	)

Definition at line 102 of file oops/interface/State.h.

Here is the call graph for this function:

◆ State() [3/4]

template<typename MODEL >

oops::State< MODEL >::State	(	const Geometry_ &	resol,
		const State< MODEL > &	other
	)

Definition at line 114 of file oops/interface/State.h.

Here is the call graph for this function:

◆ State() [4/4]

template<typename MODEL >

oops::State< MODEL >::State ( const State< MODEL > & other )

Definition at line 125 of file oops/interface/State.h.

Here is the call graph for this function:

◆ ~State()

template<typename MODEL >

oops::State< MODEL >::~State ( )

Definition at line 136 of file oops/interface/State.h.

Member Function Documentation

◆ accumul()

template<typename MODEL >

void oops::State< MODEL >::accumul	(	const double &	zz,
		const State< MODEL > &	xx
	)

protected

Definition at line 242 of file oops/interface/State.h.

◆ classname()

template<typename MODEL>

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

inlinestatic

Definition at line 49 of file oops/interface/State.h.

Here is the caller graph for this function:

◆ geometry()

template<typename MODEL >

Geometry< MODEL > oops::State< MODEL >::geometry ( ) const

Definition at line 210 of file oops/interface/State.h.

◆ getPoint()

template<typename MODEL >

GridPoint oops::State< MODEL >::getPoint ( const GeometryIterator_ & iter ) const

Definition at line 252 of file oops/interface/State.h.

Here is the call graph for this function:

◆ getValues() [1/2]

template<typename MODEL >

void oops::State< MODEL >::getValues	(	const Locations_ &	locs,
		const Variables &	vars,
		GeoVaLs_ &	gvals
	)		const

Get state values at observation locations.

Definition at line 157 of file oops/interface/State.h.

Here is the call graph for this function:

◆ getValues() [2/2]

template<typename MODEL >

void oops::State< MODEL >::getValues	(	const Locations_ &	locs,
		const Variables &	vars,
		GeoVaLs_ &	gvals,
		InterpolatorTraj_ &	traj
	)		const

Definition at line 168 of file oops/interface/State.h.

Here is the call graph for this function:

◆ norm()

template<typename MODEL >

double oops::State< MODEL >::norm ( ) const

Definition at line 199 of file oops/interface/State.h.

Here is the caller graph for this function:

◆ operator=()

template<typename MODEL >

State< MODEL > & oops::State< MODEL >::operator= ( const State< MODEL > & rhs )

Definition at line 146 of file oops/interface/State.h.

◆ print()

template<typename MODEL >

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

private

Definition at line 222 of file oops/interface/State.h.

◆ read()

template<typename MODEL >

void oops::State< MODEL >::read ( const eckit::Configuration & conf )

I/O and diagnostics.

Definition at line 179 of file oops/interface/State.h.

◆ state() [1/2]

template<typename MODEL>

State_& oops::State< MODEL >::state ( )

inline

Interfacing.

Definition at line 60 of file oops/interface/State.h.

Here is the caller graph for this function:

◆ state() [2/2]

template<typename MODEL>

const State_& oops::State< MODEL >::state ( ) const

inline

Definition at line 61 of file oops/interface/State.h.

◆ validTime()

template<typename MODEL>

const util::DateTime oops::State< MODEL >::validTime ( ) const

inline

Time.

Definition at line 68 of file oops/interface/State.h.

Here is the caller graph for this function:

◆ write()

template<typename MODEL >

void oops::State< MODEL >::write ( const eckit::Configuration & conf ) const

Definition at line 189 of file oops/interface/State.h.

◆ zero()

template<typename MODEL >

void oops::State< MODEL >::zero ( )

protected

Definition at line 232 of file oops/interface/State.h.

Member Data Documentation

◆ state_

template<typename MODEL>

boost::scoped_ptr<State_> oops::State< MODEL >::state_

private

Definition at line 84 of file oops/interface/State.h.

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

oops/interface/State.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ Geometry_

◆ GeometryIterator_

◆ GeoVaLs_

◆ InterpolatorTraj_

◆ Locations_

◆ State_

Constructor & Destructor Documentation

◆ State() [1/4]

◆ State() [2/4]

◆ State() [3/4]

◆ State() [4/4]

◆ ~State()

Member Function Documentation

◆ accumul()

◆ classname()

◆ geometry()

◆ getPoint()

◆ getValues() [1/2]

◆ getValues() [2/2]

◆ norm()

◆ operator=()

◆ print()

◆ read()

◆ state() [1/2]

◆ state() [2/2]

◆ validTime()

◆ write()

◆ zero()

Member Data Documentation

◆ state_

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