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

IPCG Minimizer. More...

#include <IPCGMinimizer.h>

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

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

Public Member Functions
const std::string	classname () const override
	IPCGMinimizer (const eckit::Configuration &, const CostFct_ &J)
	~IPCGMinimizer ()
Public Member Functions inherited from oops::PrimalMinimizer< MODEL, OBS >
	PrimalMinimizer (const CostFct_ &J)
	~PrimalMinimizer ()
Public Member Functions inherited from oops::Minimizer< MODEL, OBS >
	Minimizer (const CostFct_ &J)
virtual	~Minimizer ()
ControlIncrement< MODEL, OBS > *	minimize (const eckit::Configuration &)

Private Types
typedef BMatrix< MODEL, OBS >	Bmat_
typedef CostFunction< MODEL, OBS >	CostFct_
typedef ControlIncrement< MODEL, OBS >	CtrlInc_
typedef HessianMatrix< MODEL, OBS >	Hessian_

Private Member Functions
double	solve (CtrlInc_ &, const CtrlInc_ &, const Hessian_ &, const Bmat_ &, const int, const double) override

Detailed Description

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

IPCG Minimizer.

Implements the Golub-Ye Inexact-Preconditioned Conjugate Gradients algorithm.

Definition at line 32 of file IPCGMinimizer.h.

Member Typedef Documentation

Bmat_

template<typename MODEL , typename OBS >

typedef BMatrix<MODEL, OBS> oops::IPCGMinimizer< MODEL, OBS >::Bmat_

private

Definition at line 33 of file IPCGMinimizer.h.

CostFct_

template<typename MODEL , typename OBS >

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

private

Definition at line 34 of file IPCGMinimizer.h.

CtrlInc_

template<typename MODEL , typename OBS >

typedef ControlIncrement<MODEL, OBS> oops::IPCGMinimizer< MODEL, OBS >::CtrlInc_

private

Definition at line 35 of file IPCGMinimizer.h.

Hessian_

template<typename MODEL , typename OBS >

typedef HessianMatrix<MODEL, OBS> oops::IPCGMinimizer< MODEL, OBS >::Hessian_

private

Definition at line 36 of file IPCGMinimizer.h.

Constructor & Destructor Documentation

IPCGMinimizer()

template<typename MODEL , typename OBS >

oops::IPCGMinimizer< MODEL, OBS >::IPCGMinimizer ( const eckit::Configuration &  , const CostFct_ &  J  )

inline

Definition at line 40 of file IPCGMinimizer.h.

~IPCGMinimizer()

template<typename MODEL , typename OBS >

oops::IPCGMinimizer< MODEL, OBS >::~IPCGMinimizer ( )

inline

Definition at line 41 of file IPCGMinimizer.h.

Member Function Documentation

classname()

template<typename MODEL , typename OBS >

const std::string oops::IPCGMinimizer< MODEL, OBS >::classname ( ) const

inlineoverridevirtual

Implements oops::PrimalMinimizer< MODEL, OBS >.

Definition at line 39 of file IPCGMinimizer.h.

solve()

template<typename MODEL , typename OBS >

double oops::IPCGMinimizer< MODEL, OBS >::solve ( CtrlInc_ &  dx, const CtrlInc_ &  rhs, const Hessian_ &  hessian, const Bmat_ &  B, const int  ninner, const double  gnreduc  )

overrideprivatevirtual

Implements oops::PrimalMinimizer< MODEL, OBS >.

Definition at line 52 of file IPCGMinimizer.h.

Here is the call graph for this function:

---

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

• IPCGMinimizer.h