oops::HtRinvHMatrix< MODEL > Class Template Reference

The \( H^T R^{-1} H \) matrix. More...

#include <HtRinvHMatrix.h>

Inheritance diagram for oops::HtRinvHMatrix< MODEL >:

Collaboration diagram for oops::HtRinvHMatrix< MODEL >:

Public Member Functions
	HtRinvHMatrix (const CostFct_ &j, const bool test=false)
void	multiply (const CtrlInc_ &dx, CtrlInc_ &dz) const

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

Private Attributes
CostFct_ const &	j_
bool	test_
int	iter_

Detailed Description

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

The \( H^T R^{-1} H \) matrix.

The solvers represent matrices as objects that implement a "multiply" method. This class defines objects that apply a generalized \( H^T R^{-1} H \) matrix that also includes the equivalent operators for the other terms of the cost function.

Definition at line 38 of file HtRinvHMatrix.h.

Member Typedef Documentation

CostFct_

template<typename MODEL >

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

private

Definition at line 41 of file HtRinvHMatrix.h.

CtrlInc_

template<typename MODEL >

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

private

Definition at line 40 of file HtRinvHMatrix.h.

Increment_

template<typename MODEL >

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

private

Definition at line 39 of file HtRinvHMatrix.h.

Constructor & Destructor Documentation

HtRinvHMatrix()

template<typename MODEL >

oops::HtRinvHMatrix< MODEL >::HtRinvHMatrix ( const CostFct_ &  j, const bool  test = false  )

explicit

Definition at line 57 of file HtRinvHMatrix.h.

Member Function Documentation

multiply()

template<typename MODEL >

void oops::HtRinvHMatrix< MODEL >::multiply	(	const CtrlInc_ &	dx,
		CtrlInc_ &	dz
	)		const

Definition at line 64 of file HtRinvHMatrix.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

iter_

template<typename MODEL >

int oops::HtRinvHMatrix< MODEL >::iter_

mutableprivate

Definition at line 51 of file HtRinvHMatrix.h.

j_

template<typename MODEL >

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

private

Definition at line 49 of file HtRinvHMatrix.h.

test_

template<typename MODEL >

bool oops::HtRinvHMatrix< MODEL >::test_

private

Definition at line 50 of file HtRinvHMatrix.h.

---

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

• HtRinvHMatrix.h