Auxiliary Increment related to model, not used at the moment. More...

#include <ModelAuxIncrement.h>

Inheritance diagram for oops::ModelAuxIncrement< MODEL >:

[legend]

Collaboration diagram for oops::ModelAuxIncrement< MODEL >:

[legend]

Public Member Functions
	ModelAuxIncrement (const Geometry_ &resol, const eckit::Configuration &conf)
	Constructor for specified `resol` and `conf`. More...

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

	ModelAuxIncrement (const ModelAuxIncrement &other, const eckit::Configuration &conf)
	Copies `other` ModelAuxIncrement, reading extra information from `conf`. More...

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

const ModelAuxIncrement_ &	modelauxincrement () const
	const Accessor More...

ModelAuxIncrement_ &	modelauxincrement ()
	Accessor. More...

void	diff (const ModelAuxControl_ &, const ModelAuxControl_ &)
	Sets this ModelAuxIncrement to the difference between two ModelAuxControl objects. More...

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

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

ModelAuxIncrement &	operator+= (const ModelAuxIncrement &)

ModelAuxIncrement &	operator-= (const ModelAuxIncrement &)

ModelAuxIncrement &	operator*= (const double &)

void	axpy (const double &, const ModelAuxIncrement &)

double	dot_product_with (const ModelAuxIncrement &other) const
	dot product with the `other` ModelAuxIncrement More...

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

void	write (const eckit::Configuration &) const
	Write this ModelAuxIncrement 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 MODEL::ModelAuxIncrement	ModelAuxIncrement_

typedef Geometry< MODEL >	Geometry_

typedef ModelAuxControl< MODEL >	ModelAuxControl_

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

Private Attributes
std::unique_ptr< ModelAuxIncrement_ >	aux_

Detailed Description

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

Auxiliary Increment related to model, not used at the moment.

This class calls the model's implementation of ModelAuxIncrement.

Definition at line 40 of file oops/interface/ModelAuxIncrement.h.

Member Typedef Documentation

◆ Geometry_

template<typename MODEL >

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

private

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

◆ ModelAuxControl_

template<typename MODEL >

typedef ModelAuxControl<MODEL> oops::ModelAuxIncrement< MODEL >::ModelAuxControl_

private

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

◆ ModelAuxIncrement_

template<typename MODEL >

typedef MODEL::ModelAuxIncrement oops::ModelAuxIncrement< MODEL >::ModelAuxIncrement_

private

Definition at line 43 of file oops/interface/ModelAuxIncrement.h.

Constructor & Destructor Documentation

◆ ModelAuxIncrement() [1/3]

template<typename MODEL >

oops::ModelAuxIncrement< MODEL >::ModelAuxIncrement	(	const Geometry_ &	resol,
		const eckit::Configuration &	conf
	)

Constructor for specified resol and conf.

Definition at line 110 of file oops/interface/ModelAuxIncrement.h.

Here is the call graph for this function:

◆ ModelAuxIncrement() [2/3]

template<typename MODEL >

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

explicit

Copies other ModelAuxIncrement if copy is true, otherwise creates zero ModelAuxIncrement with same variables and geometry

Definition at line 121 of file oops/interface/ModelAuxIncrement.h.

Here is the call graph for this function:

◆ ModelAuxIncrement() [3/3]

template<typename MODEL >

oops::ModelAuxIncrement< MODEL >::ModelAuxIncrement	(	const ModelAuxIncrement< MODEL > &	other,
		const eckit::Configuration &	conf
	)

Copies other ModelAuxIncrement, reading extra information from conf.

Definition at line 132 of file oops/interface/ModelAuxIncrement.h.

Here is the call graph for this function:

◆ ~ModelAuxIncrement()

template<typename MODEL >

oops::ModelAuxIncrement< MODEL >::~ModelAuxIncrement

Destructor (defined explicitly for timing and tracing)

Definition at line 143 of file oops/interface/ModelAuxIncrement.h.

Member Function Documentation

◆ axpy()

template<typename MODEL >

void oops::ModelAuxIncrement< MODEL >::axpy	(	const double &	zz,
		const ModelAuxIncrement< MODEL > &	dx
	)

Definition at line 203 of file oops/interface/ModelAuxIncrement.h.

◆ classname()

template<typename MODEL >

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

