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

#include <IncrementL95.h>

Inheritance diagram for lorenz95::IncrementL95:

Collaboration diagram for lorenz95::IncrementL95:

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

	IncrementL95 (const Resolution &, const IncrementL95 &)

	IncrementL95 (const IncrementL95 &, const bool)

virtual	~IncrementL95 ()

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

void	zero ()

void	zero (const util::DateTime &)

void	dirac (const eckit::Configuration &)

IncrementL95 &	operator= (const IncrementL95 &)

IncrementL95 &	operator+= (const IncrementL95 &)

IncrementL95 &	operator-= (const IncrementL95 &)

IncrementL95 &	operator*= (const double &)

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

double	dot_product_with (const IncrementL95 &) const

void	schur_product_with (const IncrementL95 &)

void	random ()

void	getValuesTL (const LocsL95 &, const oops::Variables &, GomL95 &, const Nothing &) const
	Get increment values at obs locations. More...

void	getValuesAD (const LocsL95 &, const oops::Variables &, const GomL95 &, const Nothing &)

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 &)

void	read (const eckit::Configuration &)
	Utilities. More...

void	write (const eckit::Configuration &) const

double	norm () const

const util::DateTime &	validTime () const

util::DateTime &	validTime ()

void	updateTime (const util::Duration &dt)

const FieldL95 &	getField () const
	Access to data. More...

FieldL95 &	getField ()

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

std::vector< double > &	asVector ()

const std::vector< double > &	asVector () const

void	accumul (const double &, const StateL95 &)

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

Private Attributes
FieldL95	fld_

util::DateTime	time_

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 51 of file IncrementL95.h.

Constructor & Destructor Documentation

◆ IncrementL95() [1/3]

lorenz95::IncrementL95::IncrementL95	(	const Resolution &	resol,
		const oops::Variables &	,
		const util::DateTime &	vt
	)

Constructor, destructor.

Definition at line 40 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

◆ IncrementL95() [2/3]

lorenz95::IncrementL95::IncrementL95	(	const Resolution &	resol,
		const IncrementL95 &	dx
	)

Definition at line 48 of file src/lorenz95/IncrementL95.cc.

◆ IncrementL95() [3/3]

lorenz95::IncrementL95::IncrementL95	(	const IncrementL95 &	dx,
		const bool	copy
	)

Definition at line 55 of file src/lorenz95/IncrementL95.cc.

◆ ~IncrementL95()

lorenz95::IncrementL95::~IncrementL95 ( )

virtual

Definition at line 61 of file src/lorenz95/IncrementL95.cc.

Member Function Documentation

◆ accumul()

void lorenz95::IncrementL95::accumul	(	const double &	zz,
		const StateL95 &	xx
	)

Definition at line 128 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

◆ asVector() [1/2]

std::vector<double>& lorenz95::IncrementL95::asVector ( )

inline

Definition at line 103 of file IncrementL95.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ asVector() [2/2]

const std::vector<double>& lorenz95::IncrementL95::asVector ( ) const

inline

Definition at line 104 of file IncrementL95.h.

Here is the call graph for this function:

◆ axpy()

void lorenz95::IncrementL95::axpy	(	const double &	zz,
		const IncrementL95 &	rhs,
		const bool	check = `true`
	)

Definition at line 109 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

◆ classname()

static const std::string lorenz95::IncrementL95::classname ( )

inlinestatic

Definition at line 55 of file IncrementL95.h.

◆ diff()

void lorenz95::IncrementL95::diff	(	const StateL95 &	x1,
		const StateL95 &	x2
	)

Basic operators.

Definition at line 67 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

◆ dirac()

void lorenz95::IncrementL95::dirac ( const eckit::Configuration & config )

Definition at line 105 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

◆ dot_product_with()

double lorenz95::IncrementL95::dot_product_with ( const IncrementL95 & other ) const

Definition at line 115 of file src/lorenz95/IncrementL95.cc.

◆ field_from_ug()

void lorenz95::IncrementL95::field_from_ug ( const oops::UnstructuredGrid & ug )

Definition at line 210 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

◆ field_to_ug()

void lorenz95::IncrementL95::field_to_ug	(	oops::UnstructuredGrid &	ug,
		const int &	colocated
	)		const

Definition at line 206 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

◆ geometry()

boost::shared_ptr<const Resolution> lorenz95::IncrementL95::geometry ( ) const

inline

