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

Dual Minimizer. More...

#include <DualMinimizer.h>

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

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

Public Member Functions
	DualMinimizer (const CostFct_ &J)
	~DualMinimizer ()
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 ControlIncrement< MODEL, OBS >	CtrlInc_
typedef CostFunction< MODEL, OBS >	CostFct_
typedef BMatrix< MODEL, OBS >	Bmat_
typedef DualVector< MODEL, OBS >	Dual_
typedef HBHtMatrix< MODEL, OBS >	HBHt_
typedef Minimizer< MODEL, OBS >	Minimizer_
typedef RinvMatrix< MODEL, OBS >	Rinv_

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

Private Attributes
const CostFct_ &	J_
std::unique_ptr< CtrlInc_ >	gradJb_

Detailed Description

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

Dual Minimizer.

Base class for all dual (observation) space minimizers.

Definition at line 40 of file DualMinimizer.h.

Member Typedef Documentation

Bmat_

template<typename MODEL , typename OBS >

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

private

Definition at line 43 of file DualMinimizer.h.

CostFct_

template<typename MODEL , typename OBS >

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

private

Definition at line 42 of file DualMinimizer.h.

CtrlInc_

template<typename MODEL , typename OBS >

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

private

Definition at line 41 of file DualMinimizer.h.

Dual_

template<typename MODEL , typename OBS >

typedef DualVector<MODEL, OBS> oops::DualMinimizer< MODEL, OBS >::Dual_

private

Definition at line 44 of file DualMinimizer.h.

HBHt_

template<typename MODEL , typename OBS >

typedef HBHtMatrix<MODEL, OBS> oops::DualMinimizer< MODEL, OBS >::HBHt_

private

Definition at line 45 of file DualMinimizer.h.

Minimizer_

template<typename MODEL , typename OBS >

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

private

Definition at line 46 of file DualMinimizer.h.

Rinv_

template<typename MODEL , typename OBS >

typedef RinvMatrix<MODEL, OBS> oops::DualMinimizer< MODEL, OBS >::Rinv_

private

Definition at line 47 of file DualMinimizer.h.

Constructor & Destructor Documentation

DualMinimizer()

template<typename MODEL , typename OBS >

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

inlineexplicit

Definition at line 50 of file DualMinimizer.h.

~DualMinimizer()

template<typename MODEL , typename OBS >

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

inline

Definition at line 51 of file DualMinimizer.h.

Member Function Documentation

classname()

template<typename MODEL , typename OBS >

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

overridepure virtual

Implements oops::Minimizer< MODEL, OBS >.

Implemented in oops::RPLanczosMinimizer< MODEL, OBS >, and oops::RPCGMinimizer< MODEL, OBS >.

doMinimize()

template<typename MODEL , typename OBS >

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

overrideprivatevirtual

Implements oops::Minimizer< MODEL, OBS >.

Definition at line 67 of file DualMinimizer.h.

Here is the call graph for this function:

solve()

template<typename MODEL , typename OBS >

virtual double oops::DualMinimizer< MODEL, OBS >::solve ( Dual_ &  , double &  , Dual_ &  , const HBHt_ &  , const Rinv_ &  , const int &  , const double &  , Dual_ &  , const double &    )

privatepure virtual

Implemented in oops::RPLanczosMinimizer< MODEL, OBS >, and oops::RPCGMinimizer< MODEL, OBS >.

Member Data Documentation

gradJb_

template<typename MODEL , typename OBS >

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

private

Definition at line 60 of file DualMinimizer.h.

J_

template<typename MODEL , typename OBS >

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

private

Definition at line 59 of file DualMinimizer.h.

---

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

• DualMinimizer.h