#include <ControlIncrement.h>

Inheritance diagram for oops::ControlIncrement< MODEL >:

Collaboration diagram for oops::ControlIncrement< MODEL >:

Public Member Functions
	ControlIncrement (const JbTotal_ &)
	Constructor, destructor. More...

	ControlIncrement (const ControlIncrement &, const bool copy=true)

	ControlIncrement (const ControlIncrement &, const eckit::Configuration &)

	ControlIncrement (const Geometry_ &, const ControlIncrement &)

	~ControlIncrement ()

void	zero ()
	Linear algebra operators. More...

ControlIncrement &	operator= (const ControlIncrement &)

ControlIncrement &	operator+= (const ControlIncrement &)

ControlIncrement &	operator-= (const ControlIncrement &)

ControlIncrement &	operator*= (const double)

void	axpy (const double, const ControlIncrement &)

double	dot_product_with (const ControlIncrement &) const

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

void	write (const eckit::Configuration &) const

Geometry_	geometry () const
	Get geometry. More...

Increment4D_ &	state ()
	Get state control variable. More...

const Increment4D_ &	state () const

ModelAuxIncr_ &	modVar ()
	Get augmented model control variable. More...

const ModelAuxIncr_ &	modVar () const

ObsAuxIncr_ &	obsVar ()
	Get augmented observation control variable. More...

const ObsAuxIncr_ &	obsVar () const

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

Private Types
typedef CostJbTotal< MODEL >	JbTotal_

typedef Geometry< MODEL >	Geometry_

typedef Increment4D< MODEL >	Increment4D_

typedef ModelAuxIncrement< MODEL >	ModelAuxIncr_

typedef ObsAuxIncrement< MODEL >	ObsAuxIncr_

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

Private Attributes
Increment4D_	incrm4d_

ModelAuxIncr_	modbias_

ObsAuxIncr_	obsbias_

Detailed Description

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

Definition at line 43 of file ControlIncrement.h.

Member Typedef Documentation

◆ Geometry_

template<typename MODEL>

typedef Geometry<MODEL> oops::ControlIncrement< MODEL >::Geometry_

private

Definition at line 50 of file ControlIncrement.h.

◆ Increment4D_

template<typename MODEL>

typedef Increment4D<MODEL> oops::ControlIncrement< MODEL >::Increment4D_

private

Definition at line 51 of file ControlIncrement.h.

◆ JbTotal_

template<typename MODEL>

typedef CostJbTotal<MODEL> oops::ControlIncrement< MODEL >::JbTotal_

private

Definition at line 49 of file ControlIncrement.h.

◆ ModelAuxIncr_

template<typename MODEL>

typedef ModelAuxIncrement<MODEL> oops::ControlIncrement< MODEL >::ModelAuxIncr_

private

Definition at line 52 of file ControlIncrement.h.

◆ ObsAuxIncr_

template<typename MODEL>

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

private

Definition at line 53 of file ControlIncrement.h.

Constructor & Destructor Documentation

◆ ControlIncrement() [1/4]

template<typename MODEL >

oops::ControlIncrement< MODEL >::ControlIncrement ( const JbTotal_ & jb )

explicit

Constructor, destructor.

Definition at line 103 of file ControlIncrement.h.

◆ ControlIncrement() [2/4]

template<typename MODEL >

oops::ControlIncrement< MODEL >::ControlIncrement	(	const ControlIncrement< MODEL > &	other,
		const bool	copy = `true`
	)

Definition at line 111 of file ControlIncrement.h.

◆ ControlIncrement() [3/4]

template<typename MODEL >

oops::ControlIncrement< MODEL >::ControlIncrement	(	const ControlIncrement< MODEL > &	other,
		const eckit::Configuration &	tlConf
	)

Definition at line 119 of file ControlIncrement.h.

◆ ControlIncrement() [4/4]

template<typename MODEL >

oops::ControlIncrement< MODEL >::ControlIncrement	(	const Geometry_ &	geom,
		const ControlIncrement< MODEL > &	other
	)

Definition at line 128 of file ControlIncrement.h.

◆ ~ControlIncrement()

template<typename MODEL >

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

Definition at line 137 of file ControlIncrement.h.

Member Function Documentation

◆ axpy()

template<typename MODEL >

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

Definition at line 179 of file ControlIncrement.h.

Here is the caller graph for this function:

◆ classname()

template<typename MODEL>

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

inlinestatic

Definition at line 56 of file ControlIncrement.h.

◆ dot_product_with()

