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

State increment. More...

#include <CostJbState.h>

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

Public Member Functions

 Increment4D (const JbState_ &)
 Constructor, destructor. More...
 
 Increment4D (const Increment4D &, const bool copy=true)
 
 Increment4D (const Increment4D &, const eckit::Configuration &)
 
 Increment4D (const Geometry_ &, const Increment4D &)
 
 ~Increment4D ()
 
void diff (const State4D_ &, const State4D_ &)
 Linear algebra operators. More...
 
void zero ()
 
Increment4D & operator= (const Increment4D &)
 
Increment4D & operator+= (const Increment4D &)
 
Increment4D & operator-= (const Increment4D &)
 
Increment4D & operator*= (const double)
 
void axpy (const double, const Increment4D &)
 
double dot_product_with (const Increment4D &) const
 
void read (const eckit::Configuration &)
 I/O and diagnostics. More...
 
void write (const eckit::Configuration &) const
 
Geometry_ geometry () const
 Get geometry. More...
 
Increment_ & operator[] (const int ii)
 Get model space control variable. More...
 
const Increment_ & operator[] (const int ii) const
 
int first () const
 
int last () const
 
void shift_forward ()
 To be removed. More...
 
void shift_backward ()
 

Static Public Member Functions

static const std::string classname ()
 

Private Types

typedef Geometry< MODEL > Geometry_
 
typedef Increment< MODEL > Increment_
 
typedef CostJbState< MODEL > JbState_
 
typedef State4D< MODEL > State4D_
 
typedef boost::ptr_map< int, Increment_ >::iterator iter_
 
typedef boost::ptr_map< int, Increment_ >::const_iterator icst_
 

Private Member Functions

Increment_ & get (const int)
 
const Increment_ & get (const int) const
 
void print (std::ostream &) const
 

Private Attributes

boost::ptr_map< int, Increment_ > incr4d_
 
int first_
 
int last_
 

Detailed Description

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

State increment.

The state increment contains the increment to the 3D or 4D state part of the VDA control variable.

Definition at line 28 of file CostJbState.h.

Member Typedef Documentation

◆ Geometry_

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

Definition at line 43 of file Increment4D.h.

◆ icst_

template<typename MODEL >
typedef boost::ptr_map<int, Increment_>::const_iterator oops::Increment4D< MODEL >::icst_
private

Definition at line 91 of file Increment4D.h.

◆ Increment_

template<typename MODEL >
typedef Increment<MODEL> oops::Increment4D< MODEL >::Increment_
private

Definition at line 44 of file Increment4D.h.

◆ iter_

template<typename MODEL >
typedef boost::ptr_map<int, Increment_>::iterator oops::Increment4D< MODEL >::iter_
private

Definition at line 90 of file Increment4D.h.

◆ JbState_

template<typename MODEL >
typedef CostJbState<MODEL> oops::Increment4D< MODEL >::JbState_
private

Definition at line 45 of file Increment4D.h.

◆ State4D_

template<typename MODEL >
typedef State4D<MODEL> oops::Increment4D< MODEL >::State4D_
private

Definition at line 46 of file Increment4D.h.

Constructor & Destructor Documentation

◆ Increment4D() [1/4]

template<typename MODEL >
oops::Increment4D< MODEL >::Increment4D ( const JbState_ &  jb)
explicit

Constructor, destructor.

Definition at line 100 of file Increment4D.h.

Here is the call graph for this function:

◆ Increment4D() [2/4]

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

Definition at line 111 of file Increment4D.h.

Here is the call graph for this function:

◆ Increment4D() [3/4]

template<typename MODEL >
oops::Increment4D< MODEL >::Increment4D ( const Increment4D< MODEL > &  other,
const eckit::Configuration &  tlConf 
)

Definition at line 123 of file Increment4D.h.

◆ Increment4D() [4/4]

template<typename MODEL >
oops::Increment4D< MODEL >::Increment4D ( const Geometry_ &  geom,
const Increment4D< MODEL > &  other 
)

