Increment Class: Difference between two states. More...

#include <Increment.h>

Inheritance diagram for oops::Increment< MODEL >:

Collaboration diagram for oops::Increment< MODEL >:

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

	Increment (const Geometry_ &, const Increment &)

	Increment (const Increment &, const bool copy=true)

virtual	~Increment ()

Increment_ &	increment ()
	Interfacing. More...

const Increment_ &	increment () const

void	getValuesTL (const Locations_ &, const Variables &, GeoVaLs_ &, const InterpolatorTraj_ &) const
	Get increment values at observation locations. More...

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

void	diff (const State_ &, const State_ &)
	Interactions with State. More...

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

void	updateTime (const util::Duration &dt)

void	zero ()
	Linear algebra operators. More...

void	zero (const util::DateTime &)

void	dirac (const eckit::Configuration &)

Increment &	operator= (const Increment &)

Increment &	operator+= (const Increment &)

Increment &	operator-= (const Increment &)

Increment &	operator*= (const double &)

void	axpy (const double &, const Increment &, const bool check=true)

double	dot_product_with (const Increment &) const

void	schur_product_with (const Increment &)

void	random ()

void	accumul (const double &, const State_ &)

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

void	write (const eckit::Configuration &) const

double	norm () const

Geometry_	geometry () const
	Get geometry. More...

void	ug_coord (UnstructuredGrid &, const int &) const
	Unstructured grid. More...

void	field_to_ug (UnstructuredGrid &, const int &) const

void	field_from_ug (const UnstructuredGrid &)

Public Member Functions inherited from oops::GeneralizedDepartures
	GeneralizedDepartures ()

virtual	~GeneralizedDepartures ()

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

Private Types
typedef MODEL::Increment	Increment_

typedef Geometry< MODEL >	Geometry_

typedef GeoVaLs< MODEL >	GeoVaLs_

typedef InterpolatorTraj< MODEL >	InterpolatorTraj_

typedef Locations< MODEL >	Locations_

typedef State< MODEL >	State_

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

Private Attributes
boost::scoped_ptr< Increment_ >	increment_

Detailed Description

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

Increment Class: Difference between two states.

Some fields that are present in a State may not be present in an Increment.

Definition at line 40 of file oops/interface/Increment.h.

Member Typedef Documentation

◆ Geometry_

template<typename MODEL>

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

private

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

◆ GeoVaLs_

template<typename MODEL>

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

private

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

◆ Increment_

template<typename MODEL>

typedef MODEL::Increment oops::Increment< MODEL >::Increment_

private

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

◆ InterpolatorTraj_

template<typename MODEL>

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

private

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

◆ Locations_

template<typename MODEL>

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

private

Definition at line 47 of file oops/interface/Increment.h.

◆ State_

template<typename MODEL>

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

private

Definition at line 48 of file oops/interface/Increment.h.

Constructor & Destructor Documentation

◆ Increment() [1/3]

template<typename MODEL >

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

Constructor, destructor.

Definition at line 124 of file oops/interface/Increment.h.

Here is the call graph for this function:

◆ Increment() [2/3]

template<typename MODEL >

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

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

Here is the call graph for this function:

◆ Increment() [3/3]

template<typename MODEL >

oops::Increment< MODEL >::Increment	(	const Increment< MODEL > &	other,
		const bool	copy = `true`
	)

Definition at line 148 of file oops/interface/Increment.h.

Here is the call graph for this function:

◆ ~Increment()

template<typename MODEL >

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

virtual

Definition at line 159 of file oops/interface/Increment.h.

Member Function Documentation

◆ accumul()

template<typename MODEL >

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

Definition at line 316 of file oops/interface/Increment.h.

Here is the call graph for this function:

◆ axpy()

template<typename MODEL >

void oops::Increment< MODEL >::axpy	(	const double &	zz,
		const Increment< MODEL > &	dx,
		const bool	check = `true`
	)

Definition at line 275 of file oops/interface/Increment.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ classname()

template<typename MODEL>

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

inlinestatic

Definition at line 51 of file oops/interface/Increment.h.

Here is the caller graph for this function:

◆ diff()

template<typename MODEL >

void oops::Increment< MODEL >::diff	(	const State_ &	x1,
		const State_ &	x2
	)

Interactions with State.

Definition at line 191 of file oops/interface/Increment.h.

Here is the call graph for this function:

◆ dirac()

template<typename MODEL >

void oops::Increment< MODEL >::dirac ( const eckit::Configuration & config )

Definition at line 221 of file oops/interface/Increment.h.

Here is the caller graph for this function:

◆ dot_product_with()

template<typename MODEL >

double oops::Increment< MODEL >::dot_product_with ( const Increment< MODEL > & dx ) const

Definition at line 285 of file oops/interface/Increment.h.

Here is the caller graph for this function:

◆ field_from_ug()

template<typename MODEL >

void oops::Increment< MODEL >::field_from_ug ( const UnstructuredGrid & ug )

Definition at line 388 of file oops/interface/Increment.h.

Here is the caller graph for this function:

