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

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

#include <HtMatrix.h>

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

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

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

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

Private Attributes
CostFct_ const &	j_

Detailed Description

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

The \( H^T \) matrix.

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

Definition at line 33 of file HtMatrix.h.

Member Typedef Documentation

CostFct_

template<typename MODEL , typename OBS >

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

private

Definition at line 34 of file HtMatrix.h.

Increment_

template<typename MODEL , typename OBS >

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

private

Definition at line 35 of file HtMatrix.h.

Constructor & Destructor Documentation

HtMatrix()

template<typename MODEL , typename OBS >

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

inlineexplicit

Definition at line 38 of file HtMatrix.h.

Member Function Documentation

multiply()

template<typename MODEL , typename OBS >

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

inline

Definition at line 40 of file HtMatrix.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::HtMatrix< MODEL, OBS >::j_

private

Definition at line 55 of file HtMatrix.h.

---

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

• HtMatrix.h