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...

Inheritance diagram for lduMatrix:

[legend]

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 &)
	Copy constructor. More...

	lduMatrix (lduMatrix &, bool reuse)
	Copy constructor 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
	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...

scalarField &	lower ()

scalarField &	diag ()

scalarField &	upper ()

scalarField &	lower (const label size)

scalarField &	diag (const label nCoeffs)

scalarField &	upper (const label nCoeffs)

const scalarField &	lower () const

const scalarField &	diag () const

const scalarField &	upper () const

bool	hasDiag () const

bool	hasUpper () const

bool	hasLower () const

bool	diagonal () const

bool	symmetric () const

bool	asymmetric () const

void	sumDiag ()

void	negSumDiag ()

void	sumMagOffDiag (scalarField &sumOff) const

void	Amul (scalarField &, const tmp< scalarField > &, const FieldField< Field, scalar > &, const lduInterfaceFieldPtrsList &, const direction cmpt) const
	Matrix multiplication with updated interfaces. More...

void	Tmul (scalarField &, const tmp< scalarField > &, const FieldField< Field, scalar > &, const lduInterfaceFieldPtrsList &, const direction cmpt) const
	Matrix transpose multiplication with updated interfaces. More...

void	sumA (scalarField &, const FieldField< Field, scalar > &, const lduInterfaceFieldPtrsList &) const
	Sum the coefficients on each row of the matrix. More...

void	residual (scalarField &rA, const scalarField &psi, const scalarField &source, const FieldField< Field, scalar > &interfaceBouCoeffs, const lduInterfaceFieldPtrsList &interfaces, const direction cmpt) const

tmp< scalarField >	residual (const scalarField &psi, const scalarField &source, const FieldField< Field, scalar > &interfaceBouCoeffs, const lduInterfaceFieldPtrsList &interfaces, const direction cmpt) const

void	initMatrixInterfaces (const FieldField< Field, scalar > &interfaceCoeffs, const lduInterfaceFieldPtrsList &interfaces, const scalarField &psiif, scalarField &result, const direction cmpt) const
	Initialise the update of interfaced interfaces. More...

void	updateMatrixInterfaces (const FieldField< Field, scalar > &interfaceCoeffs, const lduInterfaceFieldPtrsList &interfaces, const scalarField &psiif, scalarField &result, const direction cmpt) const
	Update interfaced interfaces for matrix operations. More...

template<class Type >
tmp< Field< Type > >	H (const Field< Type > &) const

template<class Type >
tmp< Field< Type > >	H (const tmp< Field< Type >> &) const

tmp< scalarField >	H1 () const

template<class Type >
tmp< Field< Type > >	faceH (const Field< Type > &) const

template<class Type >
tmp< Field< Type > >	faceH (const tmp< Field< Type >> &) const

InfoProxy< lduMatrix >	info () const
	Return info proxy. More...

void	operator= (const lduMatrix &)

void	negate ()

void	operator+= (const lduMatrix &)

void	operator-= (const lduMatrix &)

void	operator*= (const scalarField &)

void	operator*= (scalar)

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

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

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

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

Friends
Ostream &	operator<< (Ostream &, const lduMatrix &)

Ostream &	operator<< (Ostream &, const InfoProxy< lduMatrix > &)

Detailed Description

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.

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 79 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 43 of file lduMatrix.C.

Referenced by lduMatrix::preconditioner::preconditionT().

Here is the caller graph for this function:

◆ lduMatrix() [2/4]

lduMatrix ( const lduMatrix & A )

Copy constructor.

Definition at line 52 of file lduMatrix.C.

◆ lduMatrix() [3/4]

lduMatrix	(	lduMatrix &	A,
		bool	reuse
	)

Copy constructor or re-use as specified.

Definition at line 76 of file lduMatrix.C.

◆ 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 123 of file lduMatrix.C.

References lduMatrix::hasDiag().

Here is the call graph for this function:

◆ ~lduMatrix()

~lduMatrix ( )

Destructor.

Definition at line 149 of file lduMatrix.C.

Referenced by lduMatrix::preconditioner::preconditionT().

Here is the caller graph for this function:

Member Function Documentation

◆ ClassName()

ClassName ( "lduMatrix" )

Referenced by lduMatrix::preconditioner::preconditionT().

Here is the caller graph for this function:

◆ mesh()

const lduMesh& mesh ( ) const

inline

