oops::SaddlePointMatrix< MODEL > Class Template Reference

The Saddle-point matrix. More...

#include <SaddlePointMatrix.h>

Inheritance diagram for oops::SaddlePointMatrix< MODEL >:

Collaboration diagram for oops::SaddlePointMatrix< MODEL >:

Public Member Functions
	SaddlePointMatrix (const CostFct_ &j)
void	multiply (const SPVector_ &, SPVector_ &) const

Private Types
typedef Increment< MODEL >	Increment_
typedef ControlIncrement< MODEL >	CtrlInc_
typedef CostFunction< MODEL >	CostFct_
typedef SaddlePointVector< MODEL >	SPVector_
typedef JqTermTLAD< MODEL >	JqTermTLAD_

Private Attributes
CostFct_ const &	j_

Detailed Description

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

The Saddle-point matrix.

The solvers represent matrices as objects that implement a "multiply" method. This class defines objects that apply the saddle-point matrix.

Definition at line 33 of file SaddlePointMatrix.h.

Member Typedef Documentation

CostFct_

template<typename MODEL>

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

private

Definition at line 36 of file SaddlePointMatrix.h.

CtrlInc_

template<typename MODEL>

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

private

Definition at line 35 of file SaddlePointMatrix.h.

Increment_

template<typename MODEL>

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

private

Definition at line 34 of file SaddlePointMatrix.h.

JqTermTLAD_

template<typename MODEL>

typedef JqTermTLAD<MODEL> oops::SaddlePointMatrix< MODEL >::JqTermTLAD_

private

Definition at line 38 of file SaddlePointMatrix.h.

SPVector_

template<typename MODEL>

typedef SaddlePointVector<MODEL> oops::SaddlePointMatrix< MODEL >::SPVector_

private

Definition at line 37 of file SaddlePointMatrix.h.

Constructor & Destructor Documentation

SaddlePointMatrix()

template<typename MODEL>

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

inlineexplicit

Definition at line 41 of file SaddlePointMatrix.h.

Member Function Documentation

multiply()

template<typename MODEL >

void oops::SaddlePointMatrix< MODEL >::multiply	(	const SPVector_ &	x,
		SPVector_ &	z
	)		const

Definition at line 51 of file SaddlePointMatrix.h.

Here is the call graph for this function:

Member Data Documentation

j_

template<typename MODEL>

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

private

Definition at line 45 of file SaddlePointMatrix.h.

---

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

• SaddlePointMatrix.h