oops::HMatrix< MODEL, OBS > Class Template Reference

The \( H \) matrix. More...

#include <HMatrix.h>

Inheritance diagram for oops::HMatrix< MODEL, OBS >:

Collaboration diagram for oops::HMatrix< MODEL, OBS >:

Public Member Functions
	HMatrix (const CostFct_ &j)
void	multiply (CtrlInc_ &dx, DualVector< MODEL, OBS > &dy, const bool idModel=false) const

Private Types
typedef Increment< MODEL >	Increment_
typedef ControlIncrement< MODEL, OBS >	CtrlInc_
typedef CostFunction< MODEL, OBS >	CostFct_

Private Attributes
CostFct_ const &	j_

Detailed Description

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

The \( H \) matrix.

The solvers represent matrices as objects that implement a "multiply" method. This class defines objects that apply a generalized \( H \) matrix which includes \( H \) itself and the equivalent operators for the other terms of the cost function.

Definition at line 36 of file HMatrix.h.

Member Typedef Documentation

CostFct_

template<typename MODEL , typename OBS >

typedef CostFunction<MODEL, OBS> oops::HMatrix< MODEL, OBS >::CostFct_

private

Definition at line 39 of file HMatrix.h.

CtrlInc_

template<typename MODEL , typename OBS >

typedef ControlIncrement<MODEL, OBS> oops::HMatrix< MODEL, OBS >::CtrlInc_

private

Definition at line 38 of file HMatrix.h.

Increment_

template<typename MODEL , typename OBS >

typedef Increment<MODEL> oops::HMatrix< MODEL, OBS >::Increment_

private

Definition at line 37 of file HMatrix.h.

Constructor & Destructor Documentation

HMatrix()

template<typename MODEL , typename OBS >

oops::HMatrix< MODEL, OBS >::HMatrix ( const CostFct_ &  j )

inlineexplicit

Definition at line 42 of file HMatrix.h.

Member Function Documentation

multiply()

template<typename MODEL , typename OBS >

void oops::HMatrix< MODEL, OBS >::multiply ( CtrlInc_ &  dx, DualVector< MODEL, OBS > &  dy, const bool  idModel = false  ) const

inline

Definition at line 44 of file HMatrix.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

j_

template<typename MODEL , typename OBS >

CostFct_ const& oops::HMatrix< MODEL, OBS >::j_

private

Definition at line 63 of file HMatrix.h.

---

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

• HMatrix.h