Loading...
Searching...
No Matches
fvMatrixConstRefWrap< Matrix > Class Template Reference

Expression wrap of const reference to fvMatrix. More...

#include <fvMatrixExpression.H>

Inheritance diagram for fvMatrixConstRefWrap< Matrix >:
Collaboration diagram for fvMatrixConstRefWrap< Matrix >:

Public Types

typedef Matrix this_type
 The fvMatrix type.
typedef Matrix::psiFieldType::value_type value_type
 Type to return for internal field.
typedef ListConstRefWrap< value_typeDiagExpr
 Type to return for containers.
typedef ListConstRefWrap< value_typeUpperExpr
typedef ListConstRefWrap< value_typeLowerExpr
typedef GeometricFieldConstRefWrap< typename Matrix::faceFluxFieldType > FaceFluxExpr
typedef ListConstRefWrap< value_typeSourceExpr

Public Member Functions

 fvMatrixConstRefWrap (const this_type &elems)
DiagExpr diag () const
UpperExpr upper () const
LowerExpr lower () const
SourceExpr source () const
UpperExpr internalCoeffs (const label i) const
UpperExpr boundaryCoeffs (const label i) const
FaceFluxExpr faceFluxCorrection () const
Public Member Functions inherited from fvMatrixExpression< fvMatrixConstRefWrap< Matrix >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, GeometricFieldConstRefWrap< Matrix::faceFluxFieldType >, ListConstRefWrap< Matrix::psiFieldType::value_type > >
 fvMatrixExpression (const bool hasDiag, const bool hasUpper, const bool hasLower, const bool hasFaceFluxCorrection, const dimensionSet &dimensions)
ListConstRefWrap< Matrix::psiFieldType::value_type > diag () const
ListConstRefWrap< Matrix::psiFieldType::value_type > upper () const
ListConstRefWrap< Matrix::psiFieldType::value_type > lower () const
bool hasDiag () const
bool hasUpper () const
bool hasLower () const
bool diagonal () const
bool symmetric () const
bool asymmetric () const
bool hasFaceFluxCorrection () const
ListConstRefWrap< Matrix::psiFieldType::value_type > source ()
ListConstRefWrap< Matrix::psiFieldType::value_type > internalCoeffs (const label i)
ListConstRefWrap< Matrix::psiFieldType::value_type > boundaryCoeffs (const label i)
GeometricFieldConstRefWrap< Matrix::faceFluxFieldType > faceFluxCorrection () const
const dimensionSetdimensions () const noexcept
Matrixevaluate (Matrix &m) const
 Helper to evaluate (=construct) an fvMatrix.

Static Public Attributes

static constexpr bool is_leaf = false
Static Public Attributes inherited from fvMatrixExpression< fvMatrixConstRefWrap< Matrix >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, GeometricFieldConstRefWrap< Matrix::faceFluxFieldType >, ListConstRefWrap< Matrix::psiFieldType::value_type > >
static constexpr bool is_leaf

Additional Inherited Members

Protected Attributes inherited from fvMatrixExpression< fvMatrixConstRefWrap< Matrix >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, GeometricFieldConstRefWrap< Matrix::faceFluxFieldType >, ListConstRefWrap< Matrix::psiFieldType::value_type > >
const bool hasDiag_
const bool hasUpper_
const bool hasLower_
const bool hasFaceFluxCorrection_
dimensionSet dimensions_

Detailed Description

template<class Matrix>
class Foam::Expression::fvMatrixConstRefWrap< Matrix >

Expression wrap of const reference to fvMatrix.

Definition at line 569 of file fvMatrixExpression.H.

Member Typedef Documentation

◆ this_type

template<class Matrix>
typedef Matrix this_type

The fvMatrix type.

Definition at line 589 of file fvMatrixExpression.H.

◆ value_type

template<class Matrix>
typedef Matrix::psiFieldType::value_type value_type

Type to return for internal field.

Definition at line 594 of file fvMatrixExpression.H.

◆ DiagExpr

template<class Matrix>
typedef ListConstRefWrap<value_type> DiagExpr

