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

#include <IncrementQG.h>

Inheritance diagram for qg::IncrementQG:

Collaboration diagram for qg::IncrementQG:

Public Member Functions
	IncrementQG (const GeometryQG &, const oops::Variables &, const util::DateTime &)
	Constructor, destructor. More...

	IncrementQG (const GeometryQG &, const IncrementQG &)

	IncrementQG (const IncrementQG &, const bool)

	IncrementQG (const IncrementQG &)

virtual	~IncrementQG ()

void	diff (const StateQG &, const StateQG &)
	Basic operators. More...

void	zero ()

void	zero (const util::DateTime &)

IncrementQG &	operator= (const IncrementQG &)

IncrementQG &	operator+= (const IncrementQG &)

IncrementQG &	operator-= (const IncrementQG &)

IncrementQG &	operator*= (const double &)

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

double	dot_product_with (const IncrementQG &) const

void	schur_product_with (const IncrementQG &)

void	random ()

void	dirac (const eckit::Configuration &)

void	getValuesTL (const LocationsQG &, const oops::Variables &, GomQG &, const Nothing &) const
	Get increment values at observation locations. More...

void	getValuesAD (const LocationsQG &, const oops::Variables &, const GomQG &, const Nothing &)

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

void	write (const eckit::Configuration &) const

double	norm () const

const util::DateTime &	validTime () const

util::DateTime &	validTime ()

void	updateTime (const util::Duration &dt)

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

void	field_to_ug (oops::UnstructuredGrid &, const int &) const

void	field_from_ug (const oops::UnstructuredGrid &)

FieldsQG &	fields ()
	Access to fields. More...

const FieldsQG &	fields () const

boost::shared_ptr< const GeometryQG >	geometry () const

void	accumul (const double &, const StateQG &)
	Other. More...

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

virtual	~GeneralizedDepartures ()

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

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

Private Attributes
boost::scoped_ptr< FieldsQG >	fields_

boost::scoped_ptr< FieldsQG >	stash_

Detailed Description

Increment Class: Difference between two states.

Some fields that are present in a State may not be present in an Increment. The Increment contains everything that is needed by the tangent-linear and adjoint models.

Definition at line 55 of file IncrementQG.h.

Constructor & Destructor Documentation

◆ IncrementQG() [1/4]

qg::IncrementQG::IncrementQG	(	const GeometryQG &	resol,
		const oops::Variables &	vars,
		const util::DateTime &	vt
	)

Constructor, destructor.

Definition at line 38 of file IncrementQG.cc.

◆ IncrementQG() [2/4]

qg::IncrementQG::IncrementQG	(	const GeometryQG &	resol,
		const IncrementQG &	other
	)

Definition at line 46 of file IncrementQG.cc.

◆ IncrementQG() [3/4]

qg::IncrementQG::IncrementQG	(	const IncrementQG &	other,
		const bool	copy
	)

Definition at line 52 of file IncrementQG.cc.

◆ IncrementQG() [4/4]

qg::IncrementQG::IncrementQG ( const IncrementQG & other )

Definition at line 58 of file IncrementQG.cc.

◆ ~IncrementQG()

qg::IncrementQG::~IncrementQG ( )

virtual

Definition at line 64 of file IncrementQG.cc.

Member Function Documentation

◆ accumul()

void qg::IncrementQG::accumul	(	const double &	zz,
		const StateQG &	xx
	)

Other.

Definition at line 115 of file IncrementQG.cc.

Here is the call graph for this function:

◆ axpy()

void qg::IncrementQG::axpy	(	const double &	zz,
		const IncrementQG &	dx,
		const bool	check = `true`
	)

Definition at line 109 of file IncrementQG.cc.

Here is the call graph for this function:

◆ classname()

static const std::string qg::IncrementQG::classname ( )

inlinestatic

Definition at line 59 of file IncrementQG.h.

◆ diff()

void qg::IncrementQG::diff	(	const StateQG &	x1,
		const StateQG &	x2
	)

Basic operators.

Definition at line 70 of file IncrementQG.cc.

Here is the call graph for this function:

◆ dirac()

void qg::IncrementQG::dirac ( const eckit::Configuration & config )

Definition at line 131 of file IncrementQG.cc.

◆ dot_product_with()

double qg::IncrementQG::dot_product_with ( const IncrementQG & other ) const

Definition at line 123 of file IncrementQG.cc.

◆ field_from_ug()

void qg::IncrementQG::field_from_ug ( const oops::UnstructuredGrid & ug )

Definition at line 157 of file IncrementQG.cc.

◆ field_to_ug()

void qg::IncrementQG::field_to_ug	(	oops::UnstructuredGrid &	ug,
		const int &	colocated
	)		const

Definition at line 153 of file IncrementQG.cc.

◆ fields() [1/2]

FieldsQG& qg::IncrementQG::fields ( )

