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

The \( B \) matrix. More...

#include <BMatrix.h>

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

Public Member Functions

 BMatrix (const CostFct_ &j)
 
void multiply (const CtrlInc_ &x, CtrlInc_ &bx) const
 

Private Types

typedef ControlIncrement< MODEL > CtrlInc_
 
typedef CostFunction< MODEL > CostFct_
 

Private Attributes

CostFct_ const & j_
 

Detailed Description

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

The \( B \) matrix.

The solvers represent matrices as objects that implement a "multiply" method. This class defines objects that apply the \( B \) matrix.

Definition at line 27 of file BMatrix.h.

Member Typedef Documentation

◆ CostFct_

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

Definition at line 29 of file BMatrix.h.

◆ CtrlInc_

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

Definition at line 28 of file BMatrix.h.

Constructor & Destructor Documentation

◆ BMatrix()

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

Definition at line 32 of file BMatrix.h.

Member Function Documentation

◆ multiply()

template<typename MODEL >
void oops::BMatrix< MODEL >::multiply ( const CtrlInc_ x,
CtrlInc_ bx 
) const
inline

Definition at line 33 of file BMatrix.h.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ j_

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

Definition at line 38 of file BMatrix.h.


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