OOPS
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
oops::ModelSpaceCovarianceBase< MODEL > Class Template Referenceabstract

#include <ModelSpaceCovarianceBase.h>

Inheritance diagram for oops::ModelSpaceCovarianceBase< MODEL >:
Inheritance graph
[legend]

Public Member Functions

 ModelSpaceCovarianceBase (const State_ &, const State_ &, const Geometry_ &, const ModelSpaceCovarianceParametersBase< MODEL > &)
 
 ModelSpaceCovarianceBase (const State_ &, const State_ &, const Geometry_ &, const eckit::Configuration &)
 
virtual ~ModelSpaceCovarianceBase ()
 
void randomize (Increment_ &) const
 
void multiply (const Increment_ &, Increment_ &) const
 
void inverseMultiply (const Increment_ &, Increment_ &) const
 
void getVariance (Increment_ &) const
 

Private Types

typedef Geometry< MODEL > Geometry_
 
typedef State< MODEL > State_
 
typedef Increment< MODEL > Increment_
 
typedef LinearVariableChangeBase< MODEL > LinearVariableChangeBase_
 
typedef boost::ptr_vector< LinearVariableChangeBase_ > ChvarVec_
 
typedef ChvarVec_::iterator iter_
 
typedef ChvarVec_::const_iterator icst_
 
typedef ChvarVec_::const_reverse_iterator ircst_
 

Private Member Functions

virtual void doRandomize (Increment_ &) const =0
 
virtual void doMultiply (const Increment_ &, Increment_ &) const =0
 
virtual void doInverseMultiply (const Increment_ &, Increment_ &) const =0
 

Private Attributes

ChvarVec_ chvars_
 
size_t randomizationSize_
 
bool fullInverse_
 
int fullInverseIterations_
 
double fullInverseAccuracy_
 

Detailed Description

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

Abstract base class for model space error covariances.

Note: subclasses can opt to extract their settings either from a Configuration object or from a subclass of Parameters.

In the former case, they should provide a constructor taking a const reference to an eckit::Configuration object. In the latter case, the implementer should first define a subclass of Parameters holding the settings of the model-space covariance change in question. The latter should then typedef Parameters_ to the name of that subclass and provide a constructor taking a const reference to an instance of that subclass.

Definition at line 64 of file ModelSpaceCovarianceBase.h.

Member Typedef Documentation

◆ ChvarVec_

template<typename MODEL >
typedef boost::ptr_vector<LinearVariableChangeBase_> oops::ModelSpaceCovarianceBase< MODEL >::ChvarVec_
private

Definition at line 69 of file ModelSpaceCovarianceBase.h.

◆ Geometry_

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

Definition at line 65 of file ModelSpaceCovarianceBase.h.

◆ icst_

template<typename MODEL >
typedef ChvarVec_::const_iterator oops::ModelSpaceCovarianceBase< MODEL >::icst_
private

Definition at line 71 of file ModelSpaceCovarianceBase.h.

◆ Increment_

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

Definition at line 67 of file ModelSpaceCovarianceBase.h.

◆ ircst_

template<typename MODEL >
typedef ChvarVec_::const_reverse_iterator oops::ModelSpaceCovarianceBase< MODEL >::ircst_
private

Definition at line 72 of file ModelSpaceCovarianceBase.h.

◆ iter_

template<typename MODEL >
typedef ChvarVec_::iterator oops::ModelSpaceCovarianceBase< MODEL >::iter_
private

Definition at line 70 of file ModelSpaceCovarianceBase.h.

◆ LinearVariableChangeBase_

template<typename MODEL >
typedef LinearVariableChangeBase<MODEL> oops::ModelSpaceCovarianceBase< MODEL >::LinearVariableChangeBase_
private

Definition at line 68 of file ModelSpaceCovarianceBase.h.

◆ State_

template<typename MODEL >
typedef State<MODEL> oops::ModelSpaceCovarianceBase< MODEL >::State_
private

Definition at line 66 of file ModelSpaceCovarianceBase.h.

Constructor & Destructor Documentation

◆ ModelSpaceCovarianceBase() [1/2]

