#include <Increment.h>

Inheritance diagram for oops::Increment< MODEL >:

[legend]

Collaboration diagram for oops::Increment< MODEL >:

[legend]

Public Member Functions
	Increment (const Geometry_ &geometry, const Variables &variables, const util::DateTime &date)
	Constructor for specified `geometry`, with `variables`, valid on `date`. More...

	Increment (const Geometry_ &geometry, const Increment &other)
	Copies `other` increment, changing its resolution to `geometry`. More...

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

const eckit::mpi::Comm &	timeComm () const
	Accessor to the time communicator. More...

const Variables &	variables () const
	Accessor to Variables stored in this increment. More...

void	shift_forward (const util::DateTime &dt)
	Shift forward in time by `dt`. More...

void	shift_backward (const util::DateTime &dt)
	Shift backward in time by `dt`. More...

void	toAtlas ()
	Set ATLAS fieldset associated with this Increment internally. More...

atlas::FieldSet &	atlas ()
	Accessors to the ATLAS fieldset. More...

const atlas::FieldSet &	atlas () const

double	dot_product_with (const Increment &other) const
	dot product with the `other` increment More...

double	norm () const
	Norm for diagnostics. More...

Public Member Functions inherited from oops::interface::Increment< MODEL >
	Increment (const Geometry_ &geometry, const Variables &variables, const util::DateTime &date)
	Constructor for specified `geometry`, with `variables`, valid on `date`. More...

	Increment (const Geometry_ &geometry, const Increment &other)
	Copies `other` increment, changing its resolution to `geometry`. More...

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

virtual	~Increment ()
	Destructor (defined explicitly for timing and tracing) More...

void	diff (const State_ &state1, const State_ &state2)
	Set this Increment to be difference between `state1` and `state2`. More...

const util::DateTime	validTime () const
	Accessor to the time of this Increment. More...

void	updateTime (const util::Duration &dt)
	Updates this Increment's valid time by `dt` (used in PseudoModel) More...

void	zero ()
	Zero out this Increment. More...

void	zero (const util::DateTime &date)
	Zero out this Increment and set its date to `date`. More...

void	ones ()
	Set this Increment to ones (used in tests) More...

void	dirac (const eckit::Configuration &)
	Set Increment according to the configuration (used in Dirac application) More...

Increment &	operator= (const Increment &)
	Assignment operator. More...

Increment &	operator+= (const Increment &)
	Linear algebra operators. More...

Increment &	operator-= (const Increment &)

Increment &	operator*= (const double &)

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

double	dot_product_with (const Increment &other) const
	Compute dot product of this Increment with `other`. More...

void	schur_product_with (const Increment &other)
	Compute Schur product of this Increment with `other`, assign to this Increment. More...

void	random ()
	Randomize the Increment (used in tests) More...

void	accumul (const double &w, const State_ &x)
	Accumulate (add `w` * `x` to the increment), used in WeightedDiff with Accumulator. More...

void	read (const eckit::Configuration &)
	Read this Increment from file. More...

void	write (const eckit::Configuration &) const
	Write this Increment out to file. More...

double	norm () const
	Norm (used in tests) More...

LocalIncrement	getLocal (const GeometryIterator_ &iter) const
	Get local (at `iter` local volume) increment (used in LocalEnsembleSolver) More...

void	setLocal (const LocalIncrement &gp, const GeometryIterator_ &iter)
	Set local (at `iter` local volume) increment to be `gp` (used in LocalEnsembleSolver) More...

Geometry_	geometry () const
	Accessor to geometry associated with this Increment. More...

void	setAtlas (atlas::FieldSet *) const

void	toAtlas (atlas::FieldSet *) const

void	fromAtlas (atlas::FieldSet *)

size_t	serialSize () const override
	Serialize and deserialize (used in 4DEnVar, weak-constraint 4DVar and Block-Lanczos minimizer) More...

void	serialize (std::vector< double > &) const override

void	deserialize (const std::vector< double > &, size_t &) override

const Increment_ &	increment () const

Increment_ &	increment ()

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

virtual	~GeneralizedDepartures ()

Private Types
typedef Geometry< MODEL >	Geometry_

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

Private Attributes
Variables	variables_

const eckit::mpi::Comm *	timeComm_
	Variables stored in this Increment. More...

atlas::FieldSet	atlasFieldSet_
	pointer to the MPI communicator in time More...

Additional Inherited Members
Static Public Member Functions inherited from oops::interface::Increment< MODEL >
static const std::string	classname ()