Definition at line 135 of file Increment4D.h.

◆ ~Increment4D()

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

Definition at line 161 of file Increment4D.h.

Member Function Documentation

◆ axpy()

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

Definition at line 208 of file Increment4D.h.

◆ classname()

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

Definition at line 49 of file Increment4D.h.

◆ diff()

template<typename MODEL >
void oops::Increment4D< MODEL >::diff ( const State4D_ &  cv1,
const State4D_ &  cv2 
)

Linear algebra operators.

Definition at line 171 of file Increment4D.h.

Here is the caller graph for this function:

◆ dot_product_with()

template<typename MODEL >
double oops::Increment4D< MODEL >::dot_product_with ( const Increment4D< MODEL > &  x2) const

Definition at line 241 of file Increment4D.h.

◆ first()

template<typename MODEL >
int oops::Increment4D< MODEL >::first ( ) const
inline

Definition at line 78 of file Increment4D.h.

Here is the caller graph for this function:

◆ geometry()

template<typename MODEL >
Geometry_ oops::Increment4D< MODEL >::geometry ( ) const
inline

Get geometry.

Definition at line 73 of file Increment4D.h.

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

◆ get() [1/2]

template<typename MODEL >
Increment< MODEL > & oops::Increment4D< MODEL >::get ( const int  ii)
private

Definition at line 147 of file Increment4D.h.

◆ get() [2/2]

template<typename MODEL >
const Increment< MODEL > & oops::Increment4D< MODEL >::get ( const int  ii) const
private

Definition at line 154 of file Increment4D.h.

◆ last()

template<typename MODEL >
int oops::Increment4D< MODEL >::last ( ) const
inline

Definition at line 79 of file Increment4D.h.

Here is the caller graph for this function:

◆ operator*=()

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

Definition at line 200 of file Increment4D.h.

◆ operator+=()

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

Definition at line 184 of file Increment4D.h.

◆ operator-=()

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

Definition at line 192 of file Increment4D.h.

◆ operator=()

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

Definition at line 178 of file Increment4D.h.

◆ operator[]() [1/2]

template<typename MODEL >
Increment_& oops::Increment4D< MODEL >::operator[] ( const int  ii)
inline

Get model space control variable.

Definition at line 76 of file Increment4D.h.

◆ operator[]() [2/2]

template<typename MODEL >
const Increment_& oops::Increment4D< MODEL >::operator[] ( const int  ii) const
inline

Definition at line 77 of file Increment4D.h.

◆ print()

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

Definition at line 234 of file Increment4D.h.

◆ read()

template<typename MODEL >
void oops::Increment4D< MODEL >::read ( const eckit::Configuration &  config)

I/O and diagnostics.

Definition at line 215 of file Increment4D.h.

Here is the call graph for this function:

◆ shift_backward()

template<typename MODEL >
void oops::Increment4D< MODEL >::shift_backward ( )

Definition at line 262 of file Increment4D.h.

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

◆ shift_forward()

template<typename MODEL >
void oops::Increment4D< MODEL >::shift_forward ( )

To be removed.

Definition at line 250 of file Increment4D.h.

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

◆ write()

template<typename MODEL >
void oops::Increment4D< MODEL >::write ( const eckit::Configuration &  config) const

Definition at line 227 of file Increment4D.h.

◆ zero()

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

Definition at line 164 of file Increment4D.h.

Here is the caller graph for this function:

Member Data Documentation

◆ first_

template<typename MODEL >
int oops::Increment4D< MODEL >::first_
private

Definition at line 93 of file Increment4D.h.

◆ incr4d_

template<typename MODEL >
boost::ptr_map<int, Increment_> oops::Increment4D< MODEL >::incr4d_
private

Definition at line 92 of file Increment4D.h.

◆ last_

template<typename MODEL >
int oops::Increment4D< MODEL >::last_
private

Definition at line 94 of file Increment4D.h.

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