Difference between two observation vectors. More...

#include <Departures.h>

Inheritance diagram for oops::Departures< MODEL >:

Collaboration diagram for oops::Departures< MODEL >:

Public Member Functions
	Departures (const ObsSpace_ &)

	Departures (std::vector< boost::shared_ptr< ObsVector_ > >)

	Departures (const Departures &)

	~Departures ()

std::size_t	size () const
	Access. More...

ObsVector_ &	operator[] (const std::size_t ii)

const ObsVector_ &	operator[] (const std::size_t ii) const

Departures &	operator= (const Departures &)

Departures &	operator+= (const Departures &)

Departures &	operator-= (const Departures &)

Departures &	operator*= (const double &)

Departures &	operator*= (const Departures &)

Departures &	operator/= (const Departures &)

void	zero ()

void	invert ()

void	axpy (const double &, const Departures &)

double	dot_product_with (const Departures &) const

void	save (const std::string &) const
	Save departures values. More...

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

virtual	~GeneralizedDepartures ()

Private Types
typedef GeoVaLs< MODEL >	GeoVaLs_

typedef ObsAuxIncrement< MODEL >	ObsAuxIncr_

typedef ObsErrorBase< MODEL >	ObsErrorBase_

typedef LinearObsOperator< MODEL >	LinearObsOperator_

typedef ObsSpaces< MODEL >	ObsSpace_

typedef ObsVector< MODEL >	ObsVector_

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

Private Attributes
std::vector< boost::shared_ptr< ObsVector_ > >	dep_

Detailed Description

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

Difference between two observation vectors.

A departure is the difference between two observations. The archetypal example is \( \mathbf{y} - {\cal H}(\mathbf{x}) \).

Keeping an observation space vector here is necessary for the implementation of generic observation error covariance matrices.

Definition at line 36 of file Departures.h.

Member Typedef Documentation

◆ GeoVaLs_

template<typename MODEL >

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

private

Definition at line 51 of file Departures.h.

◆ LinearObsOperator_

template<typename MODEL >

typedef LinearObsOperator<MODEL> oops::Departures< MODEL >::LinearObsOperator_

private

Definition at line 54 of file Departures.h.

◆ ObsAuxIncr_

template<typename MODEL >

typedef ObsAuxIncrement<MODEL> oops::Departures< MODEL >::ObsAuxIncr_

private

Definition at line 52 of file Departures.h.

◆ ObsErrorBase_

template<typename MODEL >

typedef ObsErrorBase<MODEL> oops::Departures< MODEL >::ObsErrorBase_

private

Definition at line 53 of file Departures.h.

◆ ObsSpace_

template<typename MODEL >

typedef ObsSpaces<MODEL> oops::Departures< MODEL >::ObsSpace_

private

Definition at line 55 of file Departures.h.

◆ ObsVector_

template<typename MODEL >

typedef ObsVector<MODEL> oops::Departures< MODEL >::ObsVector_

private

Definition at line 56 of file Departures.h.

Constructor & Destructor Documentation

◆ Departures() [1/3]

template<typename MODEL >

oops::Departures< MODEL >::Departures ( const ObsSpace_ & obsgeom )

explicit

Definition at line 94 of file Departures.h.

Here is the call graph for this function:

◆ Departures() [2/3]

template<typename MODEL >

oops::Departures< MODEL >::Departures ( std::vector< boost::shared_ptr< ObsVector_ > > val )

explicit

Definition at line 104 of file Departures.h.

◆ Departures() [3/3]

template<typename MODEL >

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

explicit

Definition at line 111 of file Departures.h.

◆ ~Departures()

template<typename MODEL >

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

Definition at line 122 of file Departures.h.

Member Function Documentation

◆ axpy()

template<typename MODEL >

void oops::Departures< MODEL >::axpy	(	const double &	zz,
		const Departures< MODEL > &	rhs
	)

Definition at line 189 of file Departures.h.

◆ dot_product_with()

template<typename MODEL >

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

Definition at line 196 of file Departures.h.

◆ invert()

template<typename MODEL >

void oops::Departures< MODEL >::invert ( )

Definition at line 182 of file Departures.h.

◆ operator*=() [1/2]

template<typename MODEL >

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

Definition at line 151 of file Departures.h.

◆ operator*=() [2/2]

template<typename MODEL >

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

Definition at line 159 of file Departures.h.

◆ operator+=()

template<typename MODEL >

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

Definition at line 135 of file Departures.h.

◆ operator-=()

template<typename MODEL >

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

Definition at line 143 of file Departures.h.

◆ operator/=()

template<typename MODEL >

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

Definition at line 167 of file Departures.h.

◆ operator=()

template<typename MODEL >

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

Definition at line 127 of file Departures.h.

◆ operator[]() [1/2]

template<typename MODEL >

ObsVector_& oops::Departures< MODEL >::operator[] ( const std::size_t ii )

inline

Definition at line 67 of file Departures.h.

◆ operator[]() [2/2]

template<typename MODEL >

const ObsVector_& oops::Departures< MODEL >::operator[] ( const std::size_t ii ) const

inline

Definition at line 68 of file Departures.h.

◆ print()

template<typename MODEL >

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

private

Definition at line 212 of file Departures.h.

◆ save()

template<typename MODEL >

void oops::Departures< MODEL >::save ( const std::string & name ) const

Save departures values.

Definition at line 205 of file Departures.h.

Here is the caller graph for this function:

◆ size()

template<typename MODEL >

std::size_t oops::Departures< MODEL >::size ( ) const

inline

Access.

Definition at line 66 of file Departures.h.

Here is the caller graph for this function:

◆ zero()

template<typename MODEL >

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

Definition at line 175 of file Departures.h.

Here is the caller graph for this function:

Member Data Documentation

◆ dep_

template<typename MODEL >

std::vector<boost::shared_ptr<ObsVector_> > oops::Departures< MODEL >::dep_

private

Definition at line 88 of file Departures.h.

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

Departures.h

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ GeoVaLs_

◆ LinearObsOperator_

◆ ObsAuxIncr_

◆ ObsErrorBase_

◆ ObsSpace_

◆ ObsVector_

Constructor & Destructor Documentation

◆ Departures() [1/3]

◆ Departures() [2/3]

◆ Departures() [3/3]

◆ ~Departures()

Member Function Documentation

◆ axpy()

◆ dot_product_with()

◆ invert()

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=()

◆ operator-=()

◆ operator/=()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ print()

◆ save()

◆ size()

◆ zero()

Member Data Documentation

◆ dep_

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