IODA Bundle
Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
oops::ObsAuxIncrement< OBS > Class Template Reference

#include <ObsAuxIncrement.h>

Inheritance diagram for oops::ObsAuxIncrement< OBS >:
[legend]
Collaboration diagram for oops::ObsAuxIncrement< OBS >:
[legend]

Public Types

typedef ObsAuxIncrement_::Parameters_ Parameters_
 

Public Member Functions

 ObsAuxIncrement (const ObsSpace< OBS > &, const Parameters_ &)
 Constructor, destructor. More...
 
 ObsAuxIncrement (const ObsAuxIncrement &other, const bool copy=true)
 
 ~ObsAuxIncrement ()
 
const ObsAuxIncrement_ & obsauxincrement () const
 Interfacing. More...
 
ObsAuxIncrement_ & obsauxincrement ()
 
void diff (const ObsAuxControl_ &, const ObsAuxControl_ &)
 Linear algebra operators. More...
 
void zero ()
 
ObsAuxIncrement & operator= (const ObsAuxIncrement &)
 
ObsAuxIncrement & operator+= (const ObsAuxIncrement &)
 
ObsAuxIncrement & operator-= (const ObsAuxIncrement &)
 
ObsAuxIncrement & operator*= (const double &)
 
void axpy (const double &, const ObsAuxIncrement &)
 
double dot_product_with (const ObsAuxIncrement &) const
 
void read (const eckit::Configuration &)
 I/O and diagnostics. More...
 
void write (const eckit::Configuration &) const
 
double norm () const
 
size_t serialSize () const override
 Serialize and deserialize. 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 OBS::ObsAuxIncrement ObsAuxIncrement_
 
typedef ObsAuxControl< OBS > ObsAuxControl_
 

Private Member Functions

void print (std::ostream &) const override
 

Private Attributes

std::unique_ptr< ObsAuxIncrement_ > aux_
 

Detailed Description

template<typename OBS>
class oops::ObsAuxIncrement< OBS >

Definition at line 36 of file oops/interface/ObsAuxIncrement.h.

Member Typedef Documentation

◆ ObsAuxControl_

template<typename OBS >
typedef ObsAuxControl<OBS> oops::ObsAuxIncrement< OBS >::ObsAuxControl_
private

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

◆ ObsAuxIncrement_

template<typename OBS >
typedef OBS::ObsAuxIncrement oops::ObsAuxIncrement< OBS >::ObsAuxIncrement_
private

Definition at line 39 of file oops/interface/ObsAuxIncrement.h.

◆ Parameters_

template<typename OBS >
typedef ObsAuxIncrement_::Parameters_ oops::ObsAuxIncrement< OBS >::Parameters_

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

Constructor & Destructor Documentation

◆ ObsAuxIncrement() [1/2]

template<typename OBS >
oops::ObsAuxIncrement< OBS >::ObsAuxIncrement ( const ObsSpace< OBS > &  os,
const Parameters_ &  params 
)

Constructor, destructor.

Definition at line 97 of file oops/interface/ObsAuxIncrement.h.

Here is the call graph for this function:

◆ ObsAuxIncrement() [2/2]

template<typename OBS >
oops::ObsAuxIncrement< OBS >::ObsAuxIncrement ( const ObsAuxIncrement< OBS > &  other,
const bool  copy = true 
)

Copies other if copy is true, otherwise creates zero increment of the same size as other.

Definition at line 108 of file oops/interface/ObsAuxIncrement.h.

Here is the call graph for this function:

◆ ~ObsAuxIncrement()

template<typename OBS >
oops::ObsAuxIncrement< OBS >::~ObsAuxIncrement

Definition at line 119 of file oops/interface/ObsAuxIncrement.h.

Member Function Documentation

◆ axpy()

template<typename OBS >
void oops::ObsAuxIncrement< OBS >::axpy ( const double &  zz,
const ObsAuxIncrement< OBS > &  dx 
)

Definition at line 179 of file oops/interface/ObsAuxIncrement.h.

◆ classname()

template<typename OBS >
static const std::string oops::ObsAuxIncrement< OBS >::classname ( )
inlinestatic

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