template<typename MODEL >

double oops::ControlIncrement< MODEL >::dot_product_with ( const ControlIncrement< MODEL > & x2 ) const

Definition at line 207 of file ControlIncrement.h.

◆ geometry()

template<typename MODEL>

Geometry_ oops::ControlIncrement< MODEL >::geometry ( ) const

inline

Get geometry.

Definition at line 79 of file ControlIncrement.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modVar() [1/2]

template<typename MODEL>

ModelAuxIncr_& oops::ControlIncrement< MODEL >::modVar ( )

inline

Get augmented model control variable.

Definition at line 86 of file ControlIncrement.h.

Here is the caller graph for this function:

◆ modVar() [2/2]

template<typename MODEL>

const ModelAuxIncr_& oops::ControlIncrement< MODEL >::modVar ( ) const

inline

Definition at line 87 of file ControlIncrement.h.

◆ obsVar() [1/2]

template<typename MODEL>

ObsAuxIncr_& oops::ControlIncrement< MODEL >::obsVar ( )

inline

Get augmented observation control variable.

Definition at line 90 of file ControlIncrement.h.

Here is the caller graph for this function:

◆ obsVar() [2/2]

template<typename MODEL>

const ObsAuxIncr_& oops::ControlIncrement< MODEL >::obsVar ( ) const

inline

Definition at line 91 of file ControlIncrement.h.

◆ operator*=()

template<typename MODEL >

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

Definition at line 164 of file ControlIncrement.h.

◆ operator+=()

template<typename MODEL >

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

Definition at line 148 of file ControlIncrement.h.

◆ operator-=()

template<typename MODEL >

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

Definition at line 156 of file ControlIncrement.h.

◆ operator=()

template<typename MODEL >

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

Definition at line 140 of file ControlIncrement.h.

◆ print()

template<typename MODEL >

void oops::ControlIncrement< MODEL >::print ( std::ostream & outs ) const

private

Definition at line 200 of file ControlIncrement.h.

◆ read()

template<typename MODEL >

void oops::ControlIncrement< MODEL >::read ( const eckit::Configuration & config )

I/O and diagnostics.

Definition at line 186 of file ControlIncrement.h.

◆ state() [1/2]

template<typename MODEL>

Increment4D_& oops::ControlIncrement< MODEL >::state ( )

inline

Get state control variable.

Definition at line 82 of file ControlIncrement.h.

Here is the caller graph for this function:

◆ state() [2/2]

template<typename MODEL>

const Increment4D_& oops::ControlIncrement< MODEL >::state ( ) const

inline

Definition at line 83 of file ControlIncrement.h.

◆ write()

template<typename MODEL >

void oops::ControlIncrement< MODEL >::write ( const eckit::Configuration & config ) const

Definition at line 193 of file ControlIncrement.h.

◆ zero()

template<typename MODEL >

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

Linear algebra operators.

Definition at line 172 of file ControlIncrement.h.

Here is the caller graph for this function:

Member Data Documentation

◆ incrm4d_

template<typename MODEL>

Increment4D_ oops::ControlIncrement< MODEL >::incrm4d_

private

Definition at line 95 of file ControlIncrement.h.

◆ modbias_

template<typename MODEL>

ModelAuxIncr_ oops::ControlIncrement< MODEL >::modbias_

private

Definition at line 96 of file ControlIncrement.h.

◆ obsbias_

template<typename MODEL>

ObsAuxIncr_ oops::ControlIncrement< MODEL >::obsbias_

private

Definition at line 97 of file ControlIncrement.h.

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

ControlIncrement.h

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ Geometry_

◆ Increment4D_

◆ JbTotal_

◆ ModelAuxIncr_

◆ ObsAuxIncr_

Constructor & Destructor Documentation

◆ ControlIncrement() [1/4]

◆ ControlIncrement() [2/4]

◆ ControlIncrement() [3/4]

◆ ControlIncrement() [4/4]

◆ ~ControlIncrement()

Member Function Documentation

◆ axpy()

◆ classname()

◆ dot_product_with()

◆ geometry()

◆ modVar() [1/2]

◆ modVar() [2/2]

◆ obsVar() [1/2]

◆ obsVar() [2/2]

◆ operator*=()

◆ operator+=()

◆ operator-=()

◆ operator=()

◆ print()

◆ read()

◆ state() [1/2]

◆ state() [2/2]

◆ write()

◆ zero()

Member Data Documentation

◆ incrm4d_

◆ modbias_

◆ obsbias_

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