oops::RinvMatrix< MODEL > Class Template Reference

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

#include <RinvMatrix.h>

Inheritance diagram for oops::RinvMatrix< MODEL >:

Collaboration diagram for oops::RinvMatrix< MODEL >:

Public Member Functions
	RinvMatrix (const CostFct_ &j)
void	multiply (const Dual_ &dx, Dual_ &dy) const

Private Types
typedef CostFunction< MODEL >	CostFct_
typedef DualVector< MODEL >	Dual_

Private Attributes
CostFct_ const &	j_

Detailed Description

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

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

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

Definition at line 29 of file RinvMatrix.h.

Member Typedef Documentation

CostFct_

template<typename MODEL >

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

private

Definition at line 30 of file RinvMatrix.h.

Dual_

template<typename MODEL >

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

private

Definition at line 31 of file RinvMatrix.h.

Constructor & Destructor Documentation

RinvMatrix()

template<typename MODEL >

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

inlineexplicit

Definition at line 34 of file RinvMatrix.h.

Member Function Documentation

multiply()

template<typename MODEL >

void oops::RinvMatrix< MODEL >::multiply ( const Dual_ &  dx, Dual_ &  dy  ) const

inline

Definition at line 36 of file RinvMatrix.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::RinvMatrix< MODEL >::j_

private

Definition at line 44 of file RinvMatrix.h.

---

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

• RinvMatrix.h