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

SaddlePoint Minimizer. More...

#include <SaddlePointMinimizer.h>

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

Public Member Functions

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

Private Types

typedef ControlIncrement< MODEL > CtrlInc_
 
typedef CostFunction< MODEL > CostFct_
 
typedef Minimizer< MODEL > Minimizer_
 
typedef DualVector< MODEL > Multipliers_
 

Private Member Functions

CtrlInc_doMinimize (const eckit::Configuration &) override
 

Private Attributes

const CostFct_J_
 
boost::scoped_ptr< CtrlInc_gradJb_
 
std::vector< SaddlePointVector< MODEL > > xyVEC_
 
std::vector< SaddlePointVector< MODEL > > pqVEC_
 

Detailed Description

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

SaddlePoint Minimizer.

Implements the SaddlePoint algorithm.

Definition at line 43 of file SaddlePointMinimizer.h.

Member Typedef Documentation

◆ CostFct_

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

Definition at line 45 of file SaddlePointMinimizer.h.

◆ CtrlInc_

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

Definition at line 44 of file SaddlePointMinimizer.h.

◆ Minimizer_

template<typename MODEL >
typedef Minimizer<MODEL> oops::SaddlePointMinimizer< MODEL >::Minimizer_
private

Definition at line 46 of file SaddlePointMinimizer.h.

◆ Multipliers_

template<typename MODEL >
typedef DualVector<MODEL> oops::SaddlePointMinimizer< MODEL >::Multipliers_
private

Definition at line 47 of file SaddlePointMinimizer.h.

Constructor & Destructor Documentation

◆ SaddlePointMinimizer()

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

Definition at line 52 of file SaddlePointMinimizer.h.

◆ ~SaddlePointMinimizer()

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

Definition at line 54 of file SaddlePointMinimizer.h.

Member Function Documentation

◆ classname()

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

Implements oops::Minimizer< MODEL >.

Definition at line 51 of file SaddlePointMinimizer.h.

◆ doMinimize()

template<typename MODEL >
ControlIncrement< MODEL > * oops::SaddlePointMinimizer< MODEL >::doMinimize ( const eckit::Configuration &  config)
overrideprivatevirtual

Implements oops::Minimizer< MODEL >.

Definition at line 70 of file SaddlePointMinimizer.h.

Here is the call graph for this function:

Member Data Documentation

◆ gradJb_

template<typename MODEL >
boost::scoped_ptr<CtrlInc_> oops::SaddlePointMinimizer< MODEL >::gradJb_
private

Definition at line 60 of file SaddlePointMinimizer.h.

◆ J_

template<typename MODEL >
const CostFct_& oops::SaddlePointMinimizer< MODEL >::J_
private

Definition at line 59 of file SaddlePointMinimizer.h.

◆ pqVEC_

template<typename MODEL >
std::vector< SaddlePointVector<MODEL> > oops::SaddlePointMinimizer< MODEL >::pqVEC_
private

Definition at line 63 of file SaddlePointMinimizer.h.

◆ xyVEC_

template<typename MODEL >
std::vector< SaddlePointVector<MODEL> > oops::SaddlePointMinimizer< MODEL >::xyVEC_
private

Definition at line 62 of file SaddlePointMinimizer.h.


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