◆ field_to_ug()

template<typename MODEL >

void oops::Increment< MODEL >::field_to_ug	(	UnstructuredGrid &	ug,
		const int &	colocated
	)		const

Definition at line 378 of file oops/interface/Increment.h.

Here is the caller graph for this function:

◆ geometry()

template<typename MODEL >

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

Get geometry.

Definition at line 357 of file oops/interface/Increment.h.

Here is the caller graph for this function:

◆ getValuesAD()

template<typename MODEL >

void oops::Increment< MODEL >::getValuesAD	(	const Locations_ &	loc,
		const Variables &	vars,
		const GeoVaLs_ &	gvals,
		const InterpolatorTraj_ &	traj
	)

Definition at line 180 of file oops/interface/Increment.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValuesTL()

template<typename MODEL >

void oops::Increment< MODEL >::getValuesTL	(	const Locations_ &	loc,
		const Variables &	vars,
		GeoVaLs_ &	gvals,
		const InterpolatorTraj_ &	traj
	)		const

Get increment values at observation locations.

Definition at line 169 of file oops/interface/Increment.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ increment() [1/2]

template<typename MODEL>

Increment_& oops::Increment< MODEL >::increment ( )

inline

Interfacing.

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

Here is the caller graph for this function:

◆ increment() [2/2]

template<typename MODEL>

const Increment_& oops::Increment< MODEL >::increment ( ) const

inline

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

◆ norm()

template<typename MODEL >

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

Definition at line 346 of file oops/interface/Increment.h.

◆ operator*=()

template<typename MODEL >

Increment< MODEL > & oops::Increment< MODEL >::operator*= ( const double & zz )

Definition at line 264 of file oops/interface/Increment.h.

◆ operator+=()

template<typename MODEL >

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

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

◆ operator-=()

template<typename MODEL >

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

Definition at line 253 of file oops/interface/Increment.h.

◆ operator=()

template<typename MODEL >

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

Definition at line 231 of file oops/interface/Increment.h.

◆ print()

template<typename MODEL >

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

private

Definition at line 398 of file oops/interface/Increment.h.

◆ random()

template<typename MODEL >

void oops::Increment< MODEL >::random ( )

Definition at line 306 of file oops/interface/Increment.h.

Here is the caller graph for this function:

◆ read()

template<typename MODEL >

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

I/O and diagnostics.

Definition at line 326 of file oops/interface/Increment.h.

◆ schur_product_with()

template<typename MODEL >

void oops::Increment< MODEL >::schur_product_with ( const Increment< MODEL > & dx )

Definition at line 296 of file oops/interface/Increment.h.

Here is the caller graph for this function:

◆ ug_coord()

template<typename MODEL >

void oops::Increment< MODEL >::ug_coord	(	UnstructuredGrid &	ug,
		const int &	colocated
	)		const

Unstructured grid.

Definition at line 368 of file oops/interface/Increment.h.

Here is the caller graph for this function:

◆ updateTime()

template<typename MODEL>

void oops::Increment< MODEL >::updateTime ( const util::Duration & dt )

inline

Definition at line 74 of file oops/interface/Increment.h.

Here is the caller graph for this function:

◆ validTime()

template<typename MODEL>

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

inline

Time.

Definition at line 73 of file oops/interface/Increment.h.

Here is the caller graph for this function:

◆ write()

template<typename MODEL >

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

Definition at line 336 of file oops/interface/Increment.h.

Here is the caller graph for this function:

◆ zero() [1/2]

template<typename MODEL >

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

Linear algebra operators.

Definition at line 201 of file oops/interface/Increment.h.

Here is the caller graph for this function:

◆ zero() [2/2]

template<typename MODEL >

void oops::Increment< MODEL >::zero ( const util::DateTime & tt )

Definition at line 211 of file oops/interface/Increment.h.

Member Data Documentation

◆ increment_

template<typename MODEL>

boost::scoped_ptr<Increment_> oops::Increment< MODEL >::increment_

private

Definition at line 105 of file oops/interface/Increment.h.

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

oops/interface/Increment.h

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ Geometry_

◆ GeoVaLs_

◆ Increment_

◆ InterpolatorTraj_

◆ Locations_

◆ State_

Constructor & Destructor Documentation

◆ Increment() [1/3]

◆ Increment() [2/3]

◆ Increment() [3/3]

◆ ~Increment()

Member Function Documentation

◆ accumul()

◆ axpy()

◆ classname()

◆ diff()

◆ dirac()

◆ dot_product_with()

◆ field_from_ug()

◆ field_to_ug()

◆ geometry()

◆ getValuesAD()

◆ getValuesTL()

◆ increment() [1/2]

◆ increment() [2/2]

◆ norm()

◆ operator*=()

◆ operator+=()

◆ operator-=()

◆ operator=()

◆ print()

◆ random()

◆ read()

◆ schur_product_with()

◆ ug_coord()

◆ updateTime()

◆ validTime()

◆ write()

◆ zero() [1/2]

◆ zero() [2/2]

Member Data Documentation

◆ increment_

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