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

#include <ControlIncrement.h>

Inheritance diagram for oops::ControlIncrement< MODEL, OBS >:
Inheritance graph
[legend]
Collaboration diagram for oops::ControlIncrement< MODEL, OBS >:
Collaboration graph
[legend]

Public Member Functions

 ControlIncrement (const JbTotal_ &)
 Constructor, destructor. More...
 
 ControlIncrement (const ControlIncrement &, const bool copy=true)
 
 ControlIncrement (const ControlIncrement &, const eckit::Configuration &)
 
 ControlIncrement (const Geometry_ &, const ControlIncrement &)
 
 ~ControlIncrement ()
 
void zero ()
 Linear algebra operators. More...
 
ControlIncrement & operator= (const ControlIncrement &)
 
ControlIncrement & operator+= (const ControlIncrement &)
 
ControlIncrement & operator-= (const ControlIncrement &)
 
ControlIncrement & operator*= (const double)
 
void axpy (const double, const ControlIncrement &)
 
double dot_product_with (const ControlIncrement &) const
 
void read (const eckit::Configuration &)
 I/O and diagnostics. More...
 
void write (const eckit::Configuration &) const
 
Geometry_ geometry () const
 Get geometry. More...
 
Increment_ & state ()
 Get state control variable. More...
 
const Increment_ & state () const
 
ModelAuxIncr_ & modVar ()
 Get augmented model control variable. More...
 
const ModelAuxIncr_ & modVar () const
 
ObsAuxIncrs_ & obsVar ()
 Get augmented observation control variable. More...
 
const ObsAuxIncrs_ & obsVar () const
 
size_t serialSize () const override
 Serialize and deserialize ControlIncrement. More...
 
void serialize (std::vector< double > &) const override
 
void deserialize (const std::vector< double > &, size_t &) override
 
void shift_forward ()
 
void shift_backward ()
 

Static Public Member Functions

static const std::string classname ()
 

Private Types

typedef CostJbTotal< MODEL, OBS > JbTotal_
 
typedef Geometry< MODEL > Geometry_
 
typedef Increment< MODEL > Increment_
 
typedef ModelAuxIncrement< MODEL > ModelAuxIncr_
 
typedef ObsAuxIncrements< OBS > ObsAuxIncrs_
 

Private Member Functions

void print (std::ostream &) const override
 

Private Attributes

Increment_ increment_
 
ModelAuxIncr_ modbias_
 
ObsAuxIncrs_ obsbias_
 
const util::DateTime windowBegin_
 
const util::DateTime windowEnd_
 

Detailed Description

template<typename MODEL, typename OBS>
class oops::ControlIncrement< MODEL, OBS >

Definition at line 50 of file ControlIncrement.h.

Member Typedef Documentation

◆ Geometry_

template<typename MODEL , typename OBS >
typedef Geometry<MODEL> oops::ControlIncrement< MODEL, OBS >::Geometry_
private

Definition at line 54 of file ControlIncrement.h.

◆ Increment_

template<typename MODEL , typename OBS >
typedef Increment<MODEL> oops::ControlIncrement< MODEL, OBS >::Increment_
private

Definition at line 55 of file ControlIncrement.h.

◆ JbTotal_

template<typename MODEL , typename OBS >
typedef CostJbTotal<MODEL, OBS> oops::ControlIncrement< MODEL, OBS >::JbTotal_
private

Definition at line 53 of file ControlIncrement.h.

◆ ModelAuxIncr_

template<typename MODEL , typename OBS >
typedef ModelAuxIncrement<MODEL> oops::ControlIncrement< MODEL, OBS >::ModelAuxIncr_
private

Definition at line 56 of file ControlIncrement.h.

◆ ObsAuxIncrs_

template<typename MODEL , typename OBS >
typedef ObsAuxIncrements<OBS> oops::ControlIncrement< MODEL, OBS >::ObsAuxIncrs_
private

Definition at line 57 of file ControlIncrement.h.

Constructor & Destructor Documentation

◆ ControlIncrement() [1/4]

template<typename MODEL , typename OBS >
oops::ControlIncrement< MODEL, OBS >::ControlIncrement ( const JbTotal_ &  jb)
explicit

Constructor, destructor.

Definition at line 118 of file ControlIncrement.h.

Here is the call graph for this function:

◆ ControlIncrement() [2/4]

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

Definition at line 129 of file ControlIncrement.h.

Here is the call graph for this function:

◆ ControlIncrement() [3/4]

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

Definition at line 138 of file ControlIncrement.h.

Here is the call graph for this function:

◆ ControlIncrement() [4/4]

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

Definition at line 148 of file ControlIncrement.h.

Here is the call graph for this function:

◆ ~ControlIncrement()

template<typename MODEL , typename OBS >
oops::ControlIncrement< MODEL, OBS >::~ControlIncrement

Definition at line 158 of file ControlIncrement.h.

Member Function Documentation

◆ axpy()

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

Definition at line 200 of file ControlIncrement.h.

Here is the caller graph for this function:

◆ classname()

template<typename MODEL , typename OBS >
static const std::string oops::ControlIncrement< MODEL, OBS >::classname ( )
inlinestatic

Definition at line 60 of file ControlIncrement.h.

◆ deserialize()

template<typename MODEL , typename OBS >
void oops::ControlIncrement< MODEL, OBS >::deserialize ( const std::vector< double > &  vec,
size_t &  indx 
)
override

Definition at line 262 of file ControlIncrement.h.

◆ dot_product_with()

template<typename MODEL , typename OBS >
double oops::ControlIncrement< MODEL, OBS >::dot_product_with ( const ControlIncrement< MODEL, OBS > &  x2) const

