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

Control variable. More...

#include <ControlVariable.h>

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

Public Member Functions

 ControlVariable (const eckit::Configuration &, const Geometry_ &, const ObsSpaces_ &)
 The arguments define the number of sub-windows and the resolution. More...
 
 ControlVariable (const ControlVariable &)
 
 ~ControlVariable ()
 
void read (const eckit::Configuration &)
 I/O and diagnostics. More...
 
void write (const eckit::Configuration &) const
 
double norm () const
 
State_ & state ()
 Get state control variable. More...
 
const State_ & state () const
 
ModelAux_ & modVar ()
 Get augmented model control variable. More...
 
const ModelAux_ & modVar () const
 
ObsAuxCtrls_ & obsVar ()
 Get augmented observation control variable. More...
 
const ObsAuxCtrls_ & obsVar () const
 

Static Public Member Functions

static const std::string classname ()
 

Private Types

typedef Geometry< MODEL > Geometry_
 
typedef ModelAuxControl< MODEL > ModelAux_
 
typedef ObsAuxControls< OBS > ObsAuxCtrls_
 
typedef ObsSpaces< OBS > ObsSpaces_
 
typedef State< MODEL > State_
 

Private Member Functions

ControlVariable & operator= (const ControlVariable &)
 
void print (std::ostream &) const
 

Private Attributes

State_ state_
 
ModelAux_ modbias_
 
ObsAuxCtrls_ obsbias_
 

Detailed Description

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

Control variable.

The control variable acts as a container for the inputs of the variational data assimilation cost functions in physical space. That includes the states at the start the assimilation window or of each sub-window but also additional variables such as model bias, VarBC coefficients, or other control variables for algorithms that use them. This is mostly a convenience class that is used to keep things together and reduce the number of arguments to be passed around.

Definition at line 45 of file ControlVariable.h.

Member Typedef Documentation

◆ Geometry_

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

Definition at line 47 of file ControlVariable.h.

◆ ModelAux_

template<typename MODEL , typename OBS >
typedef ModelAuxControl<MODEL> oops::ControlVariable< MODEL, OBS >::ModelAux_
private

Definition at line 48 of file ControlVariable.h.

◆ ObsAuxCtrls_

template<typename MODEL , typename OBS >
typedef ObsAuxControls<OBS> oops::ControlVariable< MODEL, OBS >::ObsAuxCtrls_
private

Definition at line 49 of file ControlVariable.h.

◆ ObsSpaces_

template<typename MODEL , typename OBS >
typedef ObsSpaces<OBS> oops::ControlVariable< MODEL, OBS >::ObsSpaces_
private

Definition at line 50 of file ControlVariable.h.

◆ State_

template<typename MODEL , typename OBS >
typedef State<MODEL> oops::ControlVariable< MODEL, OBS >::State_
private

Definition at line 51 of file ControlVariable.h.

Constructor & Destructor Documentation

◆ ControlVariable() [1/2]

template<typename MODEL , typename OBS >
oops::ControlVariable< MODEL, OBS >::ControlVariable ( const eckit::Configuration &  conf,
const Geometry_ &  resol,
const ObsSpaces_ &  odb 
)

The arguments define the number of sub-windows and the resolution.

Definition at line 90 of file ControlVariable.h.

◆ ControlVariable() [2/2]

template<typename MODEL , typename OBS >
oops::ControlVariable< MODEL, OBS >::ControlVariable ( const ControlVariable< MODEL, OBS > &  other)
explicit

Definition at line 102 of file ControlVariable.h.

◆ ~ControlVariable()

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

Definition at line 111 of file ControlVariable.h.

Member Function Documentation

◆ classname()

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

Definition at line 54 of file ControlVariable.h.

◆ modVar() [1/2]

template<typename MODEL , typename OBS >
ModelAux_& oops::ControlVariable< MODEL, OBS >::modVar ( )
inline

Get augmented model control variable.

Definition at line 71 of file ControlVariable.h.

Here is the caller graph for this function:

◆ modVar() [2/2]

template<typename MODEL , typename OBS >
const ModelAux_& oops::ControlVariable< MODEL, OBS >::modVar ( ) const
inline

Definition at line 72 of file ControlVariable.h.

◆ norm()

template<typename MODEL , typename OBS >
double oops::ControlVariable< MODEL, OBS >::norm

Definition at line 145 of file ControlVariable.h.

◆ obsVar() [1/2]

template<typename MODEL , typename OBS >
ObsAuxCtrls_& oops::ControlVariable< MODEL, OBS >::obsVar ( )
inline

Get augmented observation control variable.

Definition at line 75 of file ControlVariable.h.

Here is the caller graph for this function:

◆ obsVar() [2/2]

template<typename MODEL , typename OBS >
const ObsAuxCtrls_& oops::ControlVariable< MODEL, OBS >::obsVar ( ) const
inline

Definition at line 76 of file ControlVariable.h.

◆ operator=()

template<typename MODEL , typename OBS >
ControlVariable& oops::ControlVariable< MODEL, OBS >::operator= ( const ControlVariable< MODEL, OBS > &  )
private

◆ print()

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

Definition at line 136 of file ControlVariable.h.

◆ read()

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

I/O and diagnostics.

Definition at line 118 of file ControlVariable.h.

◆ state() [1/2]

template<typename MODEL , typename OBS >
State_& oops::ControlVariable< MODEL, OBS >::state ( )
inline

Get state control variable.

Definition at line 67 of file ControlVariable.h.

Here is the caller graph for this function:

◆ state() [2/2]

template<typename MODEL , typename OBS >
const State_& oops::ControlVariable< MODEL, OBS >::state ( ) const
inline

Definition at line 68 of file ControlVariable.h.

Here is the caller graph for this function:

◆ write()

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

Definition at line 127 of file ControlVariable.h.

Member Data Documentation

◆ modbias_

template<typename MODEL , typename OBS >
ModelAux_ oops::ControlVariable< MODEL, OBS >::modbias_
private

Definition at line 83 of file ControlVariable.h.

◆ obsbias_

template<typename MODEL , typename OBS >
ObsAuxCtrls_ oops::ControlVariable< MODEL, OBS >::obsbias_
private

Definition at line 84 of file ControlVariable.h.

◆ state_

template<typename MODEL , typename OBS >
State_ oops::ControlVariable< MODEL, OBS >::state_
private

Definition at line 82 of file ControlVariable.h.

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