Auxiliary increment related to observations, templated on <OBS> More...

#include <ObsAuxIncrement.h>

Inheritance diagram for oops::ObsAuxIncrement< OBS >:

[legend]

Collaboration diagram for oops::ObsAuxIncrement< OBS >:

[legend]

Public Types
typedef ObsAuxIncrement_::Parameters_	Parameters_

Public Member Functions
	ObsAuxIncrement (const ObsSpace< OBS > &os, const Parameters_ &params)
	Constructor for specified ObsSpace `os` and `params`. More...

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

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

const ObsAuxIncrement_ &	obsauxincrement () const
	const Accessor More...

ObsAuxIncrement_ &	obsauxincrement ()
	Accessor. More...

void	diff (const ObsAuxControl_ &, const ObsAuxControl_ &)
	Sets this ObsAuxIncrement to the difference between two ObsAuxControl objects. More...

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

ObsAuxIncrement &	operator= (const ObsAuxIncrement &)
	Linear algebra operators. More...

ObsAuxIncrement &	operator+= (const ObsAuxIncrement &)

ObsAuxIncrement &	operator-= (const ObsAuxIncrement &)

ObsAuxIncrement &	operator*= (const double &)

void	axpy (const double &, const ObsAuxIncrement &)

double	dot_product_with (const ObsAuxIncrement &dx) const
	dot product with `dx` ObsAuxIncrement More...

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

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

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

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

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

Private Types
typedef OBS::ObsAuxIncrement	ObsAuxIncrement_

typedef ObsAuxControl< OBS >	ObsAuxControl_

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

Private Attributes
std::unique_ptr< ObsAuxIncrement_ >	aux_

Detailed Description

template<typename OBS>
class oops::ObsAuxIncrement< OBS >

Auxiliary increment related to observations, templated on <OBS>

This is currently only used for bias correction coefficient increments. This class calls the <OBS> implementation of ObsAuxIncrement.

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

Member Typedef Documentation

◆ ObsAuxControl_

template<typename OBS >

typedef ObsAuxControl<OBS> oops::ObsAuxIncrement< OBS >::ObsAuxControl_

private

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

◆ ObsAuxIncrement_

template<typename OBS >

typedef OBS::ObsAuxIncrement oops::ObsAuxIncrement< OBS >::ObsAuxIncrement_

private

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

◆ Parameters_

template<typename OBS >

typedef ObsAuxIncrement_::Parameters_ oops::ObsAuxIncrement< OBS >::Parameters_

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

Constructor & Destructor Documentation

◆ ObsAuxIncrement() [1/2]

template<typename OBS >

oops::ObsAuxIncrement< OBS >::ObsAuxIncrement	(	const ObsSpace< OBS > &	os,
		const Parameters_ &	params
	)

Constructor for specified ObsSpace os and params.

Definition at line 109 of file oops/interface/ObsAuxIncrement.h.

Here is the call graph for this function:

◆ ObsAuxIncrement() [2/2]

template<typename OBS >

oops::ObsAuxIncrement< OBS >::ObsAuxIncrement	(	const ObsAuxIncrement< OBS > &	other,
		const bool	copy = `true`
	)

Copies other if copy is true, otherwise creates zero ObsAuxIncrement of the same size as other.

Definition at line 120 of file oops/interface/ObsAuxIncrement.h.

Here is the call graph for this function:

◆ ~ObsAuxIncrement()

template<typename OBS >

oops::ObsAuxIncrement< OBS >::~ObsAuxIncrement

Destructor (defined explicitly for timing and tracing)

Definition at line 131 of file oops/interface/ObsAuxIncrement.h.

Member Function Documentation

◆ axpy()

template<typename OBS >

void oops::ObsAuxIncrement< OBS >::axpy	(	const double &	zz,
		const ObsAuxIncrement< OBS > &	dx
	)

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

◆ classname()

template<typename OBS >

static const std::string oops::ObsAuxIncrement< OBS >::classname ( )

inlinestatic

Definition at line 50 of file oops/interface/ObsAuxIncrement.h.

Here is the caller graph for this function:

◆ deserialize()

template<typename OBS >

void oops::ObsAuxIncrement< OBS >::deserialize	(	const std::vector< double > &	vect,
		size_t &	current
	)

override

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

◆ diff()

template<typename OBS >

void oops::ObsAuxIncrement< OBS >::diff	(	const ObsAuxControl_ &	x1,
		const ObsAuxControl_ &	x2
	)

Sets this ObsAuxIncrement to the difference between two ObsAuxControl objects.

Definition at line 139 of file oops/interface/ObsAuxIncrement.h.

