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

The Hessian matrix: \( I + B H^T R^{-1} H \). More...

#include <LBHessianMatrix.h>

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

Public Member Functions

 LBHessianMatrix (const CostFct_ &j)
 
void multiply (const CtrlInc_ &dx, CtrlInc_ &dz) const
 

Private Types

typedef Increment< MODEL > Increment_
 
typedef ControlIncrement< MODEL > CtrlInc_
 
typedef CostFunction< MODEL > CostFct_
 
typedef JqTermTLAD< MODEL > JqTermTLAD_
 

Private Attributes

CostFct_ const & j_
 

Detailed Description

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

The Hessian matrix: \( I + B H^T R^{-1} H \).

The solvers represent matrices as objects that implement a "multiply" method. This class defines objects that apply a generalized Hessian matrix which includes all the terms of the cost function.

Definition at line 32 of file LBHessianMatrix.h.

Member Typedef Documentation

◆ CostFct_

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

Definition at line 35 of file LBHessianMatrix.h.

◆ CtrlInc_

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

Definition at line 34 of file LBHessianMatrix.h.

◆ Increment_

template<typename MODEL >
typedef Increment<MODEL> oops::LBHessianMatrix< MODEL >::Increment_
private

Definition at line 33 of file LBHessianMatrix.h.

◆ JqTermTLAD_

template<typename MODEL >
typedef JqTermTLAD<MODEL> oops::LBHessianMatrix< MODEL >::JqTermTLAD_
private

Definition at line 36 of file LBHessianMatrix.h.

Constructor & Destructor Documentation

◆ LBHessianMatrix()

template<typename MODEL >
oops::LBHessianMatrix< MODEL >::LBHessianMatrix ( const CostFct_ j)
inlineexplicit

Definition at line 39 of file LBHessianMatrix.h.

Member Function Documentation

◆ multiply()

template<typename MODEL >
void oops::LBHessianMatrix< MODEL >::multiply ( const CtrlInc_ dx,
CtrlInc_ dz 
) const
inline

Definition at line 41 of file LBHessianMatrix.h.

Here is the call graph for this function:

Member Data Documentation

◆ j_

template<typename MODEL >
CostFct_ const& oops::LBHessianMatrix< MODEL >::j_
private

Definition at line 90 of file LBHessianMatrix.h.


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