Loading [MathJax]/extensions/tex2jax.js
OOPS
All Classes Namespaces Files Functions Variables Typedefs Macros Pages
oops::ObsAuxCovariance< OBS > Class Template Reference

Auxiliary error covariance related to observations, templated on <OBS> More...

#include <ObsAuxCovariance.h>

Inheritance diagram for oops::ObsAuxCovariance< OBS >:
Collaboration diagram for oops::ObsAuxCovariance< OBS >:

Public Types

typedef ObsAuxCovariance_::Parameters_ Parameters_
 

Public Member Functions

 ObsAuxCovariance (const ObsSpace< OBS > &os, const Parameters_ &params)
 Constructor for specified ObsSpace os and params. More...
 
 ~ObsAuxCovariance ()
 Destructor (defined explicitly for timing and tracing) More...
 
void linearize (const ObsAuxControl_ &, const eckit::Configuration &)
 linearize operator More...
 
void multiply (const ObsAuxIncrement_ &, ObsAuxIncrement_ &) const
 Sets the second parameter to the first multiplied by the covariance matrix. More...
 
void inverseMultiply (const ObsAuxIncrement_ &, ObsAuxIncrement_ &) const
 Sets the second parameter to the first multiplied by the inverse covariance matrix. More...
 
void randomize (ObsAuxIncrement_ &) const
 randomize the values in the ObsAuxIncrement More...
 

Static Public Member Functions

static const std::string classname ()
 

Private Types

typedef OBS::ObsAuxCovariance ObsAuxCovariance_
 
typedef ObsAuxControl< OBS > ObsAuxControl_
 
typedef ObsAuxIncrement< OBS > ObsAuxIncrement_
 

Private Member Functions

void print (std::ostream &) const
 

Private Attributes

std::unique_ptr< ObsAuxCovariance_cov_
 

Detailed Description

template<typename OBS>
class oops::ObsAuxCovariance< OBS >

Auxiliary error covariance related to observations, templated on <OBS>

This is currently only used for bias correction coefficient error covariances. This class calls the <OBS> implementation of ObsAuxCovariance.

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

Member Typedef Documentation

◆ ObsAuxControl_

template<typename OBS >
typedef ObsAuxControl<OBS> oops::ObsAuxCovariance< OBS >::ObsAuxControl_
private

Definition at line 43 of file oops/interface/ObsAuxCovariance.h.

◆ ObsAuxCovariance_

template<typename OBS >
typedef OBS::ObsAuxCovariance oops::ObsAuxCovariance< OBS >::ObsAuxCovariance_
private

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

◆ ObsAuxIncrement_

template<typename OBS >
typedef ObsAuxIncrement<OBS> oops::ObsAuxCovariance< OBS >::ObsAuxIncrement_
private

Definition at line 44 of file oops/interface/ObsAuxCovariance.h.

◆ Parameters_

template<typename OBS >
typedef ObsAuxCovariance_::Parameters_ oops::ObsAuxCovariance< OBS >::Parameters_

Definition at line 47 of file oops/interface/ObsAuxCovariance.h.

Constructor & Destructor Documentation

◆ ObsAuxCovariance()

template<typename OBS >
oops::ObsAuxCovariance< OBS >::ObsAuxCovariance ( const ObsSpace< OBS > &  os,
const Parameters_ params 
)

Constructor for specified ObsSpace os and params.

Definition at line 73 of file oops/interface/ObsAuxCovariance.h.

Here is the call graph for this function:

◆ ~ObsAuxCovariance()

template<typename OBS >
oops::ObsAuxCovariance< OBS >::~ObsAuxCovariance

Destructor (defined explicitly for timing and tracing)

Definition at line 85 of file oops/interface/ObsAuxCovariance.h.

Member Function Documentation

◆ classname()

template<typename OBS >
static const std::string oops::ObsAuxCovariance< OBS >::classname ( )
inlinestatic

Definition at line 49 of file oops/interface/ObsAuxCovariance.h.

Here is the caller graph for this function:

◆ inverseMultiply()

template<typename OBS >
void oops::ObsAuxCovariance< OBS >::inverseMultiply ( const ObsAuxIncrement_ dx1,
ObsAuxIncrement_ dx2 
) const

Sets the second parameter to the first multiplied by the inverse covariance matrix.

Definition at line 116 of file oops/interface/ObsAuxCovariance.h.

Here is the call graph for this function:

◆ linearize()

template<typename OBS >
void oops::ObsAuxCovariance< OBS >::linearize ( const ObsAuxControl_ xx,
const eckit::Configuration &  innerConf 
)

linearize operator

Definition at line 95 of file oops/interface/ObsAuxCovariance.h.

Here is the call graph for this function:

◆ multiply()

template<typename OBS >
void oops::ObsAuxCovariance< OBS >::multiply ( const ObsAuxIncrement_ dx1,
ObsAuxIncrement_ dx2 
) const

Sets the second parameter to the first multiplied by the covariance matrix.

Definition at line 106 of file oops/interface/ObsAuxCovariance.h.

Here is the call graph for this function:

◆ print()

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

Definition at line 137 of file oops/interface/ObsAuxCovariance.h.

◆ randomize()

template<typename OBS >
void oops::ObsAuxCovariance< OBS >::randomize ( ObsAuxIncrement_ dx) const

randomize the values in the ObsAuxIncrement

Definition at line 127 of file oops/interface/ObsAuxCovariance.h.

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

Member Data Documentation

◆ cov_

template<typename OBS >
std::unique_ptr<ObsAuxCovariance_> oops::ObsAuxCovariance< OBS >::cov_
private

Definition at line 67 of file oops/interface/ObsAuxCovariance.h.


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