inline

Access to fields.

Definition at line 102 of file IncrementQG.h.

Here is the caller graph for this function:

◆ fields() [2/2]

const FieldsQG& qg::IncrementQG::fields ( ) const

inline

Definition at line 103 of file IncrementQG.h.

◆ geometry()

boost::shared_ptr<const GeometryQG> qg::IncrementQG::geometry ( ) const

inline

Definition at line 105 of file IncrementQG.h.

◆ getValuesAD()

void qg::IncrementQG::getValuesAD	(	const LocationsQG &	locs,
		const oops::Variables &	vars,
		const GomQG &	cols,
		const Nothing &
	)

Definition at line 142 of file IncrementQG.cc.

◆ getValuesTL()

void qg::IncrementQG::getValuesTL	(	const LocationsQG &	locs,
		const oops::Variables &	vars,
		GomQG &	cols,
		const Nothing &
	)		const

Get increment values at observation locations.

Definition at line 137 of file IncrementQG.cc.

◆ norm()

double qg::IncrementQG::norm ( ) const

inline

Definition at line 91 of file IncrementQG.h.

◆ operator*=()

IncrementQG & qg::IncrementQG::operator*= ( const double & zz )

Definition at line 96 of file IncrementQG.cc.

◆ operator+=()

IncrementQG & qg::IncrementQG::operator+= ( const IncrementQG & dx )

Definition at line 84 of file IncrementQG.cc.

Here is the call graph for this function:

◆ operator-=()

IncrementQG & qg::IncrementQG::operator-= ( const IncrementQG & dx )

Definition at line 90 of file IncrementQG.cc.

Here is the call graph for this function:

◆ operator=()

IncrementQG & qg::IncrementQG::operator= ( const IncrementQG & rhs )

Definition at line 79 of file IncrementQG.cc.

◆ print()

void qg::IncrementQG::print ( std::ostream & os ) const

private

Data.

Definition at line 171 of file IncrementQG.cc.

Here is the call graph for this function:

◆ random()

void qg::IncrementQG::random ( )

Definition at line 127 of file IncrementQG.cc.

◆ read()

void qg::IncrementQG::read ( const eckit::Configuration & files )

I/O and diagnostics.

Definition at line 163 of file IncrementQG.cc.

◆ schur_product_with()

void qg::IncrementQG::schur_product_with ( const IncrementQG & dx )

Definition at line 119 of file IncrementQG.cc.

◆ ug_coord()

void qg::IncrementQG::ug_coord	(	oops::UnstructuredGrid &	ug,
		const int &	colocated
	)		const

Unstructured grid.

Definition at line 149 of file IncrementQG.cc.

◆ updateTime()

void qg::IncrementQG::updateTime ( const util::Duration & dt )

inline

Definition at line 94 of file IncrementQG.h.

Here is the caller graph for this function:

◆ validTime() [1/2]

const util::DateTime& qg::IncrementQG::validTime ( ) const

inline

Definition at line 92 of file IncrementQG.h.

Here is the caller graph for this function:

◆ validTime() [2/2]

util::DateTime& qg::IncrementQG::validTime ( )

inline

Definition at line 93 of file IncrementQG.h.

◆ write()

void qg::IncrementQG::write ( const eckit::Configuration & files ) const

Definition at line 167 of file IncrementQG.cc.

◆ zero() [1/2]

void qg::IncrementQG::zero ( )

Definition at line 101 of file IncrementQG.cc.

◆ zero() [2/2]

void qg::IncrementQG::zero ( const util::DateTime & vt )

Definition at line 105 of file IncrementQG.cc.

Member Data Documentation

◆ fields_

boost::scoped_ptr<FieldsQG> qg::IncrementQG::fields_

private

Definition at line 115 of file IncrementQG.h.

◆ stash_

boost::scoped_ptr<FieldsQG> qg::IncrementQG::stash_

private

Definition at line 116 of file IncrementQG.h.

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IncrementQG() [1/4]

◆ IncrementQG() [2/4]

◆ IncrementQG() [3/4]

◆ IncrementQG() [4/4]

◆ ~IncrementQG()

Member Function Documentation

◆ accumul()

◆ axpy()

◆ classname()

◆ diff()

◆ dirac()

◆ dot_product_with()

◆ field_from_ug()

◆ field_to_ug()

◆ fields() [1/2]

◆ fields() [2/2]

◆ geometry()

◆ getValuesAD()

◆ getValuesTL()

◆ norm()

◆ operator*=()

◆ operator+=()

◆ operator-=()

◆ operator=()

◆ print()

◆ random()

◆ read()

◆ schur_product_with()

◆ ug_coord()

◆ updateTime()

◆ validTime() [1/2]

◆ validTime() [2/2]

◆ write()

◆ zero() [1/2]

◆ zero() [2/2]

Member Data Documentation

◆ fields_

◆ stash_