FV3 Bundle
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 >:
[legend]
Collaboration diagram for oops::ModelAuxIncrement< MODEL >:
[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
 

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
 

Private Attributes

boost::scoped_ptr< ModelAuxIncrement_ > aux_
 

Detailed Description

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

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

Member Typedef Documentation

◆ Geometry_

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

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

◆ ModelAuxControl_

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

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

◆ ModelAuxIncrement_

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

Definition at line 37 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 89 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 99 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 109 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 119 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 179 of file oops/interface/ModelAuxIncrement.h.

◆ classname()

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

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

Here is the caller graph for this function:

◆ diff()

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

Linear algebra operators.

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

◆ modelauxincrement() [1/2]

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

Interfacing.

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

Here is the caller graph for this function:

◆ modelauxincrement() [2/2]

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

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

◆ norm()

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

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

◆ operator*=()

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

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

◆ operator+=()

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

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

◆ operator-=()

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

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

◆ operator=()

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

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

◆ print()

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

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

◆ write()

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

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

◆ zero()

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

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

Here is the caller graph for this function:

Member Data Documentation

◆ aux_

template<typename MODEL>
boost::scoped_ptr<ModelAuxIncrement_> oops::ModelAuxIncrement< MODEL >::aux_
private

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

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