#include <Increment.h>

Inheritance diagram for oops::interface::Increment< MODEL >:

[legend]

Collaboration diagram for oops::interface::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 &, 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 ()

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

Protected Attributes
std::unique_ptr< Increment_ >	increment_

Private Types
typedef MODEL::Increment	Increment_

typedef oops::Geometry< MODEL >	Geometry_

typedef GeometryIterator< MODEL >	GeometryIterator_

typedef oops::State< MODEL >	State_

Private Member Functions
void	print (std::ostream &) const override
	pointer to the Increment implementation More...

Detailed Description

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

Increment: Difference between two model 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 oops::Geometry<MODEL> oops::interface::Increment< MODEL >::Geometry_

private

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

◆ GeometryIterator_

template<typename MODEL >

typedef GeometryIterator<MODEL> oops::interface::Increment< MODEL >::GeometryIterator_

private

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

◆ Increment_

template<typename MODEL >

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

private

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

◆ State_

template<typename MODEL >

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

private

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

Constructor & Destructor Documentation

◆ Increment() [1/3]

template<typename MODEL >

oops::interface::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 148 of file oops/interface/Increment.h.

Here is the call graph for this function:

◆ Increment() [2/3]

template<typename MODEL >

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

Copies other increment, changing its resolution to geometry.

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

Here is the call graph for this function:

◆ Increment() [3/3]

template<typename MODEL >

oops::interface::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 175 of file oops/interface/Increment.h.

Here is the call graph for this function:

◆ ~Increment()

template<typename MODEL >

oops::interface::Increment< MODEL >::~Increment

virtual

Destructor (defined explicitly for timing and tracing)

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

Member Function Documentation

◆ accumul()

template<typename MODEL >

void oops::interface::Increment< MODEL >::accumul	(	const double &	w,
		const State_ &	x
	)

Accumulate (add w * x to the increment), used in WeightedDiff with Accumulator.

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

Here is the call graph for this function:

◆ axpy()

template<typename MODEL >

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

Add w * dx to the Increment. If check is set, check whether this and dx's dates are the same

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

Here is the caller graph for this function:

◆ classname()

template<typename MODEL >

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

inlinestatic

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

Here is the caller graph for this function:

◆ deserialize()

template<typename MODEL >

void oops::interface::Increment< MODEL >::deserialize	(	const std::vector< double > &	vect,
		size_t &	current
	)

override

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

◆ diff()

template<typename MODEL >

void oops::interface::Increment< MODEL >::diff	(	const State_ &	state1,
		const State_ &	state2
	)

Set this Increment to be difference between state1 and state2.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dirac()

template<typename MODEL >

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

Set Increment according to the configuration (used in Dirac application)

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

Here is the caller graph for this function:

◆ dot_product_with()

template<typename MODEL >

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

Compute dot product of this Increment with other.

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

Here is the caller graph for this function:

◆ fromAtlas()

template<typename MODEL >

void oops::interface::Increment< MODEL >::fromAtlas ( atlas::FieldSet * atlasFieldSet )

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

◆ geometry()

template<typename MODEL >

oops::Geometry< MODEL > oops::interface::Increment< MODEL >::geometry

Accessor to geometry associated with this Increment.

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

Here is the caller graph for this function:

◆ getLocal()

template<typename MODEL >

LocalIncrement oops::interface::Increment< MODEL >::getLocal ( const GeometryIterator_ & iter ) const

Get local (at iter local volume) increment (used in LocalEnsembleSolver)

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

Here is the call graph for this function:

◆ increment() [1/2]

template<typename MODEL >

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

inline

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

Here is the caller graph for this function:

◆ increment() [2/2]

template<typename MODEL >

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

inline

Accessor to MODEL::Increment, used in the other interface classes in oops. Does not need to be implemented.

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

Here is the caller graph for this function:

◆ norm()

template<typename MODEL >

double oops::interface::Increment< MODEL >::norm

Norm (used in tests)

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

Here is the caller graph for this function:

◆ ones()

template<typename MODEL >

void oops::interface::Increment< MODEL >::ones

Set this Increment to ones (used in tests)

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

◆ operator*=()

template<typename MODEL >

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

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

◆ operator+=()

template<typename MODEL >

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

Linear algebra operators.

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

◆ operator-=()

template<typename MODEL >

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

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

◆ operator=()

template<typename MODEL >

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