Definition at line 99 of file IncrementL95.h.

Here is the call graph for this function:

◆ getField() [1/2]

const FieldL95& lorenz95::IncrementL95::getField ( ) const

inline

Access to data.

Definition at line 97 of file IncrementL95.h.

Here is the caller graph for this function:

◆ getField() [2/2]

FieldL95& lorenz95::IncrementL95::getField ( )

inline

Definition at line 98 of file IncrementL95.h.

◆ getValuesAD()

void lorenz95::IncrementL95::getValuesAD	(	const LocsL95 &	locs,
		const oops::Variables &	,
		const GomL95 &	vals,
		const Nothing &
	)

Definition at line 195 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

◆ getValuesTL()

void lorenz95::IncrementL95::getValuesTL	(	const LocsL95 &	locs,
		const oops::Variables &	,
		GomL95 &	vals,
		const Nothing &
	)		const

Get increment values at obs locations.

Definition at line 190 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

◆ norm()

double lorenz95::IncrementL95::norm ( ) const

inline

Definition at line 91 of file IncrementL95.h.

Here is the call graph for this function:

◆ operator*=()

IncrementL95 & lorenz95::IncrementL95::operator*= ( const double & zz )

Definition at line 91 of file src/lorenz95/IncrementL95.cc.

◆ operator+=()

IncrementL95 & lorenz95::IncrementL95::operator+= ( const IncrementL95 & rhs )

Definition at line 79 of file src/lorenz95/IncrementL95.cc.

◆ operator-=()

IncrementL95 & lorenz95::IncrementL95::operator-= ( const IncrementL95 & rhs )

Definition at line 85 of file src/lorenz95/IncrementL95.cc.

◆ operator=()

IncrementL95 & lorenz95::IncrementL95::operator= ( const IncrementL95 & rhs )

Definition at line 73 of file src/lorenz95/IncrementL95.cc.

◆ print()

void lorenz95::IncrementL95::print ( std::ostream & os ) const

private

Definition at line 183 of file src/lorenz95/IncrementL95.cc.

◆ random()

void lorenz95::IncrementL95::random ( )

Definition at line 124 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

void lorenz95::IncrementL95::read ( const eckit::Configuration & config )

Utilities.

Definition at line 134 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ schur_product_with()

void lorenz95::IncrementL95::schur_product_with ( const IncrementL95 & rhs )

Definition at line 120 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

◆ ug_coord()

void lorenz95::IncrementL95::ug_coord	(	oops::UnstructuredGrid &	ug,
		const int &	colocated
	)		const

Unstructured grid.

Convert to/from unstructured grid.

Definition at line 202 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

◆ updateTime()

void lorenz95::IncrementL95::updateTime ( const util::Duration & dt )

inline

Definition at line 94 of file IncrementL95.h.

◆ validTime() [1/2]

const util::DateTime& lorenz95::IncrementL95::validTime ( ) const

inline

Definition at line 92 of file IncrementL95.h.

Here is the caller graph for this function:

◆ validTime() [2/2]

util::DateTime& lorenz95::IncrementL95::validTime ( )

inline

Definition at line 93 of file IncrementL95.h.

◆ write()

void lorenz95::IncrementL95::write ( const eckit::Configuration & config ) const

Definition at line 159 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

◆ zero() [1/2]

void lorenz95::IncrementL95::zero ( )

Definition at line 96 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

◆ zero() [2/2]

void lorenz95::IncrementL95::zero ( const util::DateTime & vt )

Definition at line 100 of file src/lorenz95/IncrementL95.cc.

Here is the call graph for this function:

Member Data Documentation

◆ fld_

FieldL95 lorenz95::IncrementL95::fld_

private

Definition at line 110 of file IncrementL95.h.

◆ time_

util::DateTime lorenz95::IncrementL95::time_

private

Definition at line 111 of file IncrementL95.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

◆ IncrementL95() [1/3]

◆ IncrementL95() [2/3]

◆ IncrementL95() [3/3]

◆ ~IncrementL95()

Member Function Documentation

◆ accumul()

◆ asVector() [1/2]

◆ asVector() [2/2]

◆ axpy()

◆ classname()

◆ diff()

◆ dirac()

◆ dot_product_with()

◆ field_from_ug()

◆ field_to_ug()

◆ geometry()

◆ getField() [1/2]

◆ getField() [2/2]

◆ 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

◆ fld_

◆ time_