Public Types | Public Member Functions | List of all members
ConstMatrixBlock< MatrixType > Class Template Reference

Public Types

typedef MatrixType::cmptType cmptType
 The value type the Matrix contains. More...
 
typedef MatrixType::value_type value_type
 The value type the Matrix contains. More...
 
typedef MatrixType::size_type size_type
 The type to represent the size of a Matrix. More...
 

Public Member Functions

 ConstMatrixBlock (const MatrixType &matrix, const label m, const label n, const label mStart, const label nStart)
 Construct block for matrix, size and location. More...
 
label m () const noexcept
 Return the number of rows in the block. More...
 
label n () const noexcept
 Return the number of columns in the block. More...
 
label size () const noexcept
 The number of elements in the block (m*n) More...
 
labelPair sizes () const noexcept
 Return row/column sizes of the block. More...
 
const cmptType & operator() (const label i, const label j) const
 (i, j) const element access operator More...
 
 operator Field< cmptType > () const
 Convert a column of a matrix to a Field. More...
 
void checkIndex (const label i, const label j) const
 Check if (i, j) is within range of row-column limits. More...
 

Detailed Description

template<class MatrixType>
class Foam::ConstMatrixBlock< MatrixType >

Definition at line 61 of file Matrix.H.

Member Typedef Documentation

◆ cmptType

typedef MatrixType::cmptType cmptType

The value type the Matrix contains.

Definition at line 94 of file MatrixBlock.H.

◆ value_type

typedef MatrixType::value_type value_type

The value type the Matrix contains.

Definition at line 99 of file MatrixBlock.H.

◆ size_type

typedef MatrixType::size_type size_type

The type to represent the size of a Matrix.

Definition at line 104 of file MatrixBlock.H.

Constructor & Destructor Documentation

◆ ConstMatrixBlock()

ConstMatrixBlock ( const MatrixType &  matrix,
const label  m,
const label  n,
const label  mStart,
const label  nStart 
)
inline

Construct block for matrix, size and location.

Definition at line 26 of file MatrixBlockI.H.

Member Function Documentation

◆ m()

label m ( ) const
inlinenoexcept

Return the number of rows in the block.

Definition at line 127 of file MatrixBlock.H.

◆ n()

label n ( ) const
inlinenoexcept

Return the number of columns in the block.

Definition at line 132 of file MatrixBlock.H.

◆ size()

Foam::label size ( ) const
inlinenoexcept

The number of elements in the block (m*n)

Definition at line 83 of file MatrixBlockI.H.

◆ sizes()

Foam::labelPair sizes ( ) const
inlinenoexcept

Return row/column sizes of the block.

Definition at line 98 of file MatrixBlockI.H.

◆ operator()()

const MatrixType::cmptType & operator() ( const label  i,
const label  j 
) const
inline

(i, j) const element access operator

Definition at line 117 of file MatrixBlockI.H.

◆ operator Field< cmptType >()

operator Field< cmptType > ( ) const

Convert a column of a matrix to a Field.

Definition at line 27 of file MatrixBlock.C.

References Foam::abort(), f(), Foam::FatalError, FatalErrorInFunction, and forAll.

Here is the call graph for this function:

◆ checkIndex()

void checkIndex ( const label  i,
const label  j 
) const

Check if (i, j) is within range of row-column limits.

Definition at line 97 of file MatrixBlock.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:
The documentation for this class was generated from the following files: