oops::HBHtMatrix< MODEL > Class Template Reference

The \( H B H^T \) matrix. More...

#include <HBHtMatrix.h>

Inheritance diagram for oops::HBHtMatrix< MODEL >:

Collaboration diagram for oops::HBHtMatrix< MODEL >:

Public Member Functions
	HBHtMatrix (const CostFct_ &j, const bool test=false)
void	multiply (const Dual_ &dy, Dual_ &dz) const

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

Private Attributes
CostFct_ const &	j_
bool	test_
int	iter_

Detailed Description

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

The \( H B H^T \) matrix.

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

Definition at line 33 of file HBHtMatrix.h.

Member Typedef Documentation

CostFct_

template<typename MODEL >

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

private

Definition at line 36 of file HBHtMatrix.h.

CtrlInc_

template<typename MODEL >

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

private

Definition at line 35 of file HBHtMatrix.h.

Dual_

template<typename MODEL >

typedef DualVector<MODEL> oops::HBHtMatrix< MODEL >::Dual_

private

Definition at line 37 of file HBHtMatrix.h.

Increment_

template<typename MODEL >

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

private

Definition at line 34 of file HBHtMatrix.h.

Constructor & Destructor Documentation

HBHtMatrix()

template<typename MODEL >

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

explicit

Definition at line 54 of file HBHtMatrix.h.

Member Function Documentation

multiply()

template<typename MODEL >

void oops::HBHtMatrix< MODEL >::multiply	(	const Dual_ &	dy,
		Dual_ &	dz
	)		const

Definition at line 62 of file HBHtMatrix.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::HBHtMatrix< MODEL >::iter_

mutableprivate

Definition at line 48 of file HBHtMatrix.h.

j_

template<typename MODEL >

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

private

Definition at line 46 of file HBHtMatrix.h.

test_

template<typename MODEL >

bool oops::HBHtMatrix< MODEL >::test_

private

Definition at line 47 of file HBHtMatrix.h.

---

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

• HBHtMatrix.h