Here is the call graph for this function:

◆ dot_product_with()

template<typename OBS >

double oops::ObsAuxIncrement< OBS >::dot_product_with ( const ObsAuxIncrement< OBS > & dx ) const

dot product with dx ObsAuxIncrement

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

◆ norm()

template<typename OBS >

double oops::ObsAuxIncrement< OBS >::norm

Norm (used in tests)

Definition at line 224 of file oops/interface/ObsAuxIncrement.h.

◆ obsauxincrement() [1/2]

template<typename OBS >

ObsAuxIncrement_& oops::ObsAuxIncrement< OBS >::obsauxincrement ( )

inline

Accessor.

Definition at line 63 of file oops/interface/ObsAuxIncrement.h.

◆ obsauxincrement() [2/2]

template<typename OBS >

const ObsAuxIncrement_& oops::ObsAuxIncrement< OBS >::obsauxincrement ( ) const

inline

const Accessor

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

Here is the caller graph for this function:

◆ operator*=()

template<typename OBS >

ObsAuxIncrement< OBS > & oops::ObsAuxIncrement< OBS >::operator*= ( const double & zz )

Definition at line 182 of file oops/interface/ObsAuxIncrement.h.

◆ operator+=()

template<typename OBS >

ObsAuxIncrement< OBS > & oops::ObsAuxIncrement< OBS >::operator+= ( const ObsAuxIncrement< OBS > & rhs )

Definition at line 164 of file oops/interface/ObsAuxIncrement.h.

◆ operator-=()

template<typename OBS >

ObsAuxIncrement< OBS > & oops::ObsAuxIncrement< OBS >::operator-= ( const ObsAuxIncrement< OBS > & rhs )

Definition at line 173 of file oops/interface/ObsAuxIncrement.h.

◆ operator=()

template<typename OBS >

ObsAuxIncrement< OBS > & oops::ObsAuxIncrement< OBS >::operator= ( const ObsAuxIncrement< OBS > & rhs )

Linear algebra operators.

Definition at line 155 of file oops/interface/ObsAuxIncrement.h.

◆ print()

template<typename OBS >

void oops::ObsAuxIncrement< OBS >::print ( std::ostream & os ) const

overrideprivate

Definition at line 256 of file oops/interface/ObsAuxIncrement.h.

◆ read()

template<typename OBS >

void oops::ObsAuxIncrement< OBS >::read ( const eckit::Configuration & conf )

Read this ObsAuxIncrement from file.

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

◆ serialize()

template<typename OBS >

void oops::ObsAuxIncrement< OBS >::serialize ( std::vector< double > & vect ) const

override

Definition at line 240 of file oops/interface/ObsAuxIncrement.h.

◆ serialSize()

template<typename OBS >

size_t oops::ObsAuxIncrement< OBS >::serialSize

override

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

Definition at line 233 of file oops/interface/ObsAuxIncrement.h.

◆ write()

template<typename OBS >

void oops::ObsAuxIncrement< OBS >::write ( const eckit::Configuration & conf ) const

Write this ObsAuxIncrement out to file.

Definition at line 216 of file oops/interface/ObsAuxIncrement.h.

◆ zero()

template<typename OBS >

void oops::ObsAuxIncrement< OBS >::zero

Zero out this ObsAuxIncrement.

Definition at line 147 of file oops/interface/ObsAuxIncrement.h.

Member Data Documentation

◆ aux_

template<typename OBS >

std::unique_ptr<ObsAuxIncrement_> oops::ObsAuxIncrement< OBS >::aux_

private

Definition at line 92 of file oops/interface/ObsAuxIncrement.h.

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

oops/interface/ObsAuxIncrement.h

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

template<typename OBS> class oops::ObsAuxIncrement< OBS >

Member Typedef Documentation

◆ ObsAuxControl_

◆ ObsAuxIncrement_

◆ Parameters_

Constructor & Destructor Documentation

◆ ObsAuxIncrement() [1/2]

◆ ObsAuxIncrement() [2/2]

◆ ~ObsAuxIncrement()

Member Function Documentation

◆ axpy()

◆ classname()

◆ deserialize()

◆ diff()

◆ dot_product_with()

◆ norm()

◆ obsauxincrement() [1/2]

◆ obsauxincrement() [2/2]

◆ operator*=()

◆ operator+=()

◆ operator-=()

◆ operator=()

◆ print()

◆ read()

◆ serialize()

◆ serialSize()

◆ write()

◆ zero()

Member Data Documentation

◆ aux_

template<typename OBS>
class oops::ObsAuxIncrement< OBS >