Classes | Public Member Functions | Friends | List of all members
LduMatrix< Type, DType, LUType > Class Template Reference

LduMatrix is a general matrix class in which the coefficients are stored as three arrays, one for the upper triangle, one for the lower triangle and a third for the diagonal. More...

Classes

class  preconditioner
 Abstract base-class for LduMatrix preconditioners. More...
 
class  smoother
 Abstract base-class for LduMatrix smoothers. More...
 
class  solver
 Abstract base-class for LduMatrix solvers. More...
 

Public Member Functions

 ClassName ("LduMatrix")
 
 LduMatrix (const lduMesh &)
 Construct given an LDU addressed mesh. More...
 
 LduMatrix (const LduMatrix< Type, DType, LUType > &)
 Construct as copy. More...
 
 LduMatrix (LduMatrix< Type, DType, LUType > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
 LduMatrix (const lduMesh &, Istream &)
 Construct given an LDU addressed mesh and an Istream. More...
 
 ~LduMatrix ()
 Destructor. More...
 
const lduMesh & mesh () const noexcept
 Return the LDU mesh from which the addressing is obtained. More...
 
const lduAddressing & lduAddr () const
 Return the LDU addressing. More...
 
const lduSchedule & patchSchedule () const
 Return the patch evaluation schedule. More...
 
const LduInterfaceFieldPtrsList< Type > & interfaces () const
 Return interfaces. More...
 
LduInterfaceFieldPtrsList< Type > & interfaces ()
 Return interfaces. More...
 
Field< DType > & diag ()
 
Field< LUType > & upper ()
 
Field< LUType > & lower ()
 
Field< Type > & source ()
 
FieldField< Field, LUType > & interfacesUpper ()
 
FieldField< Field, LUType > & interfacesLower ()
 
const Field< DType > & diag () const
 
const Field< LUType > & upper () const
 
const Field< LUType > & lower () const
 
const Field< Type > & source () const
 
const FieldField< Field, LUType > & interfacesUpper () const
 
const FieldField< Field, LUType > & interfacesLower () const
 
bool hasDiag () const noexcept
 
bool hasUpper () const noexcept
 
bool hasLower () const noexcept
 
bool hasSource () const noexcept
 
bool diagonal () const noexcept
 
bool symmetric () const noexcept
 
bool asymmetric () const noexcept
 
void sumDiag ()
 
void negSumDiag ()
 
void sumMagOffDiag (Field< LUType > &sumOff) const
 
void Amul (Field< Type > &, const tmp< Field< Type >> &) const
 Matrix multiplication. More...
 
void Tmul (Field< Type > &, const tmp< Field< Type >> &) const
 Matrix transpose multiplication. More...
 
void sumA (Field< Type > &) const
 Sum the coefficients on each row of the matrix. More...
 
void residual (Field< Type > &rA, const Field< Type > &psi) const
 
tmp< Field< Type > > residual (const Field< Type > &psi) const
 
void initMatrixInterfaces (const bool add, const FieldField< Field, LUType > &interfaceCoeffs, const Field< Type > &psiif, Field< Type > &result) const
 Initialise the update of interfaced interfaces. More...
 
void updateMatrixInterfaces (const bool add, const FieldField< Field, LUType > &interfaceCoeffs, const Field< Type > &psiif, Field< Type > &result, const label startRequest) const
 Update interfaced interfaces for matrix operations. More...
 
tmp< Field< Type > > H (const Field< Type > &) const
 
tmp< Field< Type > > H (const tmp< Field< Type >> &) const
 
tmp< Field< Type > > faceH (const Field< Type > &) const
 
tmp< Field< Type > > faceH (const tmp< Field< Type >> &) const
 
void operator= (const LduMatrix< Type, DType, LUType > &)
 
void negate ()
 
void operator+= (const LduMatrix< Type, DType, LUType > &)
 
void operator-= (const LduMatrix< Type, DType, LUType > &)
 
void operator*= (const scalarField &)
 
void operator*= (scalar)
 

Friends

class SolverPerformance< Type >
 
Ostream & operator (Ostream &, const LduMatrix< Type, DType, LUType > &)
 

Detailed Description

template<class Type, class DType, class LUType>
class Foam::LduMatrix< Type, DType, LUType >

LduMatrix is a general matrix class in which the coefficients are stored as three arrays, one for the upper triangle, one for the lower triangle and a third for the diagonal.

Addressing arrays must be supplied for the upper and lower triangles.

Note
It might be better if this class were organised as a hierarchy starting from an empty matrix, then deriving diagonal, symmetric and asymmetric matrices.
Source files

Definition at line 68 of file LduMatrix.H.

Constructor & Destructor Documentation

◆ LduMatrix() [1/4]

LduMatrix ( const lduMesh &  mesh)

Construct given an LDU addressed mesh.

The coefficients are initially empty for subsequent setting.

Definition at line 27 of file LduMatrix.C.

◆ LduMatrix() [2/4]

LduMatrix ( const LduMatrix< Type, DType, LUType > &  )

Construct as copy.

◆ LduMatrix() [3/4]

LduMatrix ( LduMatrix< Type, DType, LUType > &  ,
bool  reuse 
)

Construct as copy or re-use as specified.

◆ LduMatrix() [4/4]

LduMatrix ( const lduMesh &  mesh,
Istream &  is 
)

Construct given an LDU addressed mesh and an Istream.

from which the coefficients are read

Definition at line 139 of file LduMatrix.C.

◆ ~LduMatrix()

~LduMatrix ( )

Destructor.

Definition at line 158 of file LduMatrix.C.

Member Function Documentation

◆ ClassName()

ClassName ( "LduMatrix< Type, DType, LUType >"  )

◆ mesh()

const lduMesh& mesh ( ) const
inlinenoexcept

Return the LDU mesh from which the addressing is obtained.

Definition at line 588 of file LduMatrix.H.

◆ lduAddr()

const lduAddressing& lduAddr ( ) const
inline

Return the LDU addressing.

Definition at line 596 of file LduMatrix.H.

Referenced by TDILUPreconditioner< Type, DType, LUType >::calcInvD(), LduMatrix< Type, DType, LUType >::patchSchedule(), and TGaussSeidelSmoother< Type, DType, LUType >::smooth().

Here is the caller graph for this function:

◆ patchSchedule()

const lduSchedule& patchSchedule ( ) const
inline

Return the patch evaluation schedule.

Definition at line 604 of file LduMatrix.H.

References LduMatrix< Type, DType, LUType >::lduAddr(), and lduAddressing::patchSchedule().

Here is the call graph for this function:

◆ interfaces() [1/2]

const LduInterfaceFieldPtrsList<Type>& interfaces ( ) const
inline

Return interfaces.

Definition at line 612 of file LduMatrix.H.

◆ interfaces() [2/2]

LduInterfaceFieldPtrsList<Type>& interfaces ( )
inline

Return interfaces.

Definition at line 620 of file LduMatrix.H.

◆ diag() [1/2]

Foam::Field< DType > & diag ( )

Definition at line 185 of file LduMatrix.C.

References Foam::Zero.

Referenced by fvMatrix< Type >::solveCoupled(), and TGaussSeidelSmoother< Type, DType, LUType >::TGaussSeidelSmoother().

Here is the caller graph for this function:

◆ upper() [1/2]

Foam::Field< LUType > & upper ( )

Definition at line 197 of file LduMatrix.C.

References Foam::Zero.

Referenced by TDILUPreconditioner< Type, DType, LUType >::calcInvD(), LduMatrix< Type, DType, LUType >::faceH(), LduMatrix< Type, DType, LUType >::negSumDiag(), TGaussSeidelSmoother< Type, DType, LUType >::smooth(), LduMatrix< Type, DType, LUType >::sumDiag(), and LduMatrix< Type, DType, LUType >::sumMagOffDiag().

Here is the caller graph for this function:

◆ lower() [1/2]

Foam::Field< LUType > & lower ( )

Definition at line 220 of file LduMatrix.C.

References Foam::Zero.

Referenced by TDILUPreconditioner< Type, DType, LUType >::calcInvD(), LduMatrix< Type, DType, LUType >::faceH(), LduMatrix< Type, DType, LUType >::negSumDiag(), TGaussSeidelSmoother< Type, DType, LUType >::smooth(), LduMatrix< Type, DType, LUType >::sumDiag(), and LduMatrix< Type, DType, LUType >::sumMagOffDiag().

Here is the caller graph for this function:

◆ source() [1/2]

Foam::Field< Type > & source ( )

Definition at line 243 of file LduMatrix.C.

References Foam::Zero.

Referenced by TGaussSeidelSmoother< Type, DType, LUType >::smooth().

Here is the caller graph for this function:

◆ interfacesUpper() [1/2]

FieldField<Field, LUType>& interfacesUpper ( )
inline

Definition at line 633 of file LduMatrix.H.

Referenced by TGaussSeidelSmoother< Type, DType, LUType >::smooth().

Here is the caller graph for this function:

◆ interfacesLower() [1/2]

FieldField<Field, LUType>& interfacesLower ( )
inline

Definition at line 638 of file LduMatrix.H.

◆ diag() [2/2]

const Foam::Field< DType > & diag ( ) const

Definition at line 255 of file LduMatrix.C.

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

Here is the call graph for this function:

◆ upper() [2/2]

const Foam::Field< LUType > & upper ( ) const

Definition at line 269 of file LduMatrix.C.

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

Here is the call graph for this function:

◆ lower() [2/2]

const Foam::Field< LUType > & lower ( ) const

Definition at line 290 of file LduMatrix.C.

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

Here is the call graph for this function:

◆ source() [2/2]

const Foam::Field< Type > & source ( ) const

Definition at line 311 of file LduMatrix.C.

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

Here is the call graph for this function:

◆ interfacesUpper() [2/2]

const FieldField<Field, LUType>& interfacesUpper ( ) const
inline

Definition at line 649 of file LduMatrix.H.

◆ interfacesLower() [2/2]

const FieldField<Field, LUType>& interfacesLower ( ) const
inline

Definition at line 654 of file LduMatrix.H.

◆ hasDiag()

bool hasDiag ( ) const
inlinenoexcept

Definition at line 660 of file LduMatrix.H.

◆ hasUpper()

bool hasUpper ( ) const
inlinenoexcept

Definition at line 665 of file LduMatrix.H.

◆ hasLower()

bool hasLower ( ) const
inlinenoexcept

Definition at line 670 of file LduMatrix.H.

◆ hasSource()

bool hasSource ( ) const
inlinenoexcept

Definition at line 675 of file LduMatrix.H.

◆ diagonal()

bool diagonal ( ) const
inlinenoexcept

Definition at line 680 of file LduMatrix.H.

Referenced by LduMatrix< Type, DType, LUType >::solver::New().

Here is the caller graph for this function:

◆ symmetric()

bool symmetric ( ) const
inlinenoexcept

Definition at line 685 of file LduMatrix.H.

Referenced by LduMatrix< Type, DType, LUType >::solver::New(), and LduMatrix< Type, DType, LUType >::smoother::New().

Here is the caller graph for this function:

◆ asymmetric()

bool asymmetric ( ) const
inlinenoexcept

Definition at line 690 of file LduMatrix.H.

Referenced by LduMatrix< Type, DType, LUType >::solver::New(), and LduMatrix< Type, DType, LUType >::smoother::New().

Here is the caller graph for this function:

◆ sumDiag()

void sumDiag ( )

Definition at line 27 of file LduMatrixOperations.C.

References Foam::diag(), LduMatrix< Type, DType, LUType >::lower(), UList< T >::size(), and LduMatrix< Type, DType, LUType >::upper().

Here is the call graph for this function:

◆ negSumDiag()

void negSumDiag ( )

Definition at line 45 of file LduMatrixOperations.C.

References Foam::diag(), LduMatrix< Type, DType, LUType >::lower(), UList< T >::size(), and LduMatrix< Type, DType, LUType >::upper().

Here is the call graph for this function:

◆ sumMagOffDiag()

void sumMagOffDiag ( Field< LUType > &  sumOff) const

Definition at line 64 of file LduMatrixOperations.C.

References Foam::cmptMag(), LduMatrix< Type, DType, LUType >::lower(), UList< T >::size(), and LduMatrix< Type, DType, LUType >::upper().

Here is the call graph for this function:

◆ Amul()

void Amul ( Field< Type > &  Apsi,
const tmp< Field< Type >> &  tpsi 
) const

Matrix multiplication.

Definition at line 28 of file LduMatrixATmul.C.

References UList< Type >::begin(), Foam::diag(), Foam::dot(), Foam::stringOps::lower(), psi, and Foam::stringOps::upper().

Here is the call graph for this function:

◆ Tmul()

void Tmul ( Field< Type > &  Tpsi,
const tmp< Field< Type >> &  tpsi 
) const

Matrix transpose multiplication.

Definition at line 87 of file LduMatrixATmul.C.

References UList< Type >::begin(), Foam::diag(), Foam::dot(), Foam::stringOps::lower(), psi, and Foam::stringOps::upper().

Here is the call graph for this function:

◆ sumA()

void sumA ( Field< Type > &  sumA) const

Sum the coefficients on each row of the matrix.

Definition at line 145 of file LduMatrixATmul.C.

References UList< Type >::begin(), Foam::diag(), Foam::dot(), forAll, Foam::stringOps::lower(), and Foam::stringOps::upper().

Here is the call graph for this function:

◆ residual() [1/2]

void residual ( Field< Type > &  rA,
const Field< Type > &  psi 
) const

Definition at line 193 of file LduMatrixATmul.C.

References UList< Type >::begin(), Foam::diag(), Foam::dot(), Foam::stringOps::lower(), psi, and Foam::stringOps::upper().

Here is the call graph for this function:

◆ residual() [2/2]

Foam::tmp< Foam::Field< Type > > residual ( const Field< Type > &  psi) const

Definition at line 253 of file LduMatrixATmul.C.

References Foam::New(), and psi.

Here is the call graph for this function:

◆ initMatrixInterfaces()

void initMatrixInterfaces ( const bool  add,
const FieldField< Field, LUType > &  interfaceCoeffs,
const Field< Type > &  psiif,
Field< Type > &  result 
) const

Initialise the update of interfaced interfaces.

for matrix operations

Definition at line 29 of file LduMatrixUpdateMatrixInterfaces.C.

References Foam::add(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, and UList< T >::size().

Referenced by TGaussSeidelSmoother< Type, DType, LUType >::smooth().

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

◆ updateMatrixInterfaces()

void updateMatrixInterfaces ( const bool  add,
const FieldField< Field, LUType > &  interfaceCoeffs,
const Field< Type > &  psiif,
Field< Type > &  result,
const label  startRequest 
) const

Update interfaced interfaces for matrix operations.

Definition at line 101 of file LduMatrixUpdateMatrixInterfaces.C.

References Foam::add(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and forAll.

Referenced by TGaussSeidelSmoother< Type, DType, LUType >::smooth().

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

◆ H() [1/2]

Foam::tmp< Foam::Field< Type > > H ( const Field< Type > &  psi) const

Definition at line 84 of file LduMatrixOperations.C.

References UList< Type >::begin(), Foam::stringOps::lower(), psi, Foam::stringOps::upper(), and Foam::Zero.

Here is the call graph for this function:

◆ H() [2/2]

Foam::tmp< Foam::Field< Type > > H ( const tmp< Field< Type >> &  tpsi) const

Definition at line 119 of file LduMatrixOperations.C.

References H().

Here is the call graph for this function:

◆ faceH() [1/2]

Foam::tmp< Foam::Field< Type > > faceH ( const Field< Type > &  psi) const

Definition at line 129 of file LduMatrixOperations.C.

References LduMatrix< Type, DType, LUType >::lower(), Foam::New(), psi, UList< T >::size(), and LduMatrix< Type, DType, LUType >::upper().

Here is the call graph for this function:

◆ faceH() [2/2]

Foam::tmp< Foam::Field< Type > > faceH ( const tmp< Field< Type >> &  tpsi) const

Definition at line 152 of file LduMatrixOperations.C.

◆ operator=()

void operator= ( const LduMatrix< Type, DType, LUType > &  )

Definition at line 163 of file LduMatrixOperations.C.

References A, Foam::diag(), Foam::stringOps::lower(), and Foam::stringOps::upper().

Here is the call graph for this function:

◆ negate()

void negate ( )

Definition at line 206 of file LduMatrixOperations.C.

References Foam::negate().

Here is the call graph for this function:

◆ operator+=()

void operator+= ( const LduMatrix< Type, DType, LUType > &  )

Definition at line 234 of file LduMatrixOperations.C.

References A, Foam::abort(), Foam::diag(), Foam::FatalError, FatalErrorInFunction, Foam::stringOps::lower(), and Foam::stringOps::upper().

Here is the call graph for this function:

◆ operator-=()

void operator-= ( const LduMatrix< Type, DType, LUType > &  )

Definition at line 311 of file LduMatrixOperations.C.

References A, Foam::abort(), Foam::diag(), Foam::FatalError, FatalErrorInFunction, Foam::stringOps::lower(), and Foam::stringOps::upper().

Here is the call graph for this function:

◆ operator*=() [1/2]

void operator*= ( const scalarField &  sf)

Definition at line 389 of file LduMatrixOperations.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::stringOps::lower(), and Foam::stringOps::upper().

Here is the call graph for this function:

◆ operator*=() [2/2]

void operator*= ( scalar  s)

Definition at line 436 of file LduMatrixOperations.C.

References s.

Friends And Related Function Documentation

◆ SolverPerformance< Type >

friend class SolverPerformance< Type >
friend

Definition at line 120 of file LduMatrix.H.

◆ operator

Ostream& operator ( Ostream &  ,
const LduMatrix< Type, DType, LUType > &   
)
friend
The documentation for this class was generated from the following files: