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

Base class for MODEL-specific implementations of VariableChange class. The complete interface that needs to be implemented is described in GenericVariableChangeBase. VariableChangeBase overrides GenericVariableChangeBase methods to pass MODEL-specific implementations of State to the MODEL-specific implementation of VariableChange. More...

#include <VariableChangeBase.h>

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

Public Member Functions

 VariableChangeBase ()=default
 
virtual ~VariableChangeBase ()=default
 
void changeVar (const State< MODEL > &xin, State< MODEL > &xout) const final
 
void changeVarInverse (const State< MODEL > &xout, State< MODEL > &xin) const final
 inverse of changeVar, change variables back from xout to xin More...
 
virtual void changeVar (const State_ &xin, State_ &xout) const =0
 change variables from state xin to xout More...
 
virtual void changeVarInverse (const State_ &xout, State_ &xin) const =0
 inverse of changeVar, change variables back from xout to xin More...
 
- Public Member Functions inherited from oops::GenericVariableChangeBase< MODEL >
 GenericVariableChangeBase ()=default
 
virtual ~GenericVariableChangeBase ()=default
 

Private Types

typedef MODEL::State State_
 

Detailed Description

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

Base class for MODEL-specific implementations of VariableChange class. The complete interface that needs to be implemented is described in GenericVariableChangeBase. VariableChangeBase overrides GenericVariableChangeBase methods to pass MODEL-specific implementations of State to the MODEL-specific implementation of VariableChange.

Definition at line 79 of file VariableChangeBase.h.

Member Typedef Documentation

◆ State_

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

Definition at line 80 of file VariableChangeBase.h.

Constructor & Destructor Documentation

◆ VariableChangeBase()

template<typename MODEL >
oops::VariableChangeBase< MODEL >::VariableChangeBase ( )
default

◆ ~VariableChangeBase()

template<typename MODEL >
virtual oops::VariableChangeBase< MODEL >::~VariableChangeBase ( )
virtualdefault

Member Function Documentation

◆ changeVar() [1/2]

template<typename MODEL >
void oops::VariableChangeBase< MODEL >::changeVar ( const State< MODEL > &  xin,
State< MODEL > &  xout 
) const
inlinefinalvirtual

Overrides for VariableChangeBase classes, passing MODEL-specific classes to the MODEL-specific implementations of VariableChange

Implements oops::GenericVariableChangeBase< MODEL >.

Definition at line 88 of file VariableChangeBase.h.

◆ changeVar() [2/2]

template<typename MODEL >
virtual void oops::VariableChangeBase< MODEL >::changeVar ( const State_ &  xin,
State_ &  xout 
) const
pure virtual

change variables from state xin to xout

Implements oops::GenericVariableChangeBase< MODEL >.

◆ changeVarInverse() [1/2]

template<typename MODEL >
void oops::VariableChangeBase< MODEL >::changeVarInverse ( const State< MODEL > &  xout,
State< MODEL > &  xin 
) const
inlinefinalvirtual

inverse of changeVar, change variables back from xout to xin

Implements oops::GenericVariableChangeBase< MODEL >.

Definition at line 90 of file VariableChangeBase.h.

◆ changeVarInverse() [2/2]

template<typename MODEL >
virtual void oops::VariableChangeBase< MODEL >::changeVarInverse ( const State_ &  xout,
State_ &  xin 
) const
pure virtual

inverse of changeVar, change variables back from xout to xin

Implements oops::GenericVariableChangeBase< MODEL >.

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