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

Primal Minimizer. More...

#include <PrimalMinimizer.h>

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

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

Public Member Functions
	PrimalMinimizer (const CostFct_ &J)
	~PrimalMinimizer ()
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 HessianMatrix< MODEL, OBS >	Hessian_
typedef Minimizer< MODEL, OBS >	Minimizer_
typedef RinvHMatrix< MODEL, OBS >	RinvH_

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

Private Attributes
const CostFct_ &	J_

Detailed Description

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

Primal Minimizer.

PrimalMinimizer is the base class for all minimizers that minimize the variational data assimilation cost function in primal (model) space.

Definition at line 39 of file PrimalMinimizer.h.

Member Typedef Documentation

Bmat_

template<typename MODEL , typename OBS >

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

private

Definition at line 42 of file PrimalMinimizer.h.

CostFct_

template<typename MODEL , typename OBS >

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

private

Definition at line 40 of file PrimalMinimizer.h.

CtrlInc_

template<typename MODEL , typename OBS >

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

private

Definition at line 41 of file PrimalMinimizer.h.

Hessian_

template<typename MODEL , typename OBS >

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

private

Definition at line 43 of file PrimalMinimizer.h.

Minimizer_

template<typename MODEL , typename OBS >

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

private

Definition at line 44 of file PrimalMinimizer.h.

RinvH_

template<typename MODEL , typename OBS >

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

private

Definition at line 45 of file PrimalMinimizer.h.

Constructor & Destructor Documentation

PrimalMinimizer()

template<typename MODEL , typename OBS >

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

inlineexplicit

Definition at line 48 of file PrimalMinimizer.h.

~PrimalMinimizer()

template<typename MODEL , typename OBS >

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

inline

Definition at line 49 of file PrimalMinimizer.h.

Member Function Documentation

classname()

template<typename MODEL , typename OBS >

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

overridepure virtual

Implements oops::Minimizer< MODEL, OBS >.

Implemented in oops::PLanczosMinimizer< MODEL, OBS >, oops::PCGMinimizer< MODEL, OBS >, oops::MINRESMinimizer< MODEL, OBS >, oops::IPCGMinimizer< MODEL, OBS >, oops::GMRESRMinimizer< MODEL, OBS >, and oops::FGMRESMinimizer< MODEL, OBS >.

doMinimize()

template<typename MODEL , typename OBS >

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

overrideprivatevirtual

Implements oops::Minimizer< MODEL, OBS >.

Definition at line 65 of file PrimalMinimizer.h.

Here is the call graph for this function:

solve()

template<typename MODEL , typename OBS >

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

privatepure virtual

Implemented in oops::PLanczosMinimizer< MODEL, OBS >, oops::PCGMinimizer< MODEL, OBS >, oops::MINRESMinimizer< MODEL, OBS >, oops::IPCGMinimizer< MODEL, OBS >, oops::GMRESRMinimizer< MODEL, OBS >, and oops::FGMRESMinimizer< MODEL, OBS >.

Member Data Documentation

J_

template<typename MODEL , typename OBS >

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

private

Definition at line 58 of file PrimalMinimizer.h.

---

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

• PrimalMinimizer.h