Return the LDU mesh from which the addressing is obtained.

Definition at line 544 of file lduMatrix.H.

Referenced by algebraicPairGAMGAgglomeration::algebraicPairGAMGAgglomeration(), GAMGAgglomeration::New(), PCG::solve(), PBiCG::solve(), smoothSolver::solve(), and PBiCGStab::solve().

Here is the caller graph for this function:

◆ lduAddr()

const lduAddressing& lduAddr ( ) const

inline

Return the LDU addressing.

Definition at line 550 of file lduMatrix.H.

References lduMesh::lduAddr().

Referenced by DICPreconditioner::calcReciprocalD(), DILUPreconditioner::calcReciprocalD(), fvMatrix< Type >::DD(), lduMatrix::diag(), lduMatrix::faceH(), lduMatrix::H(), fvMatrix< Type >::H1(), lduMatrix::H1(), lduMatrix::lower(), LUscalarMatrix::LUscalarMatrix(), lduMatrix::negSumDiag(), lduMatrix::operator*=(), lduMatrix::patchSchedule(), fvMatrix< Type >::relax(), symGaussSeidelSmoother::smooth(), GaussSeidelSmoother::smooth(), nonBlockingGaussSeidelSmoother::smooth(), lduMatrix::sumDiag(), lduMatrix::sumMagOffDiag(), and lduMatrix::upper().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patchSchedule()

const lduSchedule& patchSchedule ( ) const

inline

Return the patch evaluation schedule.

Definition at line 556 of file lduMatrix.H.

References lduMatrix::diag(), lduMatrix::lduAddr(), lduMatrix::lower(), lduAddressing::patchSchedule(), and lduMatrix::upper().

Here is the call graph for this function:

◆ lower() [1/3]

Foam::scalarField & lower ( )

Definition at line 168 of file lduMatrix.C.

References lduMatrix::lduAddr().

Referenced by algebraicPairGAMGAgglomeration::algebraicPairGAMGAgglomeration(), DILUPreconditioner::calcReciprocalD(), lduMatrix::faceH(), gaussConvectionScheme< Type >::fvmDiv(), GAMGSolver::GAMGSolver(), lduMatrix::H(), lduMatrix::H1(), LUscalarMatrix::LUscalarMatrix(), lduMatrix::negSumDiag(), lduMatrix::operator*=(), lduMatrix::operator+=(), lduMatrix::operator-=(), Foam::operator<<(), lduMatrix::operator=(), lduMatrix::patchSchedule(), symGaussSeidelSmoother::smooth(), GaussSeidelSmoother::smooth(), nonBlockingGaussSeidelSmoother::smooth(), lduMatrix::sumDiag(), and lduMatrix::sumMagOffDiag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ diag() [1/3]

Foam::scalarField & diag ( )

Definition at line 186 of file lduMatrix.C.

References lduMatrix::lduAddr().

Referenced by interRegionExplicitPorositySource::addSup(), solidificationMeltingSource::addSup(), fixedCoeff::correct(), powerLaw::correct(), DarcyForchheimer::correct(), powerLawLopesdaCosta::correct(), solidification::correct(), fvMatrix< Type >::D(), fvMatrix< Type >::DD(), EulerD2dt2Scheme< Type >::fvmD2dt2(), EulerDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), GAMGSolver::GAMGSolver(), LUscalarMatrix::LUscalarMatrix(), lduMatrix::negSumDiag(), nonBlockingGaussSeidelSmoother::nonBlockingGaussSeidelSmoother(), lduMatrix::operator+=(), lduMatrix::operator-=(), Foam::operator<<(), lduMatrix::operator=(), lduMatrix::patchSchedule(), fvMatrix< Type >::relax(), fvMatrix< Type >::setReference(), symGaussSeidelSmoother::smooth(), GaussSeidelSmoother::smooth(), nonBlockingGaussSeidelSmoother::smooth(), GAMGSolver::solve(), and lduMatrix::sumDiag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ upper() [1/3]

Foam::scalarField & upper ( )

Definition at line 197 of file lduMatrix.C.

References lduMatrix::lduAddr().

