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

Holds a vector of ObsAuxIncrement. More...

#include <ObsAuxIncrements.h>

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

Public Member Functions

 ObsAuxIncrements (const ObsSpaces_ &, const eckit::Configuration &)
 Constructor, destructor. More...
 
 ObsAuxIncrements (const ObsAuxIncrements &, const bool copy=true)
 
 ~ObsAuxIncrements ()
 
std::size_t size () const
 Access. More...
 
const ObsAuxIncrement_ & operator[] (const std::size_t ii) const
 
ObsAuxIncrement_ & operator[] (const std::size_t ii)
 
void diff (const ObsAuxControls_ &, const ObsAuxControls_ &)
 Linear algebra operators. More...
 
void zero ()
 
ObsAuxIncrements & operator= (const ObsAuxIncrements &)
 
ObsAuxIncrements & operator+= (const ObsAuxIncrements &)
 
ObsAuxIncrements & operator-= (const ObsAuxIncrements &)
 
ObsAuxIncrements & operator*= (const double &)
 
void axpy (const double &, const ObsAuxIncrements &)
 
double dot_product_with (const ObsAuxIncrements &) 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-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 ObsAuxIncrement< OBS > ObsAuxIncrement_
 
typedef ObsAuxControls< OBS > ObsAuxControls_
 
typedef ObsSpaces< OBS > ObsSpaces_
 

Private Member Functions

void print (std::ostream &) const override
 

Private Attributes

std::vector< std::unique_ptr< ObsAuxIncrement_ > > auxs_
 

Detailed Description

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

Holds a vector of ObsAuxIncrement.

Definition at line 31 of file ObsAuxIncrements.h.

Member Typedef Documentation

◆ ObsAuxControls_

template<typename OBS >
typedef ObsAuxControls<OBS> oops::ObsAuxIncrements< OBS >::ObsAuxControls_
private

Definition at line 35 of file ObsAuxIncrements.h.

◆ ObsAuxIncrement_

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

Definition at line 34 of file ObsAuxIncrements.h.

◆ ObsSpaces_

template<typename OBS >
typedef ObsSpaces<OBS> oops::ObsAuxIncrements< OBS >::ObsSpaces_
private

Definition at line 36 of file ObsAuxIncrements.h.

Constructor & Destructor Documentation

◆ ObsAuxIncrements() [1/2]

template<typename OBS >
oops::ObsAuxIncrements< OBS >::ObsAuxIncrements ( const ObsSpaces_ &  odb,
const eckit::Configuration &  conf 
)

Constructor, destructor.

Definition at line 92 of file ObsAuxIncrements.h.

◆ ObsAuxIncrements() [2/2]

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

Definition at line 111 of file ObsAuxIncrements.h.

Here is the call graph for this function:

◆ ~ObsAuxIncrements()

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

Definition at line 126 of file ObsAuxIncrements.h.

Member Function Documentation

◆ axpy()

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

Definition at line 195 of file ObsAuxIncrements.h.

Here is the call graph for this function:

◆ classname()

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

Definition at line 39 of file ObsAuxIncrements.h.

◆ deserialize()

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

Definition at line 260 of file ObsAuxIncrements.h.

◆ diff()

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

Linear algebra operators.

Definition at line 133 of file ObsAuxIncrements.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ dot_product_with()

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

Definition at line 205 of file ObsAuxIncrements.h.

Here is the call graph for this function:

◆ norm()

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

Definition at line 231 of file ObsAuxIncrements.h.

◆ operator*=()

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

Definition at line 185 of file ObsAuxIncrements.h.

◆ operator+=()

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

Definition at line 163 of file ObsAuxIncrements.h.

Here is the call graph for this function:

◆ operator-=()

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

Definition at line 174 of file ObsAuxIncrements.h.

Here is the call graph for this function:

◆ operator=()

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

Definition at line 152 of file ObsAuxIncrements.h.

Here is the call graph for this function:

◆ operator[]() [1/2]

template<typename OBS >
ObsAuxIncrement_& oops::ObsAuxIncrements< OBS >::operator[] ( const std::size_t  ii)
inline

Definition at line 49 of file ObsAuxIncrements.h.

◆ operator[]() [2/2]

template<typename OBS >
const ObsAuxIncrement_& oops::ObsAuxIncrements< OBS >::operator[] ( const std::size_t  ii) const
inline

Definition at line 48 of file ObsAuxIncrements.h.

◆ print()

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

Definition at line 270 of file ObsAuxIncrements.h.

◆ read()

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

I/O and diagnostics.

Definition at line 217 of file ObsAuxIncrements.h.

◆ serialize()

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

Definition at line 253 of file ObsAuxIncrements.h.

◆ serialSize()

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

Serialize-Deserialize.

Definition at line 242 of file ObsAuxIncrements.h.

◆ size()

template<typename OBS >
std::size_t oops::ObsAuxIncrements< OBS >::size ( ) const
inline

Access.

Definition at line 47 of file ObsAuxIncrements.h.

Here is the caller graph for this function:

◆ write()

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

Definition at line 224 of file ObsAuxIncrements.h.

Here is the call graph for this function:

◆ zero()

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

Definition at line 143 of file ObsAuxIncrements.h.

Here is the caller graph for this function:

Member Data Documentation

◆ auxs_

template<typename OBS >
std::vector<std::unique_ptr<ObsAuxIncrement_> > oops::ObsAuxIncrements< OBS >::auxs_
private

Definition at line 73 of file ObsAuxIncrements.h.

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