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

Jb Cost Function Base Class. More...

#include <CostJbState.h>

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

Public Member Functions

 CostJbState ()
 Constructor. More...
 
virtual ~CostJbState ()
 Destructor. More...
 
virtual void computeIncrement (const State_ &, const State_ &, const State_ &, Increment_ &) const =0
 
virtual void linearize (const State_ &, const Geometry_ &)=0
 Linearize before the linear computations. More...
 
virtual void addGradient (const Increment_ &, Increment_ &, Increment_ &) const =0
 Add Jb gradient. More...
 
virtual JqTermTLAD< MODEL > * initializeJqTLAD () const =0
 Initialize Jq computations if needed. More...
 
virtual JqTermTLAD< MODEL > * initializeJqTL () const =0
 Finalize \( J_b\) after the TL run. More...
 
virtual JqTermTLAD< MODEL > * initializeJqAD (const Increment_ &) const =0
 Initialize \( J_b\) before the AD run. More...
 
virtual void Bmult (const Increment_ &, Increment_ &) const =0
 Multiply by \( B\) and \( B^{-1}\). More...
 
virtual void Bminv (const Increment_ &, Increment_ &) const =0
 
virtual void randomize (Increment_ &) const =0
 Randomize. More...
 
virtual Increment_ * newStateIncrement () const =0
 Create new increment (set to 0). More...
 

Private Types

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

Detailed Description

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

Jb Cost Function Base Class.

The CostJbState is the base class for the Jb term corresponding to the state part of the control variable.

Definition at line 37 of file CostJbState.h.

Member Typedef Documentation

◆ Geometry_

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

Definition at line 38 of file CostJbState.h.

◆ Increment_

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

Definition at line 39 of file CostJbState.h.

◆ State_

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

Definition at line 40 of file CostJbState.h.

Constructor & Destructor Documentation

◆ CostJbState()

template<typename MODEL >
oops::CostJbState< MODEL >::CostJbState ( )
inline

Constructor.

Definition at line 44 of file CostJbState.h.

◆ ~CostJbState()

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

Destructor.

Definition at line 47 of file CostJbState.h.

Member Function Documentation

◆ addGradient()

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

Add Jb gradient.

Implemented in oops::CostJbJq< MODEL >, oops::CostJb4D< MODEL >, and oops::CostJb3D< MODEL >.

◆ Bminv()

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

Implemented in oops::CostJbJq< MODEL >, oops::CostJb4D< MODEL >, and oops::CostJb3D< MODEL >.

◆ Bmult()

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

Multiply by \( B\) and \( B^{-1}\).

Implemented in oops::CostJbJq< MODEL >, oops::CostJb4D< MODEL >, and oops::CostJb3D< MODEL >.

◆ computeIncrement()

template<typename MODEL >
virtual void oops::CostJbState< MODEL >::computeIncrement ( const State_ &  ,
const State_ &  ,
const State_ &  ,
Increment_ &   
) const
pure virtual

Get increment from state. This is usually first guess - background. The third state argument is M(x) at the end of the window/subwindows for computing the model error term (M(x_{i-1})-x_i) when active.

Implemented in oops::CostJbJq< MODEL >, oops::CostJb4D< MODEL >, and oops::CostJb3D< MODEL >.

◆ initializeJqAD()

template<typename MODEL >
virtual JqTermTLAD<MODEL>* oops::CostJbState< MODEL >::initializeJqAD ( const Increment_ &  ) const
pure virtual

Initialize \( J_b\) before the AD run.

Implemented in oops::CostJbJq< MODEL >, oops::CostJb4D< MODEL >, and oops::CostJb3D< MODEL >.

◆ initializeJqTL()

template<typename MODEL >
virtual JqTermTLAD<MODEL>* oops::CostJbState< MODEL >::initializeJqTL ( ) const
pure virtual

Finalize \( J_b\) after the TL run.

Implemented in oops::CostJbJq< MODEL >, oops::CostJb4D< MODEL >, and oops::CostJb3D< MODEL >.

◆ initializeJqTLAD()

template<typename MODEL >
virtual JqTermTLAD<MODEL>* oops::CostJbState< MODEL >::initializeJqTLAD ( ) const
pure virtual

Initialize Jq computations if needed.

Implemented in oops::CostJbJq< MODEL >, oops::CostJb4D< MODEL >, and oops::CostJb3D< MODEL >.

◆ linearize()

template<typename MODEL >
virtual void oops::CostJbState< MODEL >::linearize ( const State_ &  ,
const Geometry_ &   
)
pure virtual

Linearize before the linear computations.

Implemented in oops::CostJbJq< MODEL >, oops::CostJb4D< MODEL >, and oops::CostJb3D< MODEL >.

◆ newStateIncrement()

template<typename MODEL >
virtual Increment_* oops::CostJbState< MODEL >::newStateIncrement ( ) const
pure virtual

Create new increment (set to 0).

Implemented in oops::CostJbJq< MODEL >, oops::CostJb4D< MODEL >, and oops::CostJb3D< MODEL >.

◆ randomize()

template<typename MODEL >
virtual void oops::CostJbState< MODEL >::randomize ( Increment_ &  ) const
pure virtual

Randomize.

Implemented in oops::CostJbJq< MODEL >, oops::CostJb4D< MODEL >, and oops::CostJb3D< MODEL >.

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