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

#include <ModelAuxIncrement.h>

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

Public Member Functions

 ModelAuxIncrement (const Geometry_ &, const eckit::Configuration &)
 Constructor, destructor. More...
 
 ModelAuxIncrement (const ModelAuxIncrement &, const bool copy=true)
 
 ModelAuxIncrement (const ModelAuxIncrement &, const eckit::Configuration &)
 
 ~ModelAuxIncrement ()
 
const ModelAuxIncrement_ & modelauxincrement () const
 Interfacing. More...
 
ModelAuxIncrement_ & modelauxincrement ()
 
void diff (const ModelAuxControl_ &, const ModelAuxControl_ &)
 Linear algebra operators. More...
 
void zero ()
 
ModelAuxIncrement & operator= (const ModelAuxIncrement &)
 
ModelAuxIncrement & operator+= (const ModelAuxIncrement &)
 
ModelAuxIncrement & operator-= (const ModelAuxIncrement &)
 
ModelAuxIncrement & operator*= (const double &)
 
void axpy (const double &, const ModelAuxIncrement &)
 
double dot_product_with (const ModelAuxIncrement &) 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 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 >

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

Member Typedef Documentation

◆ Geometry_

template<typename MODEL >
typedef Geometry<MODEL> oops::ModelAuxIncrement< MODEL >::Geometry_
private

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

◆ ModelAuxControl_

template<typename MODEL >
typedef ModelAuxControl<MODEL> oops::ModelAuxIncrement< MODEL >::ModelAuxControl_
private

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

◆ ModelAuxIncrement_

template<typename MODEL >
typedef MODEL::ModelAuxIncrement oops::ModelAuxIncrement< MODEL >::ModelAuxIncrement_
private

Definition at line 40 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, destructor.

Definition at line 97 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

Definition at line 107 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 
)

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

Here is the call graph for this function:

◆ ~ModelAuxIncrement()

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

Definition at line 127 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 187 of file oops/interface/ModelAuxIncrement.h.

◆ classname()

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

Definition at line 45 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 244 of file oops/interface/ModelAuxIncrement.h.

◆ diff()

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

Linear algebra operators.

Definition at line 135 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 > &  dx) const

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

◆ modelauxincrement() [1/2]

template<typename MODEL >
ModelAuxIncrement_& oops::ModelAuxIncrement< MODEL >::modelauxincrement ( )
inline

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

◆ modelauxincrement() [2/2]

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

Interfacing.

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

Here is the caller graph for this function:

◆ norm()

template<typename MODEL >
double oops::ModelAuxIncrement< MODEL >::norm

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

◆ operator*=()

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

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

◆ operator+=()

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

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

◆ operator-=()

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

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

◆ operator=()

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

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

◆ print()

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

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

◆ read()

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

I/O and diagnostics.

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

◆ serialize()

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

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

◆ serialSize()

template<typename MODEL >
size_t oops::ModelAuxIncrement< MODEL >::serialSize
override

Serialize and deserialize.

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

◆ write()

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

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

◆ zero()

template<typename MODEL >
void oops::ModelAuxIncrement< MODEL >::zero

Definition at line 143 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 79 of file oops/interface/ModelAuxIncrement.h.

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