Here is the caller graph for this function:

◆ deserialize()

template<typename OBS >
void oops::ObsAuxIncrement< OBS >::deserialize ( const std::vector< double > &  vect,
size_t &  current 
)
override

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

◆ diff()

template<typename OBS >
void oops::ObsAuxIncrement< OBS >::diff ( const ObsAuxControl_ &  x1,
const ObsAuxControl_ &  x2 
)

Linear algebra operators.

Definition at line 127 of file oops/interface/ObsAuxIncrement.h.

Here is the call graph for this function:

◆ dot_product_with()

template<typename OBS >
double oops::ObsAuxIncrement< OBS >::dot_product_with ( const ObsAuxIncrement< OBS > &  dx) const

Definition at line 187 of file oops/interface/ObsAuxIncrement.h.

◆ norm()

template<typename OBS >
double oops::ObsAuxIncrement< OBS >::norm

Definition at line 212 of file oops/interface/ObsAuxIncrement.h.

◆ obsauxincrement() [1/2]

template<typename OBS >
ObsAuxIncrement_& oops::ObsAuxIncrement< OBS >::obsauxincrement ( )
inline

Definition at line 56 of file oops/interface/ObsAuxIncrement.h.

◆ obsauxincrement() [2/2]

template<typename OBS >
const ObsAuxIncrement_& oops::ObsAuxIncrement< OBS >::obsauxincrement ( ) const
inline

Interfacing.

Definition at line 55 of file oops/interface/ObsAuxIncrement.h.

Here is the caller graph for this function:

◆ operator*=()

template<typename OBS >
ObsAuxIncrement< OBS > & oops::ObsAuxIncrement< OBS >::operator*= ( const double &  zz)

Definition at line 170 of file oops/interface/ObsAuxIncrement.h.

◆ operator+=()

template<typename OBS >
ObsAuxIncrement< OBS > & oops::ObsAuxIncrement< OBS >::operator+= ( const ObsAuxIncrement< OBS > &  rhs)

Definition at line 152 of file oops/interface/ObsAuxIncrement.h.

◆ operator-=()

template<typename OBS >
ObsAuxIncrement< OBS > & oops::ObsAuxIncrement< OBS >::operator-= ( const ObsAuxIncrement< OBS > &  rhs)

Definition at line 161 of file oops/interface/ObsAuxIncrement.h.

◆ operator=()

template<typename OBS >
ObsAuxIncrement< OBS > & oops::ObsAuxIncrement< OBS >::operator= ( const ObsAuxIncrement< OBS > &  rhs)

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

◆ print()

template<typename OBS >
void oops::ObsAuxIncrement< OBS >::print ( std::ostream &  os) const
overrideprivate

Definition at line 244 of file oops/interface/ObsAuxIncrement.h.

◆ read()

template<typename OBS >
void oops::ObsAuxIncrement< OBS >::read ( const eckit::Configuration &  conf)

I/O and diagnostics.

Definition at line 196 of file oops/interface/ObsAuxIncrement.h.

◆ serialize()

template<typename OBS >
void oops::ObsAuxIncrement< OBS >::serialize ( std::vector< double > &  vect) const
override

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

◆ serialSize()

template<typename OBS >
size_t oops::ObsAuxIncrement< OBS >::serialSize
override

Serialize and deserialize.

Definition at line 221 of file oops/interface/ObsAuxIncrement.h.

◆ write()

template<typename OBS >
void oops::ObsAuxIncrement< OBS >::write ( const eckit::Configuration &  conf) const

Definition at line 204 of file oops/interface/ObsAuxIncrement.h.

Here is the caller graph for this function:

◆ zero()

template<typename OBS >
void oops::ObsAuxIncrement< OBS >::zero

Definition at line 135 of file oops/interface/ObsAuxIncrement.h.

Member Data Documentation

◆ aux_

template<typename OBS >
std::unique_ptr<ObsAuxIncrement_> oops::ObsAuxIncrement< OBS >::aux_
private

Definition at line 80 of file oops/interface/ObsAuxIncrement.h.

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