oops::ModelSpaceCovarianceParametersBase< MODEL > Class Template Reference

Base class for classes storing parameters of a particular model-space error covariance implementation. More...

#include <ModelSpaceCovarianceParametersBase.h>

Inheritance diagram for oops::ModelSpaceCovarianceParametersBase< MODEL >:

Collaboration diagram for oops::ModelSpaceCovarianceParametersBase< MODEL >:

Public Attributes
OptionalParameter< std::string >	covarianceModel {"covariance model", this}
	Covariance model name. More...
Parameter< std::vector< LinearVariableChangeParametersWrapper< MODEL > > >	variableChanges
Parameter< size_t >	randomizationSize {"randomization size", 50, this}
Parameter< bool >	fullInverse {"full inverse", false, this}
Parameter< int >	fullInverseIterations {"full inverse iterations", 10, this}
Parameter< double >	fullInverseAccuracy {"full inverse accuracy", 1.0e-3, this}

Detailed Description

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

Base class for classes storing parameters of a particular model-space error covariance implementation.

Definition at line 25 of file ModelSpaceCovarianceParametersBase.h.

Member Data Documentation

covarianceModel

template<typename MODEL >

OptionalParameter<std::string> oops::ModelSpaceCovarianceParametersBase< MODEL >::covarianceModel {"covariance model", this}

Covariance model name.

Note

This parameter is marked as optional because it is only required in certain circumstances (e.g. when covariance model parameters are deserialized into a ModelSpaceCovarianceParametersWrapper and used by CovarianceFactory to instantiate a covariance model whose type is determined at runtime), but not others (e.g. in tests written with a particular model in mind). ModelSpaceCovarianceParametersWrapper will throw an exception if this parameter is not provided.

Definition at line 36 of file ModelSpaceCovarianceParametersBase.h.

fullInverse

template<typename MODEL >

Parameter<bool> oops::ModelSpaceCovarianceParametersBase< MODEL >::fullInverse {"full inverse", false, this}

Definition at line 41 of file ModelSpaceCovarianceParametersBase.h.

fullInverseAccuracy

template<typename MODEL >

Parameter<double> oops::ModelSpaceCovarianceParametersBase< MODEL >::fullInverseAccuracy {"full inverse accuracy", 1.0e-3, this}

Definition at line 43 of file ModelSpaceCovarianceParametersBase.h.

fullInverseIterations

template<typename MODEL >

Parameter<int> oops::ModelSpaceCovarianceParametersBase< MODEL >::fullInverseIterations {"full inverse iterations", 10, this}

Definition at line 42 of file ModelSpaceCovarianceParametersBase.h.

randomizationSize

template<typename MODEL >

Parameter<size_t> oops::ModelSpaceCovarianceParametersBase< MODEL >::randomizationSize {"randomization size", 50, this}

Definition at line 40 of file ModelSpaceCovarianceParametersBase.h.

variableChanges

template<typename MODEL >

Parameter<std::vector<LinearVariableChangeParametersWrapper<MODEL> > > oops::ModelSpaceCovarianceParametersBase< MODEL >::variableChanges

Initial value:

{
    "variable changes", {}, this}

Definition at line 38 of file ModelSpaceCovarianceParametersBase.h.

---

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

• ModelSpaceCovarianceParametersBase.h