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

#include <ObsAuxIncrement.h>

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

Public Member Functions

 ObsAuxIncrement (const eckit::Configuration &)
 Constructor, destructor. More...
 
 ObsAuxIncrement (const ObsAuxIncrement &, const bool copy=true)
 
 ObsAuxIncrement (const ObsAuxIncrement &, const eckit::Configuration &)
 
 ~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
 

Static Public Member Functions

static const std::string classname ()
 

Private Types

typedef MODEL::ObsAuxIncrement ObsAuxIncrement_
 
typedef ObsAuxControl< MODEL > ObsAuxControl_
 

Private Member Functions

void print (std::ostream &) const
 

Private Attributes

boost::scoped_ptr< ObsAuxIncrement_ > aux_
 

Detailed Description

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

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

Member Typedef Documentation

◆ ObsAuxControl_

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

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

◆ ObsAuxIncrement_

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

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

Constructor & Destructor Documentation

◆ ObsAuxIncrement() [1/3]

template<typename MODEL >
oops::ObsAuxIncrement< MODEL >::ObsAuxIncrement ( const eckit::Configuration &  conf)
explicit

Constructor, destructor.

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

Here is the call graph for this function:

◆ ObsAuxIncrement() [2/3]

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

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

Here is the call graph for this function:

◆ ObsAuxIncrement() [3/3]

template<typename MODEL >
oops::ObsAuxIncrement< MODEL >::ObsAuxIncrement ( const ObsAuxIncrement< MODEL > &  other,
const eckit::Configuration &  conf 
)

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

Here is the call graph for this function:

◆ ~ObsAuxIncrement()

template<typename MODEL >
oops::ObsAuxIncrement< MODEL >::~ObsAuxIncrement ( )

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

Member Function Documentation

◆ axpy()

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

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

◆ classname()

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

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

Here is the caller graph for this function:

◆ diff()

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

Linear algebra operators.

Definition at line 123 of file oops/interface/ObsAuxIncrement.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::ObsAuxIncrement< MODEL >::dot_product_with ( const ObsAuxIncrement< MODEL > &  dx) const

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

◆ norm()

template<typename MODEL >
double oops::ObsAuxIncrement< MODEL >::norm ( ) const

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

◆ obsauxincrement() [1/2]

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

Interfacing.

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

Here is the caller graph for this function:

◆ obsauxincrement() [2/2]

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

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

◆ operator*=()

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

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

◆ operator+=()

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

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

◆ operator-=()

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

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

◆ operator=()

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

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

◆ print()

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

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

◆ read()

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

I/O and diagnostics.

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

◆ write()

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

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

◆ zero()

template<typename MODEL >
void oops::ObsAuxIncrement< MODEL >::zero ( )

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

Here is the caller graph for this function:

Member Data Documentation

◆ aux_

template<typename MODEL>
boost::scoped_ptr<ObsAuxIncrement_> oops::ObsAuxIncrement< MODEL >::aux_
private

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

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