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

LB (Left B-preconditioned) Minimizers. More...

#include <LBMinimizer.h>

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

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

Public Member Functions
	LBMinimizer (const CostFct_ &J)
	~LBMinimizer ()
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 CostFunction< MODEL, OBS >	CostFct_
typedef ControlIncrement< MODEL, OBS >	CtrlInc_
typedef BMatrix< MODEL, OBS >	Bmat_
typedef LBHessianMatrix< MODEL, OBS >	LBHessianMatrix_
typedef Minimizer< MODEL, OBS >	Minimizer_

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

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

Detailed Description

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

LB (Left B-preconditioned) Minimizers.

LBMinimizer is the base class for all minimizers that use \( B\) to precondition the variational minimisation problem

NOTE: not suitable for weak constraint state formulation

Definition at line 38 of file LBMinimizer.h.

Member Typedef Documentation

Bmat_

template<typename MODEL , typename OBS >

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

private

Definition at line 41 of file LBMinimizer.h.

CostFct_

template<typename MODEL , typename OBS >

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

private

Definition at line 39 of file LBMinimizer.h.

CtrlInc_

template<typename MODEL , typename OBS >

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

private

Definition at line 40 of file LBMinimizer.h.

LBHessianMatrix_

template<typename MODEL , typename OBS >

typedef LBHessianMatrix<MODEL, OBS> oops::LBMinimizer< MODEL, OBS >::LBHessianMatrix_

private

Definition at line 42 of file LBMinimizer.h.

Minimizer_

template<typename MODEL , typename OBS >

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

private

Definition at line 43 of file LBMinimizer.h.

Constructor & Destructor Documentation

LBMinimizer()

template<typename MODEL , typename OBS >

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

inlineexplicit

Definition at line 46 of file LBMinimizer.h.

~LBMinimizer()

template<typename MODEL , typename OBS >

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

inline

Definition at line 47 of file LBMinimizer.h.

Member Function Documentation

classname()

template<typename MODEL , typename OBS >

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

overridepure virtual

Implements oops::Minimizer< MODEL, OBS >.

Implemented in oops::LBGMRESRMinimizer< MODEL, OBS >.

doMinimize()

template<typename MODEL , typename OBS >

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

overrideprivatevirtual

Implements oops::Minimizer< MODEL, OBS >.

Definition at line 63 of file LBMinimizer.h.

solve()

template<typename MODEL , typename OBS >

virtual void oops::LBMinimizer< MODEL, OBS >::solve ( CtrlInc_ &  , CtrlInc_ &  , const LBHessianMatrix_ &  , const int  , const double    )

privatepure virtual

Implemented in oops::LBGMRESRMinimizer< MODEL, OBS >.

Member Data Documentation

gradJb_

template<typename MODEL , typename OBS >

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

private

Definition at line 56 of file LBMinimizer.h.

J_

template<typename MODEL , typename OBS >

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

private

Definition at line 55 of file LBMinimizer.h.

---

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

• LBMinimizer.h