FV3 Bundle
oops::PLanczosMinimizer< MODEL > Class Template Reference

PLanczos Minimizer. More...

#include <PLanczosMinimizer.h>

Inheritance diagram for oops::PLanczosMinimizer< MODEL >:
[legend]
Collaboration diagram for oops::PLanczosMinimizer< MODEL >:
[legend]

Public Member Functions

const std::string classname () const override
 
 PLanczosMinimizer (const eckit::Configuration &, const CostFct_ &J)
 
 ~PLanczosMinimizer ()
 
- Public Member Functions inherited from oops::PrimalMinimizer< MODEL >
 PrimalMinimizer (const CostFct_ &J)
 
 ~PrimalMinimizer ()
 
- Public Member Functions inherited from oops::Minimizer< MODEL >
 Minimizer (const CostFct_ &J)
 
virtual ~Minimizer ()
 
ControlIncrement< MODEL > * minimize (const eckit::Configuration &)
 

Private Types

typedef BMatrix< MODEL > Bmat_
 
typedef CostFunction< MODEL > CostFct_
 
typedef ControlIncrement< MODEL > CtrlInc_
 
typedef HessianMatrix< MODEL > Hessian_
 

Private Member Functions

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

Detailed Description

template<typename MODEL>
class oops::PLanczosMinimizer< MODEL >

PLanczos Minimizer.

Implements the standard Preconditioned Lanczos algorithm for linear systems.

Definition at line 32 of file PLanczosMinimizer.h.

Member Typedef Documentation

◆ Bmat_

template<typename MODEL >
typedef BMatrix<MODEL> oops::PLanczosMinimizer< MODEL >::Bmat_
private

Definition at line 33 of file PLanczosMinimizer.h.

◆ CostFct_

template<typename MODEL >
typedef CostFunction<MODEL> oops::PLanczosMinimizer< MODEL >::CostFct_
private

Definition at line 34 of file PLanczosMinimizer.h.

◆ CtrlInc_

template<typename MODEL >
typedef ControlIncrement<MODEL> oops::PLanczosMinimizer< MODEL >::CtrlInc_
private

Definition at line 35 of file PLanczosMinimizer.h.

◆ Hessian_

template<typename MODEL >
typedef HessianMatrix<MODEL> oops::PLanczosMinimizer< MODEL >::Hessian_
private

Definition at line 36 of file PLanczosMinimizer.h.

Constructor & Destructor Documentation

◆ PLanczosMinimizer()

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

Definition at line 40 of file PLanczosMinimizer.h.

◆ ~PLanczosMinimizer()

template<typename MODEL >
oops::PLanczosMinimizer< MODEL >::~PLanczosMinimizer ( )
inline

Definition at line 42 of file PLanczosMinimizer.h.

Member Function Documentation

◆ classname()

template<typename MODEL >
const std::string oops::PLanczosMinimizer< MODEL >::classname ( ) const
inlineoverridevirtual

Implements oops::PrimalMinimizer< MODEL >.

Definition at line 39 of file PLanczosMinimizer.h.

◆ solve()

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

Implements oops::PrimalMinimizer< MODEL >.

Definition at line 53 of file PLanczosMinimizer.h.

Here is the call graph for this function:

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