Referenced by algebraicPairGAMGAgglomeration::algebraicPairGAMGAgglomeration(), DICPreconditioner::calcReciprocalD(), DILUPreconditioner::calcReciprocalD(), lduMatrix::faceH(), gaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), lduMatrix::H(), lduMatrix::H1(), LUscalarMatrix::LUscalarMatrix(), lduMatrix::negSumDiag(), lduMatrix::operator*=(), lduMatrix::operator+=(), lduMatrix::operator-=(), Foam::operator<<(), lduMatrix::operator=(), lduMatrix::patchSchedule(), symGaussSeidelSmoother::smooth(), GaussSeidelSmoother::smooth(), nonBlockingGaussSeidelSmoother::smooth(), lduMatrix::sumDiag(), and lduMatrix::sumMagOffDiag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lower() [2/3]

Foam::scalarField & lower ( const label size )

Definition at line 215 of file lduMatrix.C.

◆ diag() [2/3]

Foam::scalarField & diag ( const label nCoeffs )

Definition at line 233 of file lduMatrix.C.

◆ upper() [2/3]

Foam::scalarField & upper ( const label nCoeffs )

Definition at line 244 of file lduMatrix.C.

◆ lower() [3/3]

const Foam::scalarField & lower ( ) const

Definition at line 262 of file lduMatrix.C.

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

Here is the call graph for this function:

◆ diag() [3/3]

const Foam::scalarField & diag ( ) const

Definition at line 282 of file lduMatrix.C.

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

Here is the call graph for this function:

◆ upper() [3/3]

const Foam::scalarField & upper ( ) const

Definition at line 295 of file lduMatrix.C.

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

Here is the call graph for this function:

◆ hasDiag()

bool hasDiag ( ) const

inline

Definition at line 580 of file lduMatrix.H.

Referenced by lduMatrix::lduMatrix(), and Foam::operator<<().

Here is the caller graph for this function:

◆ hasUpper()

bool hasUpper ( ) const

inline

Definition at line 585 of file lduMatrix.H.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ hasLower()

bool hasLower ( ) const

inline

Definition at line 590 of file lduMatrix.H.

Referenced by algebraicPairGAMGAgglomeration::algebraicPairGAMGAgglomeration(), and Foam::operator<<().

Here is the caller graph for this function:

◆ diagonal()

bool diagonal ( ) const

inline

Definition at line 595 of file lduMatrix.H.

Referenced by lduMatrix::solver::New(), lduMatrix::operator+=(), and lduMatrix::operator-=().

Here is the caller graph for this function:

◆ symmetric()

bool symmetric ( ) const

inline

Definition at line 600 of file lduMatrix.H.

Referenced by lduMatrix::solver::New(), lduMatrix::smoother::New(), lduMatrix::preconditioner::New(), lduMatrix::operator*=(), lduMatrix::operator+=(), and lduMatrix::operator-=().

Here is the caller graph for this function:

◆ asymmetric()

bool asymmetric ( ) const

inline

Definition at line 605 of file lduMatrix.H.

References lduMatrix::Amul(), lduMatrix::faceH(), lduMatrix::H(), lduMatrix::H1(), lduMatrix::info(), lduMatrix::initMatrixInterfaces(), lduMatrix::negate(), lduMatrix::negSumDiag(), lduMatrix::operator*=(), lduMatrix::operator+=(), lduMatrix::operator-=(), lduMatrix::operator<<, lduMatrix::operator=(), psi, lduMatrix::residual(), lduMatrix::sumA(), lduMatrix::sumDiag(), lduMatrix::sumMagOffDiag(), lduMatrix::Tmul(), and lduMatrix::updateMatrixInterfaces().

Referenced by lduMatrix::solver::New(), lduMatrix::smoother::New(), lduMatrix::preconditioner::New(), lduMatrix::operator*=(), lduMatrix::operator+=(), and lduMatrix::operator-=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sumDiag()

void sumDiag ( )

Definition at line 33 of file lduMatrixOperations.C.

References lduMatrix::diag(), lduMatrix::lduAddr(), lduMatrix::lower(), lduAddressing::lowerAddr(), UList< T >::size(), lduMatrix::upper(), and lduAddressing::upperAddr().

Referenced by lduMatrix::asymmetric().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ negSumDiag()

void negSumDiag ( )

Definition at line 55 of file lduMatrixOperations.C.

References lduMatrix::diag(), lduMatrix::lduAddr(), lduMatrix::lower(), lduAddressing::lowerAddr(), UList< T >::size(), lduMatrix::sumMagOffDiag(), lduMatrix::upper(), and lduAddressing::upperAddr().