Protected Attributes inherited from oops::interface::Increment< MODEL >
std::unique_ptr< Increment_ >	increment_

Detailed Description

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

Increment class used in oops.

Adds extra methods that do not need to be implemented in the model implementations:

timeComm() (accessor to the MPI communicator in time - collection of processes holding the data needed to represent the state in a particular region of space X_i and throughout the whole time interval for which DA is done)
variables() (accessor to variables in this Increment)
shift_forward
shift_backward
toAtlas, atlas

Adds communication through time to the following Increment methods:

dot_product_with
norm
print

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

Member Typedef Documentation

◆ Geometry_

template<typename MODEL >

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

private

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

Constructor & Destructor Documentation

◆ Increment() [1/3]

template<typename MODEL >

oops::Increment< MODEL >::Increment	(	const Geometry_ &	geometry,
		const Variables &	variables,
		const util::DateTime &	date
	)

Constructor for specified geometry, with variables, valid on date.

Definition at line 93 of file oops/base/Increment.h.

◆ Increment() [2/3]

template<typename MODEL >

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

Copies other increment, changing its resolution to geometry.

Definition at line 102 of file oops/base/Increment.h.

◆ Increment() [3/3]

template<typename MODEL >

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

Creates Increment with the same geometry and variables as other. Copies other if copy is true, otherwise creates zero increment

Definition at line 110 of file oops/base/Increment.h.

Member Function Documentation

◆ atlas() [1/2]

template<typename MODEL >

atlas::FieldSet& oops::Increment< MODEL >::atlas ( )

inline

Accessors to the ATLAS fieldset.

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

◆ atlas() [2/2]

template<typename MODEL >

const atlas::FieldSet& oops::Increment< MODEL >::atlas ( ) const

inline

Definition at line 75 of file oops/base/Increment.h.

◆ dot_product_with()

template<typename MODEL >

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

dot product with the other increment

Definition at line 118 of file oops/base/Increment.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ norm()

template<typename MODEL >

double oops::Increment< MODEL >::norm

Norm for diagnostics.

Definition at line 127 of file oops/base/Increment.h.

Here is the call graph for this function:

◆ print()

template<typename MODEL >

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

overrideprivatevirtual

Implements oops::GeneralizedDepartures.

Definition at line 195 of file oops/base/Increment.h.

◆ shift_backward()

template<typename MODEL >

void oops::Increment< MODEL >::shift_backward ( const util::DateTime & dt )

Shift backward in time by dt.

Definition at line 162 of file oops/base/Increment.h.

Here is the call graph for this function:

◆ shift_forward()

template<typename MODEL >

void oops::Increment< MODEL >::shift_forward ( const util::DateTime & dt )

Shift forward in time by dt.

Definition at line 138 of file oops/base/Increment.h.

Here is the call graph for this function:

◆ timeComm()

template<typename MODEL >

const eckit::mpi::Comm& oops::Increment< MODEL >::timeComm ( ) const

inline

Accessor to the time communicator.

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

Here is the caller graph for this function:

◆ toAtlas()

template<typename MODEL >

void oops::Increment< MODEL >::toAtlas

Set ATLAS fieldset associated with this Increment internally.

Definition at line 186 of file oops/base/Increment.h.

Here is the call graph for this function:

◆ variables()

template<typename MODEL >

const Variables& oops::Increment< MODEL >::variables ( ) const

inline

Accessor to Variables stored in this increment.

Definition at line 62 of file oops/base/Increment.h.

Member Data Documentation

◆ atlasFieldSet_

template<typename MODEL >

atlas::FieldSet oops::Increment< MODEL >::atlasFieldSet_

private

pointer to the MPI communicator in time

Definition at line 87 of file oops/base/Increment.h.

◆ timeComm_

template<typename MODEL >

const eckit::mpi::Comm* oops::Increment< MODEL >::timeComm_

private

Variables stored in this Increment.

Definition at line 86 of file oops/base/Increment.h.

◆ variables_

template<typename MODEL >

Variables oops::Increment< MODEL >::variables_

private

Definition at line 85 of file oops/base/Increment.h.

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ Geometry_

Constructor & Destructor Documentation

◆ Increment() [1/3]

◆ Increment() [2/3]

◆ Increment() [3/3]

Member Function Documentation

◆ atlas() [1/2]

◆ atlas() [2/2]

◆ dot_product_with()

◆ norm()

◆ print()

◆ shift_backward()

◆ shift_forward()

◆ timeComm()

◆ toAtlas()

◆ variables()

Member Data Documentation

◆ atlasFieldSet_

◆ timeComm_

◆ variables_

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