Definition at line 228 of file ControlIncrement.h.

◆ geometry()

template<typename MODEL , typename OBS >
Geometry_ oops::ControlIncrement< MODEL, OBS >::geometry ( ) const
inline

Get geometry.

Definition at line 83 of file ControlIncrement.h.

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

◆ modVar() [1/2]

template<typename MODEL , typename OBS >
ModelAuxIncr_& oops::ControlIncrement< MODEL, OBS >::modVar ( )
inline

Get augmented model control variable.

Definition at line 90 of file ControlIncrement.h.

Here is the caller graph for this function:

◆ modVar() [2/2]

template<typename MODEL , typename OBS >
const ModelAuxIncr_& oops::ControlIncrement< MODEL, OBS >::modVar ( ) const
inline

Definition at line 91 of file ControlIncrement.h.

◆ obsVar() [1/2]

template<typename MODEL , typename OBS >
ObsAuxIncrs_& oops::ControlIncrement< MODEL, OBS >::obsVar ( )
inline

Get augmented observation control variable.

Definition at line 94 of file ControlIncrement.h.

Here is the caller graph for this function:

◆ obsVar() [2/2]

template<typename MODEL , typename OBS >
const ObsAuxIncrs_& oops::ControlIncrement< MODEL, OBS >::obsVar ( ) const
inline

Definition at line 95 of file ControlIncrement.h.

◆ operator*=()

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

Definition at line 185 of file ControlIncrement.h.

◆ operator+=()

template<typename MODEL , typename OBS >
ControlIncrement< MODEL, OBS > & oops::ControlIncrement< MODEL, OBS >::operator+= ( const ControlIncrement< MODEL, OBS > &  rhs)

Definition at line 169 of file ControlIncrement.h.

◆ operator-=()

template<typename MODEL , typename OBS >
ControlIncrement< MODEL, OBS > & oops::ControlIncrement< MODEL, OBS >::operator-= ( const ControlIncrement< MODEL, OBS > &  rhs)

Definition at line 177 of file ControlIncrement.h.

◆ operator=()

template<typename MODEL , typename OBS >
ControlIncrement< MODEL, OBS > & oops::ControlIncrement< MODEL, OBS >::operator= ( const ControlIncrement< MODEL, OBS > &  rhs)

Definition at line 161 of file ControlIncrement.h.

◆ print()

template<typename MODEL , typename OBS >
void oops::ControlIncrement< MODEL, OBS >::print ( std::ostream &  outs) const
overrideprivate

Definition at line 221 of file ControlIncrement.h.

◆ read()

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

I/O and diagnostics.

Definition at line 207 of file ControlIncrement.h.

Here is the caller graph for this function:

◆ serialize()

template<typename MODEL , typename OBS >
void oops::ControlIncrement< MODEL, OBS >::serialize ( std::vector< double > &  vec) const
override

Definition at line 246 of file ControlIncrement.h.

◆ serialSize()

template<typename MODEL , typename OBS >
size_t oops::ControlIncrement< MODEL, OBS >::serialSize
override

Serialize and deserialize ControlIncrement.

Definition at line 237 of file ControlIncrement.h.

Here is the caller graph for this function:

◆ shift_backward()

template<typename MODEL , typename OBS >
void oops::ControlIncrement< MODEL, OBS >::shift_backward

Definition at line 288 of file ControlIncrement.h.

Here is the caller graph for this function:

◆ shift_forward()

template<typename MODEL , typename OBS >
void oops::ControlIncrement< MODEL, OBS >::shift_forward

Definition at line 282 of file ControlIncrement.h.

Here is the caller graph for this function:

◆ state() [1/2]

template<typename MODEL , typename OBS >
Increment_& oops::ControlIncrement< MODEL, OBS >::state ( )
inline

Get state control variable.

Definition at line 86 of file ControlIncrement.h.

Here is the caller graph for this function:

◆ state() [2/2]

template<typename MODEL , typename OBS >
const Increment_& oops::ControlIncrement< MODEL, OBS >::state ( ) const
inline

Definition at line 87 of file ControlIncrement.h.

Here is the caller graph for this function:

◆ write()

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

Definition at line 214 of file ControlIncrement.h.

Here is the caller graph for this function:

◆ zero()

template<typename MODEL , typename OBS >
void oops::ControlIncrement< MODEL, OBS >::zero

Linear algebra operators.

Definition at line 193 of file ControlIncrement.h.

Here is the caller graph for this function:

Member Data Documentation

◆ increment_

template<typename MODEL , typename OBS >
Increment_ oops::ControlIncrement< MODEL, OBS >::increment_
private

Definition at line 108 of file ControlIncrement.h.

◆ modbias_

template<typename MODEL , typename OBS >
ModelAuxIncr_ oops::ControlIncrement< MODEL, OBS >::modbias_
private

Definition at line 109 of file ControlIncrement.h.

◆ obsbias_

template<typename MODEL , typename OBS >
ObsAuxIncrs_ oops::ControlIncrement< MODEL, OBS >::obsbias_
private

Definition at line 110 of file ControlIncrement.h.

◆ windowBegin_

template<typename MODEL , typename OBS >
const util::DateTime oops::ControlIncrement< MODEL, OBS >::windowBegin_
private

Definition at line 111 of file ControlIncrement.h.

◆ windowEnd_

template<typename MODEL , typename OBS >
const util::DateTime oops::ControlIncrement< MODEL, OBS >::windowEnd_
private

Definition at line 112 of file ControlIncrement.h.

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