oops::CovarianceFactory< MODEL > Class Template Reference

Covariance Factory. More...

#include <ModelSpaceCovarianceBase.h>

Inheritance diagram for oops::CovarianceFactory< MODEL >:

Public Member Functions
virtual	~CovarianceFactory ()=default

Static Public Member Functions
static ModelSpaceCovarianceBase< MODEL > *	create (const ModelSpaceCovarianceParametersBase< MODEL > &, const Geometry_ &, const Variables &, const State_ &, const State_ &)
	Create and return a new covariance model. More...
static ModelSpaceCovarianceBase< MODEL > *	create (const eckit::Configuration &, const Geometry_ &, const Variables &, const State_ &, const State_ &)
	Create and return a new covariance model. More...
static std::unique_ptr< ModelSpaceCovarianceParametersBase< MODEL > >	createParameters (const std::string &covarianceModel)
	Create and return an instance of the subclass of ModelSpaceCovarianceParametersBase storing parameters of the specified covariance model. More...
static std::vector< std::string >	getMakerNames ()
	Return the names of all covariance models that can be created by one of the registered makers. More...

Protected Member Functions
	CovarianceFactory (const std::string &name)
	Register a maker able to create covariance models of type name. More...

Private Types
typedef Geometry< MODEL >	Geometry_
typedef State< MODEL >	State_

Private Member Functions
virtual ModelSpaceCovarianceBase< MODEL > *	make (const ModelSpaceCovarianceParametersBase< MODEL > &, const Geometry_ &, const Variables &, const State_ &, const State_ &)=0
virtual std::unique_ptr< ModelSpaceCovarianceParametersBase< MODEL > >	makeParameters () const =0

Static Private Member Functions
static std::map< std::string, CovarianceFactory< MODEL > * > &	getMakers ()

Detailed Description

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

Covariance Factory.

Definition at line 138 of file ModelSpaceCovarianceBase.h.

Member Typedef Documentation

Geometry_

template<typename MODEL >

typedef Geometry<MODEL> oops::CovarianceFactory< MODEL >::Geometry_

private

Definition at line 139 of file ModelSpaceCovarianceBase.h.

State_

template<typename MODEL >

typedef State<MODEL> oops::CovarianceFactory< MODEL >::State_

private

Definition at line 140 of file ModelSpaceCovarianceBase.h.

Constructor & Destructor Documentation

~CovarianceFactory()

template<typename MODEL >

virtual oops::CovarianceFactory< MODEL >::~CovarianceFactory ( )

virtualdefault

CovarianceFactory()

template<typename MODEL >

oops::CovarianceFactory< MODEL >::CovarianceFactory ( const std::string &  name )

explicitprotected

Register a maker able to create covariance models of type name.

Definition at line 222 of file ModelSpaceCovarianceBase.h.

Member Function Documentation

create() [1/2]

template<typename MODEL >

ModelSpaceCovarianceBase< MODEL > * oops::CovarianceFactory< MODEL >::create ( const eckit::Configuration &  conf, const Geometry_ &  resol, const Variables &  vars, const State_ &  xb, const State_ &  fg  )

static

Create and return a new covariance model.

Deprecated overload taking a Configuration instead of a ModelSpaceCovarianceParametersBase.

Definition at line 272 of file ModelSpaceCovarianceBase.h.

create() [2/2]

template<typename MODEL >

ModelSpaceCovarianceBase< MODEL > * oops::CovarianceFactory< MODEL >::create ( const ModelSpaceCovarianceParametersBase< MODEL > &  parameters, const Geometry_ &  resol, const Variables &  vars, const State_ &  xb, const State_ &  fg  )

static

Create and return a new covariance model.

The covariance model is determined by the covarianceModel attribute of parameters. parameters must be an instance of the subclass of ModelSpaceCovarianceParametersBase associated with that covariance model, otherwise an exception will be thrown.

Definition at line 232 of file ModelSpaceCovarianceBase.h.

createParameters()

template<typename MODEL >

std::unique_ptr< ModelSpaceCovarianceParametersBase< MODEL > > oops::CovarianceFactory< MODEL >::createParameters ( const std::string &  covarianceModel )

static

Create and return an instance of the subclass of ModelSpaceCovarianceParametersBase storing parameters of the specified covariance model.

Definition at line 286 of file ModelSpaceCovarianceBase.h.

getMakerNames()

template<typename MODEL >

static std::vector<std::string> oops::CovarianceFactory< MODEL >::getMakerNames ( )

inlinestatic

Return the names of all covariance models that can be created by one of the registered makers.

Definition at line 166 of file ModelSpaceCovarianceBase.h.

Here is the call graph for this function:

Here is the caller graph for this function:

getMakers()

template<typename MODEL >

static std::map< std::string, CovarianceFactory<MODEL> * >& oops::CovarianceFactory< MODEL >::getMakers ( )

inlinestaticprivate

Definition at line 183 of file ModelSpaceCovarianceBase.h.

Here is the caller graph for this function:

make()

template<typename MODEL >

virtual ModelSpaceCovarianceBase<MODEL>* oops::CovarianceFactory< MODEL >::make ( const ModelSpaceCovarianceParametersBase< MODEL > &  , const Geometry_ &  , const Variables &  , const State_ &  , const State_ &    )

privatepure virtual

Implemented in oops::CovarMaker< MODEL, COVAR >.

makeParameters()

template<typename MODEL >

virtual std::unique_ptr<ModelSpaceCovarianceParametersBase<MODEL> > oops::CovarianceFactory< MODEL >::makeParameters ( ) const

privatepure virtual

Implemented in oops::CovarMaker< MODEL, COVAR >.

---

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

• ModelSpaceCovarianceBase.h