template<typename MODEL >
oops::ModelSpaceCovarianceBase< MODEL >::ModelSpaceCovarianceBase ( const State_ &  bg,
const State_ &  fg,
const Geometry_ &  resol,
const ModelSpaceCovarianceParametersBase< MODEL > &  parameters 
)

Definition at line 304 of file ModelSpaceCovarianceBase.h.

◆ ModelSpaceCovarianceBase() [2/2]

template<typename MODEL >
oops::ModelSpaceCovarianceBase< MODEL >::ModelSpaceCovarianceBase ( const State_ &  bg,
const State_ &  fg,
const Geometry_ &  resol,
const eckit::Configuration &  conf 
)

Definition at line 322 of file ModelSpaceCovarianceBase.h.

◆ ~ModelSpaceCovarianceBase()

template<typename MODEL >
virtual oops::ModelSpaceCovarianceBase< MODEL >::~ModelSpaceCovarianceBase ( )
inlinevirtual

Definition at line 79 of file ModelSpaceCovarianceBase.h.

Member Function Documentation

◆ doInverseMultiply()

template<typename MODEL >
virtual void oops::ModelSpaceCovarianceBase< MODEL >::doInverseMultiply ( const Increment_ &  ,
Increment_ &   
) const
privatepure virtual

Implemented in oops::ErrorCovariance< MODEL >, oops::HybridCovariance< MODEL >, and oops::EnsembleCovariance< MODEL >.

◆ doMultiply()

template<typename MODEL >
virtual void oops::ModelSpaceCovarianceBase< MODEL >::doMultiply ( const Increment_ &  ,
Increment_ &   
) const
privatepure virtual

Implemented in oops::ErrorCovariance< MODEL >, oops::HybridCovariance< MODEL >, and oops::EnsembleCovariance< MODEL >.

◆ doRandomize()

template<typename MODEL >
virtual void oops::ModelSpaceCovarianceBase< MODEL >::doRandomize ( Increment_ &  ) const
privatepure virtual

Implemented in oops::ErrorCovariance< MODEL >, oops::HybridCovariance< MODEL >, and oops::EnsembleCovariance< MODEL >.

◆ getVariance()

template<typename MODEL >
void oops::ModelSpaceCovarianceBase< MODEL >::getVariance ( Increment_ &  variance) const

Definition at line 412 of file ModelSpaceCovarianceBase.h.

Here is the call graph for this function:

◆ inverseMultiply()

template<typename MODEL >
void oops::ModelSpaceCovarianceBase< MODEL >::inverseMultiply ( const Increment_ &  dxi,
Increment_ &  dxo 
) const

Definition at line 377 of file ModelSpaceCovarianceBase.h.

Here is the call graph for this function:

◆ multiply()

template<typename MODEL >
void oops::ModelSpaceCovarianceBase< MODEL >::multiply ( const Increment_ &  dxi,
Increment_ &  dxo 
) const

Definition at line 349 of file ModelSpaceCovarianceBase.h.

◆ randomize()

template<typename MODEL >
void oops::ModelSpaceCovarianceBase< MODEL >::randomize ( Increment_ &  dx) const

Definition at line 333 of file ModelSpaceCovarianceBase.h.

Member Data Documentation

◆ chvars_

template<typename MODEL >
ChvarVec_ oops::ModelSpaceCovarianceBase< MODEL >::chvars_
private

Definition at line 91 of file ModelSpaceCovarianceBase.h.

◆ fullInverse_

template<typename MODEL >
bool oops::ModelSpaceCovarianceBase< MODEL >::fullInverse_
private

Definition at line 93 of file ModelSpaceCovarianceBase.h.

◆ fullInverseAccuracy_

template<typename MODEL >
double oops::ModelSpaceCovarianceBase< MODEL >::fullInverseAccuracy_
private

Definition at line 95 of file ModelSpaceCovarianceBase.h.

◆ fullInverseIterations_

template<typename MODEL >
int oops::ModelSpaceCovarianceBase< MODEL >::fullInverseIterations_
private

Definition at line 94 of file ModelSpaceCovarianceBase.h.

◆ randomizationSize_

template<typename MODEL >
size_t oops::ModelSpaceCovarianceBase< MODEL >::randomizationSize_
private

Definition at line 92 of file ModelSpaceCovarianceBase.h.

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