Type to return for containers.

Definition at line 599 of file fvMatrixExpression.H.

◆ UpperExpr

template<class Matrix>
typedef ListConstRefWrap<value_type> UpperExpr

Definition at line 600 of file fvMatrixExpression.H.

◆ LowerExpr

template<class Matrix>
typedef ListConstRefWrap<value_type> LowerExpr

Definition at line 601 of file fvMatrixExpression.H.

◆ FaceFluxExpr

template<class Matrix>
typedef GeometricFieldConstRefWrap< typename Matrix::faceFluxFieldType > FaceFluxExpr

Definition at line 606 of file fvMatrixExpression.H.

◆ SourceExpr

template<class Matrix>
typedef ListConstRefWrap<value_type> SourceExpr

Definition at line 607 of file fvMatrixExpression.H.

Constructor & Destructor Documentation

◆ fvMatrixConstRefWrap()

template<class Matrix>
fvMatrixConstRefWrap ( const this_type & elems)
inline

Definition at line 618 of file fvMatrixExpression.H.

References fvMatrixExpression< fvMatrixConstRefWrap< Matrix >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, GeometricFieldConstRefWrap< Matrix::faceFluxFieldType >, ListConstRefWrap< Matrix::psiFieldType::value_type > >::dimensions(), fvMatrixConstRefWrap(), fvMatrixExpression< fvMatrixConstRefWrap< Matrix >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, GeometricFieldConstRefWrap< Matrix::faceFluxFieldType >, ListConstRefWrap< Matrix::psiFieldType::value_type > >::fvMatrixExpression(), fvMatrixExpression< fvMatrixConstRefWrap< Matrix >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, GeometricFieldConstRefWrap< Matrix::faceFluxFieldType >, ListConstRefWrap< Matrix::psiFieldType::value_type > >::hasDiag(), fvMatrixExpression< fvMatrixConstRefWrap< Matrix >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, GeometricFieldConstRefWrap< Matrix::faceFluxFieldType >, ListConstRefWrap< Matrix::psiFieldType::value_type > >::hasFaceFluxCorrection(), fvMatrixExpression< fvMatrixConstRefWrap< Matrix >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, GeometricFieldConstRefWrap< Matrix::faceFluxFieldType >, ListConstRefWrap< Matrix::psiFieldType::value_type > >::hasLower(), and fvMatrixExpression< fvMatrixConstRefWrap< Matrix >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, ListConstRefWrap< Matrix::psiFieldType::value_type >, GeometricFieldConstRefWrap< Matrix::faceFluxFieldType >, ListConstRefWrap< Matrix::psiFieldType::value_type > >::hasUpper().

Referenced by fvMatrixConstRefWrap().

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

Member Function Documentation

◆ diag()

template<class Matrix>
DiagExpr diag ( ) const
inline

Definition at line 642 of file fvMatrixExpression.H.

◆ upper()

template<class Matrix>
UpperExpr upper ( ) const
inline

Definition at line 647 of file fvMatrixExpression.H.

◆ lower()

template<class Matrix>
LowerExpr lower ( ) const
inline

Definition at line 652 of file fvMatrixExpression.H.

◆ source()

template<class Matrix>
SourceExpr source ( ) const
inline

Definition at line 660 of file fvMatrixExpression.H.

◆ internalCoeffs()

template<class Matrix>
UpperExpr internalCoeffs ( const label i) const
inline

Definition at line 665 of file fvMatrixExpression.H.

References List< T >::null().

Here is the call graph for this function:

◆ boundaryCoeffs()

template<class Matrix>
UpperExpr boundaryCoeffs ( const label i) const
inline

Definition at line 675 of file fvMatrixExpression.H.

References List< T >::null().

Here is the call graph for this function:

◆ faceFluxCorrection()

template<class Matrix>
FaceFluxExpr faceFluxCorrection ( ) const
inline

Definition at line 685 of file fvMatrixExpression.H.

Member Data Documentation

◆ is_leaf

template<class Matrix>
bool is_leaf = false
staticconstexpr

Definition at line 584 of file fvMatrixExpression.H.


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