oops::DRPFOMMinimizer< MODEL > Class Template Reference

DRPFOM Minimizer. More...

#include <DRPFOMMinimizer.h>

Inheritance diagram for oops::DRPFOMMinimizer< MODEL >:

Collaboration diagram for oops::DRPFOMMinimizer< MODEL >:

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

Private Types
typedef BMatrix< MODEL >	Bmat_
typedef CostFunction< MODEL >	CostFct_
typedef ControlIncrement< MODEL >	CtrlInc_
typedef HtRinvHMatrix< MODEL >	HtRinvH_

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

Private Attributes
SpectralLMP< CtrlInc_ >	lmp_
boost::ptr_vector< CtrlInc_ >	hvecs_
boost::ptr_vector< CtrlInc_ >	vvecs_
boost::ptr_vector< CtrlInc_ >	zvecs_
std::vector< double >	alphas_
std::vector< double >	betas_

Detailed Description

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

DRPFOM Minimizer.

Preconditioned Full Orthogonal Method (FOM) solver.

This solver is the generalization of the Lanczos method to the unsymmetric case. It solves \( Ax=b\) for the particular case \( A=B^{-1}+C\), without requiring the application of \( B^{-1}\).

On entry:

• dx = starting point.
• dxh = starting point, \( B^{-1} dx_{0}\).
• rr = residual at starting point.
• B = \( B \).
• C = \( C \).
• precond = preconditioner \( F_k \approx (AB)^{-1} \).

On exit, dxh will contain \( B^{-1} x\) where x is the solution. The return value is the achieved reduction in residual norm.

Iteration will stop if the maximum iteration limit "maxiter" is reached or if the residual norm reduces by a factor of "tolerance".

Each matrix must implement a method:

• void multiply(const VECTOR&, VECTOR&) const

which applies the matrix to the first argument, and returns the matrix-vector product in the second. (Note: the const is optional, but recommended.)

Definition at line 67 of file DRPFOMMinimizer.h.

Member Typedef Documentation

Bmat_

template<typename MODEL >

typedef BMatrix<MODEL> oops::DRPFOMMinimizer< MODEL >::Bmat_

private

Definition at line 68 of file DRPFOMMinimizer.h.

CostFct_

template<typename MODEL >

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

private

Definition at line 69 of file DRPFOMMinimizer.h.

CtrlInc_

template<typename MODEL >

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

private

Definition at line 70 of file DRPFOMMinimizer.h.

HtRinvH_

template<typename MODEL >

typedef HtRinvHMatrix<MODEL> oops::DRPFOMMinimizer< MODEL >::HtRinvH_

private

Definition at line 71 of file DRPFOMMinimizer.h.

Constructor & Destructor Documentation

DRPFOMMinimizer()

template<typename MODEL >

oops::DRPFOMMinimizer< MODEL >::DRPFOMMinimizer	(	const eckit::Configuration &	conf,
		const CostFct_ &	J
	)

Definition at line 95 of file DRPFOMMinimizer.h.

~DRPFOMMinimizer()

template<typename MODEL >

oops::DRPFOMMinimizer< MODEL >::~DRPFOMMinimizer ( )

inline

Definition at line 76 of file DRPFOMMinimizer.h.

Member Function Documentation

classname()

template<typename MODEL >

const std::string oops::DRPFOMMinimizer< MODEL >::classname ( ) const

inlineoverridevirtual

Implements oops::DRMinimizer< MODEL >.

Definition at line 74 of file DRPFOMMinimizer.h.

solve()

template<typename MODEL >

double oops::DRPFOMMinimizer< MODEL >::solve ( CtrlInc_ &  dx, CtrlInc_ &  dxh, CtrlInc_ &  rr, const Bmat_ &  B, const HtRinvH_ &  HtRinvH, const double  costJ0Jb, const double  costJ0JoJc, const int  maxiter, const double  tolerance  )

overrideprivatevirtual

Implements oops::DRMinimizer< MODEL >.

Definition at line 103 of file DRPFOMMinimizer.h.

Here is the call graph for this function:

Member Data Documentation

alphas_

template<typename MODEL >

std::vector<double> oops::DRPFOMMinimizer< MODEL >::alphas_

private

Definition at line 88 of file DRPFOMMinimizer.h.

betas_

template<typename MODEL >

std::vector<double> oops::DRPFOMMinimizer< MODEL >::betas_

private

Definition at line 89 of file DRPFOMMinimizer.h.

hvecs_

template<typename MODEL >

boost::ptr_vector<CtrlInc_> oops::DRPFOMMinimizer< MODEL >::hvecs_

private

Definition at line 85 of file DRPFOMMinimizer.h.

lmp_

template<typename MODEL >

SpectralLMP<CtrlInc_> oops::DRPFOMMinimizer< MODEL >::lmp_

private

Definition at line 82 of file DRPFOMMinimizer.h.

vvecs_

template<typename MODEL >

boost::ptr_vector<CtrlInc_> oops::DRPFOMMinimizer< MODEL >::vvecs_

private

Definition at line 86 of file DRPFOMMinimizer.h.

zvecs_

template<typename MODEL >

boost::ptr_vector<CtrlInc_> oops::DRPFOMMinimizer< MODEL >::zvecs_

private

Definition at line 87 of file DRPFOMMinimizer.h.

---

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

• DRPFOMMinimizer.h