Referenced by lduMatrix::asymmetric(), gaussConvectionScheme< Type >::fvmDiv(), and gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sumMagOffDiag()

void sumMagOffDiag ( scalarField & sumOff ) const

Definition at line 78 of file lduMatrixOperations.C.

References lduMatrix::lduAddr(), lduMatrix::lower(), lduAddressing::lowerAddr(), Foam::mag(), UList< T >::size(), lduMatrix::upper(), and lduAddressing::upperAddr().

Referenced by lduMatrix::asymmetric(), lduMatrix::negSumDiag(), and fvMatrix< Type >::relax().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Amul()

void Amul	(	scalarField &	Apsi,
		const tmp< scalarField > &	tpsi,
		const FieldField< Field, scalar > &	interfaceBouCoeffs,
		const lduInterfaceFieldPtrsList &	interfaces,
		const direction	cmpt
	)		const

Matrix multiplication with updated interfaces.

Definition at line 35 of file lduMatrixATmul.C.

References UList< T >::begin(), tmp< T >::clear(), Foam::diag(), psi, and lduMatrix::Tmul().

Referenced by lduMatrix::asymmetric().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Tmul()

void Tmul	(	scalarField &	Tpsi,
		const tmp< scalarField > &	tpsi,
		const FieldField< Field, scalar > &	interfaceIntCoeffs,
		const lduInterfaceFieldPtrsList &	interfaces,
		const direction	cmpt
	)		const

Matrix transpose multiplication with updated interfaces.

Definition at line 96 of file lduMatrixATmul.C.

References UList< T >::begin(), tmp< T >::clear(), Foam::diag(), psi, and lduMatrix::sumA().

Referenced by lduMatrix::Amul(), and lduMatrix::asymmetric().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sumA()

void sumA	(	scalarField &	sumA,
		const FieldField< Field, scalar > &	interfaceBouCoeffs,
		const lduInterfaceFieldPtrsList &	interfaces
	)		const

Sum the coefficients on each row of the matrix.

Definition at line 155 of file lduMatrixATmul.C.

References UList< T >::begin(), Foam::diag(), forAll, patchi, lduMatrix::residual(), and UPtrList< T >::set().

Referenced by lduMatrix::asymmetric(), and lduMatrix::Tmul().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ residual() [1/2]

void residual	(	scalarField &	rA,
		const scalarField &	psi,
		const scalarField &	source,
		const FieldField< Field, scalar > &	interfaceBouCoeffs,
		const lduInterfaceFieldPtrsList &	interfaces,
		const direction	cmpt
	)		const

Definition at line 204 of file lduMatrixATmul.C.

References UList< T >::begin(), Foam::diag(), forAll, patchi, UPtrList< T >::set(), and UPtrList< T >::size().

Referenced by lduMatrix::asymmetric(), fvMatrix< Type >::residual(), and lduMatrix::sumA().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ residual() [2/2]

Foam::tmp< Foam::scalarField > residual	(	const scalarField &	psi,
		const scalarField &	source,
		const FieldField< Field, scalar > &	interfaceBouCoeffs,
		const lduInterfaceFieldPtrsList &	interfaces,
		const direction	cmpt
	)		const

Definition at line 284 of file lduMatrixATmul.C.

References psi, tmp< T >::ref(), scalarField(), and List< T >::size().

Here is the call graph for this function:

◆ initMatrixInterfaces()

void initMatrixInterfaces	(	const FieldField< Field, scalar > &	interfaceCoeffs,
		const lduInterfaceFieldPtrsList &	interfaces,
		const scalarField &	psiif,
		scalarField &	result,
		const direction	cmpt
	)		const

Initialise the update of interfaced interfaces.

for matrix operations

Definition at line 31 of file lduMatrixUpdateMatrixInterfaces.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, UPtrList< T >::set(), UPtrList< T >::size(), List< T >::size(), and lduMatrix::updateMatrixInterfaces().

Referenced by lduMatrix::asymmetric(), symGaussSeidelSmoother::smooth(), GaussSeidelSmoother::smooth(), and nonBlockingGaussSeidelSmoother::smooth().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateMatrixInterfaces()

void updateMatrixInterfaces	(	const FieldField< Field, scalar > &	interfaceCoeffs,
		const lduInterfaceFieldPtrsList &	interfaces,
		const scalarField &	psiif,
		scalarField &	result,
		const direction	cmpt
	)		const