Assignment operator.

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

◆ print()

template<typename MODEL >

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

overrideprivatevirtual

pointer to the Increment implementation

Implements oops::GeneralizedDepartures.

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

◆ random()

template<typename MODEL >

void oops::interface::Increment< MODEL >::random

Randomize the Increment (used in tests)

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

◆ read()

template<typename MODEL >

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

Read this Increment from file.

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

Here is the caller graph for this function:

◆ schur_product_with()

template<typename MODEL >

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

Compute Schur product of this Increment with other, assign to this Increment.

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

Here is the caller graph for this function:

◆ serialize()

template<typename MODEL >

void oops::interface::Increment< MODEL >::serialize ( std::vector< double > & vect ) const

override

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

◆ serialSize()

template<typename MODEL >

size_t oops::interface::Increment< MODEL >::serialSize

override

Serialize and deserialize (used in 4DEnVar, weak-constraint 4DVar and Block-Lanczos minimizer)

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

◆ setAtlas()

template<typename MODEL >

void oops::interface::Increment< MODEL >::setAtlas ( atlas::FieldSet * atlasFieldSet ) const

ATLAS FieldSet interface (used to communicate data with SABER) For models that are not using ATLAS fields for their own Increment data:

"setAtlas" allocates the ATLAS fields based on the variables present in the Increment.
"toAtlas" allocates the ATLAS fields if necessary and copies Increment data into ATLAS fields.
"fromAtlas" copies ATLAS fields data into the Increment. For models that are using ATLAS fields for their own Incerment data
"setAtlas" copies ATLAS fields pointers from the Increment to the ATLAS fieldset.
"toAtlas" copies data if ATLAS fields pointers in the Increment and the ATLAS fieldset are different, and does nothing if pointers are the same.
"fromAtlas" does nothing.

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

Here is the caller graph for this function:

◆ setLocal()

template<typename MODEL >

void oops::interface::Increment< MODEL >::setLocal	(	const LocalIncrement< MODEL > &	gp,
		const GeometryIterator_ &	iter
	)

Set local (at iter local volume) increment to be gp (used in LocalEnsembleSolver)

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

Here is the call graph for this function:

◆ toAtlas()

template<typename MODEL >

void oops::interface::Increment< MODEL >::toAtlas ( atlas::FieldSet * atlasFieldSet ) const

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

Here is the caller graph for this function:

◆ updateTime()

template<typename MODEL >

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

inline

Updates this Increment's valid time by dt (used in PseudoModel)

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

Here is the caller graph for this function:

◆ validTime()

template<typename MODEL >

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

inline

Accessor to the time of this Increment.

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

Here is the caller graph for this function:

◆ write()

template<typename MODEL >

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

Write this Increment out to file.

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

Here is the caller graph for this function:

◆ zero() [1/2]

template<typename MODEL >

void oops::interface::Increment< MODEL >::zero

Zero out this Increment.

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

Here is the caller graph for this function:

◆ zero() [2/2]

template<typename MODEL >

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

Zero out this Increment and set its date to date.

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

Member Data Documentation

◆ increment_

template<typename MODEL >

std::unique_ptr<Increment_> oops::interface::Increment< MODEL >::increment_

protected

Definition at line 139 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

Protected Attributes

Private Types

Private Member Functions

Detailed Description

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

Member Typedef Documentation

◆ Geometry_

◆ GeometryIterator_

◆ Increment_

◆ State_

Constructor & Destructor Documentation

◆ Increment() [1/3]

◆ Increment() [2/3]

◆ Increment() [3/3]

◆ ~Increment()

Member Function Documentation

◆ accumul()

◆ axpy()

◆ classname()

◆ deserialize()

◆ diff()

◆ dirac()

◆ dot_product_with()

◆ fromAtlas()

◆ geometry()

◆ getLocal()

◆ increment() [1/2]

◆ increment() [2/2]

◆ norm()

◆ ones()

◆ operator*=()

◆ operator+=()

◆ operator-=()

◆ operator=()

◆ print()

◆ random()

◆ read()

◆ schur_product_with()

◆ serialize()

◆ serialSize()

◆ setAtlas()

◆ setLocal()

◆ toAtlas()

◆ updateTime()

◆ validTime()

◆ write()

◆ zero() [1/2]

◆ zero() [2/2]

Member Data Documentation

◆ increment_

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