oops::HMatrix< MODEL > Class Template Reference

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

#include <HMatrix.h>

Inheritance diagram for oops::HMatrix< MODEL >:

Collaboration diagram for oops::HMatrix< MODEL >:

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

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

Private Attributes
CostFct_ const &	j_

Detailed Description

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

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 33 of file HMatrix.h.

Member Typedef Documentation

CostFct_

template<typename MODEL>

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

private

Definition at line 36 of file HMatrix.h.

CtrlInc_

template<typename MODEL>

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

private

Definition at line 35 of file HMatrix.h.

Increment_

template<typename MODEL>

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

private

Definition at line 34 of file HMatrix.h.

Constructor & Destructor Documentation

HMatrix()

template<typename MODEL>

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

inlineexplicit

Definition at line 39 of file HMatrix.h.

Member Function Documentation

multiply()

template<typename MODEL>

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

inline

Definition at line 41 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>

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

private

Definition at line 59 of file HMatrix.h.

---

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

• HMatrix.h