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

#include <LinearVariableChangeBase.h>

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

Public Member Functions

 LinearVariableChangeBase (const LinearVariableChangeParametersBase &)
 
 LinearVariableChangeBase (const eckit::Configuration &)
 
virtual ~LinearVariableChangeBase ()
 
void setInputVariables (const Variables &vars)
 
void setOutputVariables (const Variables &vars)
 
virtual void multiply (const Increment_ &, Increment_ &) const =0
 
virtual void multiplyInverse (const Increment_ &, Increment_ &) const =0
 
virtual void multiplyAD (const Increment_ &, Increment_ &) const =0
 
virtual void multiplyInverseAD (const Increment_ &, Increment_ &) const =0
 
Increment_ multiply (const Increment_ &) const
 
Increment_ multiplyInverse (const Increment_ &) const
 
Increment_ multiplyAD (const Increment_ &) const
 
Increment_ multiplyInverseAD (const Increment_ &) const
 

Private Types

typedef Geometry< MODEL > Geometry_
 
typedef Increment< MODEL > Increment_
 
typedef State< MODEL > State_
 

Private Member Functions

virtual void print (std::ostream &) const =0
 

Private Attributes

std::unique_ptr< Variables > varin_
 
std::unique_ptr< Variables > varout_
 

Detailed Description

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

Base class for generic variable transform

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 linear variable 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 52 of file LinearVariableChangeBase.h.

Member Typedef Documentation

◆ Geometry_

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

Definition at line 54 of file LinearVariableChangeBase.h.

◆ Increment_

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

Definition at line 55 of file LinearVariableChangeBase.h.

◆ State_

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

Definition at line 56 of file LinearVariableChangeBase.h.

Constructor & Destructor Documentation

◆ LinearVariableChangeBase() [1/2]

template<typename MODEL >
oops::LinearVariableChangeBase< MODEL >::LinearVariableChangeBase ( const LinearVariableChangeParametersBase &  parameters)
explicit

Definition at line 271 of file LinearVariableChangeBase.h.

◆ LinearVariableChangeBase() [2/2]

template<typename MODEL >
oops::LinearVariableChangeBase< MODEL >::LinearVariableChangeBase ( const eckit::Configuration &  conf)
explicit

Definition at line 290 of file LinearVariableChangeBase.h.

◆ ~LinearVariableChangeBase()

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

Definition at line 61 of file LinearVariableChangeBase.h.

Member Function Documentation

◆ multiply() [1/2]

template<typename MODEL >
Increment< MODEL > oops::LinearVariableChangeBase< MODEL >::multiply ( const Increment_ &  dxin) const

Definition at line 298 of file LinearVariableChangeBase.h.

Here is the call graph for this function:

◆ multiply() [2/2]

template<typename MODEL >
virtual void oops::LinearVariableChangeBase< MODEL >::multiply ( const Increment_ &  ,
Increment_ &   
) const
pure virtual

Implemented in oops::IdLinearVariableChange< MODEL >, and oops::LinearVariableChange< MODEL, CHVAR >.

◆ multiplyAD() [1/2]

template<typename MODEL >
Increment< MODEL > oops::LinearVariableChangeBase< MODEL >::multiplyAD ( const Increment_ &  dxin) const

Definition at line 308 of file LinearVariableChangeBase.h.

Here is the call graph for this function:

◆ multiplyAD() [2/2]

template<typename MODEL >
virtual void oops::LinearVariableChangeBase< MODEL >::multiplyAD ( const Increment_ &  ,
Increment_ &   
) const
pure virtual

Implemented in oops::IdLinearVariableChange< MODEL >, and oops::LinearVariableChange< MODEL, CHVAR >.

◆ multiplyInverse() [1/2]

template<typename MODEL >
Increment< MODEL > oops::LinearVariableChangeBase< MODEL >::multiplyInverse ( const Increment_ &  dxin) const

Definition at line 318 of file LinearVariableChangeBase.h.

Here is the call graph for this function:

◆ multiplyInverse() [2/2]

template<typename MODEL >
virtual void oops::LinearVariableChangeBase< MODEL >::multiplyInverse ( const Increment_ &  ,
Increment_ &   
) const
pure virtual

Implemented in oops::IdLinearVariableChange< MODEL >, and oops::LinearVariableChange< MODEL, CHVAR >.

◆ multiplyInverseAD() [1/2]

template<typename MODEL >
Increment< MODEL > oops::LinearVariableChangeBase< MODEL >::multiplyInverseAD ( const Increment_ &  dxin) const

Definition at line 328 of file LinearVariableChangeBase.h.

Here is the call graph for this function:

◆ multiplyInverseAD() [2/2]

template<typename MODEL >
virtual void oops::LinearVariableChangeBase< MODEL >::multiplyInverseAD ( const Increment_ &  ,
Increment_ &   
) const
pure virtual

Implemented in oops::IdLinearVariableChange< MODEL >, and oops::LinearVariableChange< MODEL, CHVAR >.

◆ print()

template<typename MODEL >
virtual void oops::LinearVariableChangeBase< MODEL >::print ( std::ostream &  ) const
privatepure virtual

Implemented in oops::IdLinearVariableChange< MODEL >, and oops::LinearVariableChange< MODEL, CHVAR >.

◆ setInputVariables()

template<typename MODEL >
void oops::LinearVariableChangeBase< MODEL >::setInputVariables ( const Variables &  vars)
inline

Definition at line 63 of file LinearVariableChangeBase.h.

◆ setOutputVariables()

template<typename MODEL >
void oops::LinearVariableChangeBase< MODEL >::setOutputVariables ( const Variables &  vars)
inline

Definition at line 64 of file LinearVariableChangeBase.h.

Member Data Documentation

◆ varin_

template<typename MODEL >
std::unique_ptr<Variables> oops::LinearVariableChangeBase< MODEL >::varin_
private

Definition at line 78 of file LinearVariableChangeBase.h.

◆ varout_

template<typename MODEL >
std::unique_ptr<Variables> oops::LinearVariableChangeBase< MODEL >::varout_
private

Definition at line 79 of file LinearVariableChangeBase.h.

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