inlinestatic

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

Here is the caller graph for this function:

◆ deserialize()

template<typename MODEL >

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

override

Definition at line 260 of file oops/interface/ModelAuxIncrement.h.

◆ diff()

template<typename MODEL >

void oops::ModelAuxIncrement< MODEL >::diff	(	const ModelAuxControl_ &	x1,
		const ModelAuxControl_ &	x2
	)

Sets this ModelAuxIncrement to the difference between two ModelAuxControl objects.

Definition at line 151 of file oops/interface/ModelAuxIncrement.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dot_product_with()

template<typename MODEL >

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

dot product with the other ModelAuxIncrement

Definition at line 211 of file oops/interface/ModelAuxIncrement.h.

◆ modelauxincrement() [1/2]

template<typename MODEL >

ModelAuxIncrement_& oops::ModelAuxIncrement< MODEL >::modelauxincrement ( )

inline

Accessor.

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

◆ modelauxincrement() [2/2]

template<typename MODEL >

const ModelAuxIncrement_& oops::ModelAuxIncrement< MODEL >::modelauxincrement ( ) const

inline

const Accessor

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

Here is the caller graph for this function:

◆ norm()

template<typename MODEL >

double oops::ModelAuxIncrement< MODEL >::norm

Norm (used in tests)

Definition at line 236 of file oops/interface/ModelAuxIncrement.h.

◆ operator*=()

template<typename MODEL >

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

Definition at line 194 of file oops/interface/ModelAuxIncrement.h.

◆ operator+=()

template<typename MODEL >

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

Definition at line 176 of file oops/interface/ModelAuxIncrement.h.

◆ operator-=()

template<typename MODEL >

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

Definition at line 185 of file oops/interface/ModelAuxIncrement.h.

◆ operator=()

template<typename MODEL >

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

Linear algebra operators.

Definition at line 167 of file oops/interface/ModelAuxIncrement.h.

◆ print()

template<typename MODEL >

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

overrideprivate

Definition at line 268 of file oops/interface/ModelAuxIncrement.h.

◆ read()

template<typename MODEL >

void oops::ModelAuxIncrement< MODEL >::read ( const eckit::Configuration & conf )

Read this ModelAuxIncrement from file.

Definition at line 220 of file oops/interface/ModelAuxIncrement.h.

◆ serialize()

template<typename MODEL >

void oops::ModelAuxIncrement< MODEL >::serialize ( std::vector< double > & vect ) const

override

Definition at line 252 of file oops/interface/ModelAuxIncrement.h.

◆ serialSize()

template<typename MODEL >

size_t oops::ModelAuxIncrement< MODEL >::serialSize

override

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

Definition at line 245 of file oops/interface/ModelAuxIncrement.h.

◆ write()

template<typename MODEL >

void oops::ModelAuxIncrement< MODEL >::write ( const eckit::Configuration & conf ) const

Write this ModelAuxIncrement out to file.

Definition at line 228 of file oops/interface/ModelAuxIncrement.h.

◆ zero()

template<typename MODEL >

void oops::ModelAuxIncrement< MODEL >::zero

Zero out this ModelAuxIncrement.

Definition at line 159 of file oops/interface/ModelAuxIncrement.h.

Here is the caller graph for this function:

Member Data Documentation

◆ aux_

template<typename MODEL >

std::unique_ptr<ModelAuxIncrement_> oops::ModelAuxIncrement< MODEL >::aux_

private

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

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

oops/interface/ModelAuxIncrement.h

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ Geometry_

◆ ModelAuxControl_

◆ ModelAuxIncrement_

Constructor & Destructor Documentation

◆ ModelAuxIncrement() [1/3]

◆ ModelAuxIncrement() [2/3]

◆ ModelAuxIncrement() [3/3]

◆ ~ModelAuxIncrement()

Member Function Documentation

◆ axpy()

◆ classname()

◆ deserialize()

◆ diff()

◆ dot_product_with()

◆ modelauxincrement() [1/2]

◆ modelauxincrement() [2/2]

◆ norm()

◆ operator*=()

◆ operator+=()

◆ operator-=()

◆ operator=()

◆ print()

◆ read()

◆ serialize()

◆ serialSize()

◆ write()

◆ zero()

Member Data Documentation

◆ aux_

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