OOPS
Public Member Functions | Private Types | Private Member Functions | List of all members
oops::PCGMinimizer< MODEL, OBS > Class Template Reference

PCG Minimizer. More...

#include <PCGMinimizer.h>

Inheritance diagram for oops::PCGMinimizer< MODEL, OBS >:
Inheritance graph
[legend]
Collaboration diagram for oops::PCGMinimizer< MODEL, OBS >:
Collaboration graph
[legend]

Public Member Functions

const std::string classname () const override
 
 PCGMinimizer (const eckit::Configuration &, const CostFct_ &J)
 
 ~PCGMinimizer ()
 
- Public Member Functions inherited from oops::PrimalMinimizer< MODEL, OBS >
 PrimalMinimizer (const CostFct_ &J)
 
 ~PrimalMinimizer ()
 
- 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 HessianMatrix< MODEL, OBS > Hessian_
 

Private Member Functions

double solve (CtrlInc_ &, const CtrlInc_ &, const Hessian_ &, const Bmat_ &, const int, const double) override
 

Detailed Description

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

PCG Minimizer.

Implements the standard Preconditioned Conjugate Gradients algorithm.

Definition at line 32 of file PCGMinimizer.h.

Member Typedef Documentation

◆ Bmat_

template<typename MODEL , typename OBS >
typedef BMatrix<MODEL, OBS> oops::PCGMinimizer< MODEL, OBS >::Bmat_
private

Definition at line 33 of file PCGMinimizer.h.

◆ CostFct_

template<typename MODEL , typename OBS >
typedef CostFunction<MODEL, OBS> oops::PCGMinimizer< MODEL, OBS >::CostFct_
private

Definition at line 34 of file PCGMinimizer.h.

◆ CtrlInc_

template<typename MODEL , typename OBS >
typedef ControlIncrement<MODEL, OBS> oops::PCGMinimizer< MODEL, OBS >::CtrlInc_
private

Definition at line 35 of file PCGMinimizer.h.

◆ Hessian_

template<typename MODEL , typename OBS >
typedef HessianMatrix<MODEL, OBS> oops::PCGMinimizer< MODEL, OBS >::Hessian_
private

Definition at line 36 of file PCGMinimizer.h.

Constructor & Destructor Documentation

◆ PCGMinimizer()

template<typename MODEL , typename OBS >
oops::PCGMinimizer< MODEL, OBS >::PCGMinimizer ( const eckit::Configuration &  ,
const CostFct_ &  J 
)
inline

Definition at line 40 of file PCGMinimizer.h.

◆ ~PCGMinimizer()

template<typename MODEL , typename OBS >
oops::PCGMinimizer< MODEL, OBS >::~PCGMinimizer ( )
inline

Definition at line 41 of file PCGMinimizer.h.

Member Function Documentation

◆ classname()

template<typename MODEL , typename OBS >
const std::string oops::PCGMinimizer< MODEL, OBS >::classname ( ) const
inlineoverridevirtual

Implements oops::PrimalMinimizer< MODEL, OBS >.

Definition at line 39 of file PCGMinimizer.h.

◆ solve()

template<typename MODEL , typename OBS >
double oops::PCGMinimizer< MODEL, OBS >::solve ( CtrlInc_ &  dx,
const CtrlInc_ &  rhs,
const Hessian_ &  hessian,
const Bmat_ &  B,
const int  ninner,
const double  gnreduc 
)
overrideprivatevirtual

Implements oops::PrimalMinimizer< MODEL, OBS >.

Definition at line 52 of file PCGMinimizer.h.

Here is the call graph for this function:
The documentation for this class was generated from the following file: