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

A Minimizer knows how to minimize a cost function. More...

#include <Minimizer.h>

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

Public Member Functions

 Minimizer (const CostFct_ &J)
 
virtual ~Minimizer ()
 
ControlIncrement< MODEL, OBS > * minimize (const eckit::Configuration &)
 
virtual const std::string classname () const =0
 

Private Types

typedef CostFunction< MODEL, OBS > CostFct_
 
typedef ControlIncrement< MODEL, OBS > CtrlInc_
 
typedef DualVector< MODEL, OBS > Dual_
 
typedef HMatrix< MODEL, OBS > H_
 
typedef HtMatrix< MODEL, OBS > Ht_
 
typedef State< MODEL > State_
 

Private Member Functions

virtual ControlIncrement< MODEL, OBS > * doMinimize (const eckit::Configuration &)=0
 
void adjTests (const eckit::Configuration &)
 
void adjModelTest (const Ht_ &, const H_ &)
 
void adjObsTest (const Ht_ &, const H_ &)
 
void tlmTests (const eckit::Configuration &)
 
void tlmApproxTest (const H_ &)
 
void tlmTaylorTest (const H_ &)
 
void tlmPropagTest (const eckit::Configuration &config, const CtrlInc_ &)
 

Private Attributes

const CostFct_ & J_
 
int outerIteration_
 

Detailed Description

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

A Minimizer knows how to minimize a cost function.

Definition at line 37 of file Minimizer.h.

Member Typedef Documentation

◆ CostFct_

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

Definition at line 38 of file Minimizer.h.

◆ CtrlInc_

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

Definition at line 39 of file Minimizer.h.

◆ Dual_

template<typename MODEL , typename OBS >
typedef DualVector<MODEL, OBS> oops::Minimizer< MODEL, OBS >::Dual_
private

Definition at line 40 of file Minimizer.h.

◆ H_

template<typename MODEL , typename OBS >
typedef HMatrix<MODEL, OBS> oops::Minimizer< MODEL, OBS >::H_
private

Definition at line 41 of file Minimizer.h.

◆ Ht_

template<typename MODEL , typename OBS >
typedef HtMatrix<MODEL, OBS> oops::Minimizer< MODEL, OBS >::Ht_
private

Definition at line 42 of file Minimizer.h.

◆ State_

template<typename MODEL , typename OBS >
typedef State<MODEL> oops::Minimizer< MODEL, OBS >::State_
private

Definition at line 43 of file Minimizer.h.

Constructor & Destructor Documentation

◆ Minimizer()

template<typename MODEL , typename OBS >
oops::Minimizer< MODEL, OBS >::Minimizer ( const CostFct_ &  J)
inlineexplicit

Definition at line 46 of file Minimizer.h.

◆ ~Minimizer()

template<typename MODEL , typename OBS >
virtual oops::Minimizer< MODEL, OBS >::~Minimizer ( )
inlinevirtual

Definition at line 47 of file Minimizer.h.

Member Function Documentation

◆ adjModelTest()

template<typename MODEL , typename OBS >
void oops::Minimizer< MODEL, OBS >::adjModelTest ( const Ht_ &  Ht,
const H_ &  H 
)
private

Definition at line 278 of file Minimizer.h.

Here is the call graph for this function:

◆ adjObsTest()

template<typename MODEL , typename OBS >
void oops::Minimizer< MODEL, OBS >::adjObsTest ( const Ht_ &  Ht,
const H_ &  H 
)
private

Definition at line 326 of file Minimizer.h.

Here is the call graph for this function:

◆ adjTests()

template<typename MODEL , typename OBS >
void oops::Minimizer< MODEL, OBS >::adjTests ( const eckit::Configuration &  config)
private

Definition at line 120 of file Minimizer.h.

◆ classname()

template<typename MODEL , typename OBS >
virtual const std::string oops::Minimizer< MODEL, OBS >::classname ( ) const
pure virtual

Implemented in oops::PrimalMinimizer< MODEL, OBS >, oops::LBMinimizer< MODEL, OBS >, oops::DualMinimizer< MODEL, OBS >, oops::DRMinimizer< MODEL, OBS >, oops::SaddlePointMinimizer< MODEL, OBS >, oops::RPLanczosMinimizer< MODEL, OBS >, oops::RPCGMinimizer< MODEL, OBS >, oops::PLanczosMinimizer< MODEL, OBS >, oops::PCGMinimizer< MODEL, OBS >, oops::MINRESMinimizer< MODEL, OBS >, oops::LBGMRESRMinimizer< MODEL, OBS >, oops::IPCGMinimizer< MODEL, OBS >, oops::GMRESRMinimizer< MODEL, OBS >, oops::FGMRESMinimizer< MODEL, OBS >, oops::DRPLanczosMinimizer< MODEL, OBS >, oops::DRPFOMMinimizer< MODEL, OBS >, oops::DRPCGMinimizer< MODEL, OBS >, oops::DRPBlockLanczosMinimizer< MODEL, OBS >, oops::DRIPCGMinimizer< MODEL, OBS >, and oops::DRGMRESRMinimizer< MODEL, OBS >.

◆ doMinimize()

template<typename MODEL , typename OBS >
virtual ControlIncrement<MODEL, OBS>* oops::Minimizer< MODEL, OBS >::doMinimize ( const eckit::Configuration &  )
privatepure virtual

Implemented in oops::SaddlePointMinimizer< MODEL, OBS >, oops::PrimalMinimizer< MODEL, OBS >, oops::LBMinimizer< MODEL, OBS >, oops::DualMinimizer< MODEL, OBS >, and oops::DRMinimizer< MODEL, OBS >.

◆ minimize()

template<typename MODEL , typename OBS >
ControlIncrement< MODEL, OBS > * oops::Minimizer< MODEL, OBS >::minimize ( const eckit::Configuration &  config)

Definition at line 72 of file Minimizer.h.

Here is the call graph for this function:

◆ tlmApproxTest()

template<typename MODEL , typename OBS >
void oops::Minimizer< MODEL, OBS >::tlmApproxTest ( const H_ &  H)
private

Definition at line 143 of file Minimizer.h.

Here is the call graph for this function:

◆ tlmPropagTest()

template<typename MODEL , typename OBS >
void oops::Minimizer< MODEL, OBS >::tlmPropagTest ( const eckit::Configuration &  config,
const CtrlInc_ &  dx 
)
private

Definition at line 184 of file Minimizer.h.

Here is the call graph for this function:

◆ tlmTaylorTest()

template<typename MODEL , typename OBS >
void oops::Minimizer< MODEL, OBS >::tlmTaylorTest ( const H_ &  H)
private

Definition at line 220 of file Minimizer.h.

Here is the call graph for this function:

◆ tlmTests()

template<typename MODEL , typename OBS >
void oops::Minimizer< MODEL, OBS >::tlmTests ( const eckit::Configuration &  config)
private

Definition at line 97 of file Minimizer.h.

Member Data Documentation

◆ J_

template<typename MODEL , typename OBS >
const CostFct_& oops::Minimizer< MODEL, OBS >::J_
private

Definition at line 64 of file Minimizer.h.

◆ outerIteration_

template<typename MODEL , typename OBS >
int oops::Minimizer< MODEL, OBS >::outerIteration_
private

Definition at line 65 of file Minimizer.h.

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