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

DR (Derber and Rosati) Minimizers. More...

#include <DRMinimizer.h>

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

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

Public Member Functions
	DRMinimizer (const CostFct_ &J)
	~DRMinimizer ()
const std::string	classname () const override=0
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 HtRinvHMatrix< MODEL, OBS >	HtRinvH_
typedef Minimizer< MODEL, OBS >	Minimizer_
typedef RinvHMatrix< MODEL, OBS >	RinvH_

Private Member Functions
CtrlInc_ *	doMinimize (const eckit::Configuration &) override
virtual double	solve (CtrlInc_ &, CtrlInc_ &, CtrlInc_ &, const Bmat_ &, const HtRinvH_ &, const double, const double, const int, const double)=0

Private Attributes
const CostFct_ &	J_
std::unique_ptr< CtrlInc_ >	gradJb_
std::vector< CtrlInc_ >	dxh_
double	costJ0Jb_

Detailed Description

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

DR (Derber and Rosati) Minimizers.

DRMinimizer is the base class for all minimizers that use \( B\) to precondition the variational minimisation problem and use the auxiliary variable \( \hat{x}=B^{-1}x\) and to update it in parallel to \( x\) based on Derber and Rosati, 1989, J. Phys. Oceanog. 1333-1347. \( J_b\) is then computed as \( x^T\hat{x}\) eliminating the need for \( B^{-1}\) or \( B^{1/2}\).

Definition at line 46 of file DRMinimizer.h.

Member Typedef Documentation

Bmat_

template<typename MODEL , typename OBS >

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

private

Definition at line 47 of file DRMinimizer.h.

CostFct_

template<typename MODEL , typename OBS >

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

private

Definition at line 48 of file DRMinimizer.h.

CtrlInc_

template<typename MODEL , typename OBS >

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

private

Definition at line 49 of file DRMinimizer.h.

HtRinvH_

template<typename MODEL , typename OBS >

typedef HtRinvHMatrix<MODEL, OBS> oops::DRMinimizer< MODEL, OBS >::HtRinvH_

private

Definition at line 50 of file DRMinimizer.h.

Minimizer_

template<typename MODEL , typename OBS >

typedef Minimizer<MODEL, OBS> oops::DRMinimizer< MODEL, OBS >::Minimizer_

private

Definition at line 51 of file DRMinimizer.h.

RinvH_

template<typename MODEL , typename OBS >

typedef RinvHMatrix<MODEL, OBS> oops::DRMinimizer< MODEL, OBS >::RinvH_

private

Definition at line 52 of file DRMinimizer.h.

Constructor & Destructor Documentation

DRMinimizer()

template<typename MODEL , typename OBS >

oops::DRMinimizer< MODEL, OBS >::DRMinimizer ( const CostFct_ &  J )

inlineexplicit

Definition at line 55 of file DRMinimizer.h.

~DRMinimizer()

template<typename MODEL , typename OBS >

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

inline

Definition at line 56 of file DRMinimizer.h.

Member Function Documentation

classname()

template<typename MODEL , typename OBS >

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

overridepure virtual

Implements oops::Minimizer< MODEL, OBS >.

Implemented in oops::DRPLanczosMinimizer< MODEL, OBS >, oops::DRPFOMMinimizer< MODEL, OBS >, oops::DRPCGMinimizer< MODEL, OBS >, oops::DRPBlockLanczosMinimizer< MODEL, OBS >, oops::DRIPCGMinimizer< MODEL, OBS >, and oops::DRGMRESRMinimizer< MODEL, OBS >.

doMinimize()

template<typename MODEL , typename OBS >

ControlIncrement< MODEL, OBS > * oops::DRMinimizer< MODEL, OBS >::doMinimize ( const eckit::Configuration &  config )

overrideprivatevirtual

Implements oops::Minimizer< MODEL, OBS >.

Definition at line 76 of file DRMinimizer.h.

Here is the call graph for this function:

solve()

template<typename MODEL , typename OBS >

virtual double oops::DRMinimizer< MODEL, OBS >::solve ( CtrlInc_ &  , CtrlInc_ &  , CtrlInc_ &  , const Bmat_ &  , const HtRinvH_ &  , const double  , const double  , const int  , const double    )

privatepure virtual

Implemented in oops::DRPLanczosMinimizer< MODEL, OBS >, oops::DRPFOMMinimizer< MODEL, OBS >, oops::DRPCGMinimizer< MODEL, OBS >, oops::DRPBlockLanczosMinimizer< MODEL, OBS >, oops::DRIPCGMinimizer< MODEL, OBS >, and oops::DRGMRESRMinimizer< MODEL, OBS >.

Member Data Documentation

costJ0Jb_

template<typename MODEL , typename OBS >

double oops::DRMinimizer< MODEL, OBS >::costJ0Jb_

private

Definition at line 69 of file DRMinimizer.h.

dxh_

template<typename MODEL , typename OBS >

std::vector<CtrlInc_> oops::DRMinimizer< MODEL, OBS >::dxh_

private

Definition at line 68 of file DRMinimizer.h.

gradJb_

template<typename MODEL , typename OBS >

std::unique_ptr<CtrlInc_> oops::DRMinimizer< MODEL, OBS >::gradJb_

private

Definition at line 67 of file DRMinimizer.h.

J_

template<typename MODEL , typename OBS >

const CostFct_& oops::DRMinimizer< MODEL, OBS >::J_

private

Definition at line 66 of file DRMinimizer.h.

---

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

• DRMinimizer.h