OOPS
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
oops::SaddlePointPrecondMatrix< MODEL, OBS > Class Template Reference

The preconditioner for the saddle-point minimizer. More...

#include <SaddlePointPrecondMatrix.h>

Inheritance diagram for oops::SaddlePointPrecondMatrix< MODEL, OBS >:
Inheritance graph
[legend]
Collaboration diagram for oops::SaddlePointPrecondMatrix< MODEL, OBS >:
Collaboration graph
[legend]

Public Member Functions

 SaddlePointPrecondMatrix (const CostFct_ &j)
 
void multiply (const SPVector_ &, SPVector_ &) const
 

Private Types

typedef ControlIncrement< MODEL, OBS > CtrlInc_
 
typedef CostFctWeak< MODEL, OBS > CostFctWeak_
 
typedef CostFunction< MODEL, OBS > CostFct_
 
typedef SaddlePointVector< MODEL, OBS > SPVector_
 

Private Member Functions

void Lhatinv (const CtrlInc_ &, CtrlInc_ &, const int) const
 
void Lhatinvt (const CtrlInc_ &, CtrlInc_ &, const int) const
 

Private Attributes

const CostFctWeak_ & j_
 
const bool idmodel_
 

Detailed Description

template<typename MODEL, typename OBS>
class oops::SaddlePointPrecondMatrix< MODEL, OBS >

The preconditioner for the saddle-point minimizer.

The solvers represent matrices as objects that implement a "multiply" method. This class defines objects that apply the saddle-point matrix.

Definition at line 32 of file SaddlePointPrecondMatrix.h.

Member Typedef Documentation

◆ CostFct_

template<typename MODEL , typename OBS >
typedef CostFunction<MODEL, OBS> oops::SaddlePointPrecondMatrix< MODEL, OBS >::CostFct_
private

Definition at line 35 of file SaddlePointPrecondMatrix.h.

◆ CostFctWeak_

template<typename MODEL , typename OBS >
typedef CostFctWeak<MODEL, OBS> oops::SaddlePointPrecondMatrix< MODEL, OBS >::CostFctWeak_
private

Definition at line 34 of file SaddlePointPrecondMatrix.h.

◆ CtrlInc_

template<typename MODEL , typename OBS >
typedef ControlIncrement<MODEL, OBS> oops::SaddlePointPrecondMatrix< MODEL, OBS >::CtrlInc_
private

Definition at line 33 of file SaddlePointPrecondMatrix.h.

◆ SPVector_

template<typename MODEL , typename OBS >
typedef SaddlePointVector<MODEL, OBS> oops::SaddlePointPrecondMatrix< MODEL, OBS >::SPVector_
private

Definition at line 36 of file SaddlePointPrecondMatrix.h.

Constructor & Destructor Documentation

◆ SaddlePointPrecondMatrix()

template<typename MODEL , typename OBS >
oops::SaddlePointPrecondMatrix< MODEL, OBS >::SaddlePointPrecondMatrix ( const CostFct_ &  j)
explicit

Definition at line 53 of file SaddlePointPrecondMatrix.h.

Member Function Documentation

◆ Lhatinv()

template<typename MODEL , typename OBS >
void oops::SaddlePointPrecondMatrix< MODEL, OBS >::Lhatinv ( const CtrlInc_ &  xx,
CtrlInc_ &  zz,
const int  norder 
) const
private

Definition at line 85 of file SaddlePointPrecondMatrix.h.

Here is the call graph for this function:

◆ Lhatinvt()

template<typename MODEL , typename OBS >
void oops::SaddlePointPrecondMatrix< MODEL, OBS >::Lhatinvt ( const CtrlInc_ &  xx,
CtrlInc_ &  zz,
const int  norder 
) const
private

Definition at line 101 of file SaddlePointPrecondMatrix.h.

Here is the call graph for this function:

◆ multiply()

template<typename MODEL , typename OBS >
void oops::SaddlePointPrecondMatrix< MODEL, OBS >::multiply ( const SPVector_ &  x,
SPVector_ &  z 
) const

Definition at line 61 of file SaddlePointPrecondMatrix.h.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ idmodel_

template<typename MODEL , typename OBS >
const bool oops::SaddlePointPrecondMatrix< MODEL, OBS >::idmodel_
private

Definition at line 47 of file SaddlePointPrecondMatrix.h.

◆ j_

template<typename MODEL , typename OBS >
const CostFctWeak_& oops::SaddlePointPrecondMatrix< MODEL, OBS >::j_
private

Definition at line 46 of file SaddlePointPrecondMatrix.h.

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