oops::LocalizationBase< MODEL > Class Template Reference

Base class for generic implementations of model-space localization. Use this class as a base class for generic implementations, and interface::LocalizationBase as a base class for MODEL-specific implementations. More...

#include <LocalizationBase.h>

Inheritance diagram for oops::LocalizationBase< MODEL >:

Collaboration diagram for oops::LocalizationBase< MODEL >:

Public Member Functions
	LocalizationBase ()=default
virtual	~LocalizationBase ()=default
virtual void	randomize (Increment_ &dx) const =0
	Randomize dx and apply 3D localization. More...
virtual void	multiply (Increment_ &dx) const =0
	Apply 3D localization to dx. More...

Private Types
typedef Increment< MODEL >	Increment_

Detailed Description

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

Base class for generic implementations of model-space localization. Use this class as a base class for generic implementations, and interface::LocalizationBase as a base class for MODEL-specific implementations.

Note: generic implementations need to provide a constructor with the following signature:

LocalizationBase(const Geometry<MODEL> &,
                 const eckit::Configuration &); 

Definition at line 43 of file generic/LocalizationBase.h.

Member Typedef Documentation

Increment_

template<typename MODEL >

typedef Increment<MODEL> oops::LocalizationBase< MODEL >::Increment_

private

Definition at line 45 of file generic/LocalizationBase.h.

Constructor & Destructor Documentation

LocalizationBase()

template<typename MODEL >

oops::LocalizationBase< MODEL >::LocalizationBase ( )

default

~LocalizationBase()

template<typename MODEL >

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

virtualdefault

Reimplemented in oops::interface::LocalizationBase< MODEL >, oops::interface::LocalizationBase< lorenz95::L95Traits >, and oops::interface::LocalizationBase< qg::QgTraits >.

Member Function Documentation

multiply()

template<typename MODEL >

virtual void oops::LocalizationBase< MODEL >::multiply ( Increment_ &  dx ) const

pure virtual

Apply 3D localization to dx.

Implemented in oops::interface::LocalizationBase< MODEL >, oops::interface::LocalizationBase< lorenz95::L95Traits >, oops::interface::LocalizationBase< qg::QgTraits >, and oops::interface::LocalizationBase< MODEL >.

randomize()

template<typename MODEL >

virtual void oops::LocalizationBase< MODEL >::randomize ( Increment_ &  dx ) const

pure virtual

Randomize dx and apply 3D localization.

Implemented in oops::interface::LocalizationBase< MODEL >, oops::interface::LocalizationBase< lorenz95::L95Traits >, oops::interface::LocalizationBase< qg::QgTraits >, and oops::interface::LocalizationBase< MODEL >.

---

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

• generic/LocalizationBase.h