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

#include <lduMatrix.H>

Inheritance diagram for lduMatrix:

[legend]

Collaboration diagram for lduMatrix:

[legend]

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

Public Types
enum class	normTypes : char { NO_NORM , DEFAULT_NORM , L1_SCALED_NORM }
	Enumerated matrix normalisation types. More...

Public Member Functions
	ClassName ("lduMatrix")
	lduMatrix (const lduMesh &mesh)
	Construct (without coefficients) for an LDU addressed mesh.
	lduMatrix (const lduMatrix &)
	Copy construct.
	lduMatrix (lduMatrix &&)
	Move construct.
	lduMatrix (lduMatrix &, bool reuse)
	Construct as copy or re-use as specified.
	lduMatrix (const lduMesh &mesh, Istream &is)
	Construct given an LDU addressed mesh and an Istream from which the coefficients are read.
	~lduMatrix ()=default
	Destructor.
const lduMesh &	mesh () const noexcept
	Return the LDU mesh from which the addressing is obtained.
void	setLduMesh (const lduMesh &m)
	Set the LDU mesh containing the addressing.
const lduAddressing &	lduAddr () const
	Return the LDU addressing.
const lduSchedule &	patchSchedule () const
	Return the patch evaluation schedule.
const scalarField &	diag () const
const scalarField &	upper () const
const scalarField &	lower () const
scalarField &	diag ()
scalarField &	upper ()
scalarField &	lower ()
scalarField &	diag (label size)
scalarField &	upper (label nCoeffs)
scalarField &	lower (label nCoeffs)
bool	hasLowerCSR () const noexcept
const scalarField &	lowerCSR () const
scalarField &	lowerCSR ()
const solveScalarField &	work () const
	Work array.
solveScalarField &	work (label size) const
	Work array.
word	matrixTypeName () const
	The matrix type (empty, diagonal, symmetric, ...).
bool	hasDiag () const noexcept
bool	hasUpper () const noexcept
bool	hasLower () const noexcept
bool	diagonal () const noexcept
	Matrix has diagonal only.
bool	symmetric () const noexcept
	Matrix is symmetric.
bool	asymmetric () const noexcept
	Matrix is asymmetric (ie, full).
void	sumDiag ()
void	negSumDiag ()
void	sumMagOffDiag (scalarField &sumOff) const
void	Amul (solveScalarField &, const tmp< solveScalarField > &, const FieldField< Field, scalar > &, const lduInterfaceFieldPtrsList &, const direction cmpt) const
	Matrix multiplication with updated interfaces.
void	Tmul (solveScalarField &, const tmp< solveScalarField > &, const FieldField< Field, scalar > &, const lduInterfaceFieldPtrsList &, const direction cmpt) const
	Matrix transpose multiplication with updated interfaces.
void	sumA (solveScalarField &, const FieldField< Field, scalar > &, const lduInterfaceFieldPtrsList &) const
	Sum the coefficients on each row of the matrix.
void	residual (solveScalarField &rA, const solveScalarField &psi, const scalarField &source, const FieldField< Field, scalar > &interfaceBouCoeffs, const lduInterfaceFieldPtrsList &interfaces, const direction cmpt) const
tmp< solveScalarField >	residual (const solveScalarField &psi, const scalarField &source, const FieldField< Field, scalar > &interfaceBouCoeffs, const lduInterfaceFieldPtrsList &interfaces, const direction cmpt) const
void	initMatrixInterfaces (const bool add, const FieldField< Field, scalar > &interfaceCoeffs, const lduInterfaceFieldPtrsList &interfaces, const solveScalarField &psiif, solveScalarField &result, const direction cmpt) const
	Initialise the update of interfaced interfaces for matrix operations.
void	updateMatrixInterfaces (const bool add, const FieldField< Field, scalar > &interfaceCoeffs, const lduInterfaceFieldPtrsList &interfaces, const solveScalarField &psiif, solveScalarField &result, const direction cmpt, const label startRequest) const
	Update interfaced interfaces for matrix operations.
void	setResidualField (const scalarField &residual, const word &fieldName, const bool initial) const
	Set the residual field using an IOField on the object registry if it exists.
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 noexcept
	Return info proxy, used to print matrix information to a stream.
void	operator= (const lduMatrix &)
	Copy assignment.
void	operator= (lduMatrix &&)
	Move assignment.
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

Static Public Attributes
static const Enum< normTypes >	normTypesNames_
	Names for the normTypes.
static constexpr const label	defaultMaxIter = 1000
	Default maximum number of iterations for solvers (1000).
static const scalar	defaultTolerance = 1e-6
	Default (absolute) tolerance (1e-6).

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 80 of file lduMatrix.H.

Member Enumeration Documentation

◆ normTypes

enum class normTypes : char

strong

Enumerated matrix normalisation types.

Enumerator
NO_NORM	"none" norm (returns 1)
DEFAULT_NORM	"default" norm (== L1_scaled)
L1_SCALED_NORM	"L1_scaled" norm

Definition at line 124 of file lduMatrix.H.

Constructor & Destructor Documentation

◆ lduMatrix() [1/5]

lduMatrix ( const lduMesh & mesh )

Construct (without coefficients) for an LDU addressed mesh.

Not yet 'explicit' (legacy code may rely on implicit construct)

Definition at line 54 of file lduMatrix.C.

References mesh().

Referenced by ClassName(), lduMatrix::smoother::declareRunTimeSelectionTable(), lduMatrix::smoother::declareRunTimeSelectionTable(), lduMatrix::solver::declareRunTimeSelectionTable(), lduMatrix::solver::declareRunTimeSelectionTable(), faceH(), faMatrix< Type >::faMatrix(), faMatrix< Type >::faMatrix(), faMatrix< Type >::faMatrix(), fvMatrix< Type >::fvMatrix(), fvMatrix< Type >::fvMatrix(), fvMatrix< Type >::fvMatrix(), fvMatrix< Type >::fvMatrix(), lduMatrix(), lduMatrix(), lduMatrix(), lduMatrix::smoother::matrix(), lduMatrix::solver::matrix(), negSumDiag(), lduMatrix::smoother::New(), lduMatrix::solver::New(), lduMatrix::solver::New(), operator+=(), operator-=(), operator<<, operator=(), operator=(), lduMatrix::smoother::smoother(), lduMatrix::solver::solver(), sumDiag(), and sumMagOffDiag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lduMatrix() [2/5]

lduMatrix ( const lduMatrix & A )

Copy construct.

Definition at line 60 of file lduMatrix.C.

References A, if(), and lduMatrix().

Here is the call graph for this function:

◆ lduMatrix() [3/5]

lduMatrix ( lduMatrix && A )

Move construct.

Definition at line 88 of file lduMatrix.C.

References A, and lduMatrix().

Here is the call graph for this function:

◆ lduMatrix() [4/5]

lduMatrix	(	lduMatrix &	A,
		bool	reuse )

Construct as copy or re-use as specified.

Definition at line 99 of file lduMatrix.C.

References A, and lduMatrix().

Here is the call graph for this function:

◆ lduMatrix() [5/5]

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.

References lowerCSR(), and mesh().

Here is the call graph for this function:

◆ ~lduMatrix()

~lduMatrix ( )

default

Destructor.

Member Function Documentation

◆ ClassName()

ClassName ( "lduMatrix" )

References lduMatrix(), and mesh().

Here is the call graph for this function:

◆ mesh()

const lduMesh & mesh ( ) const

inlinenoexcept

Return the LDU mesh from which the addressing is obtained.

Definition at line 753 of file lduMatrix.H.

References Foam::noexcept.

Referenced by assemblyFaceAreaPairGAMGAgglomeration::assemblyFaceAreaPairGAMGAgglomeration(), ClassName(), faMatrix< Type >::faMatrix(), fvMatrix< Type >::fvMatrix(), fvMatrix< Type >::fvMatrix(), initMatrixInterfaces(), lduAddr(), lduMatrix(), lduMatrix(), GAMGAgglomeration::New(), patchSchedule(), faMatrix< Type >::setValuesFromList(), fvMatrix< Type >::setValuesFromList(), and fvMatrix< scalar >::solveSegregated().

Here is the caller graph for this function:

◆ setLduMesh()

void setLduMesh ( const lduMesh & m )

inline

Set the LDU mesh containing the addressing.

Definition at line 761 of file lduMatrix.H.

Referenced by fvMatrix< scalar >::solveSegregated().

Here is the caller graph for this function:

◆ lduAddr()

const lduAddressing & lduAddr ( ) const

inline

Return the LDU addressing.

Definition at line 769 of file lduMatrix.H.

References lduMesh::lduAddr(), and mesh().

Referenced by faMatrix< Type >::addBoundaryDiag(), fvMatrix< Type >::addBoundaryDiag(), faMatrix< Type >::addBoundarySource(), fvMatrix< Type >::addBoundarySource(), faMatrix< Type >::addCmptAvBoundaryDiag(), fvMatrix< Type >::addCmptAvBoundaryDiag(), Amul(), DICPreconditioner::calcReciprocalD(), DILUPreconditioner::calcReciprocalD(), fvMatrix< Type >::DD(), diag(), faceH(), H(), fvMatrix< Type >::H1(), H1(), initMatrixInterfaces(), lower(), lowerCSR(), lowerCSR(), cyclicACMIFvPatchField< Type >::manipulateMatrix(), cyclicAMIFvPatchField< Type >::manipulateMatrix(), cyclicFvPatchField< Type >::manipulateMatrix(), negSumDiag(), operator*=(), faMatrix< Type >::relax(), fvMatrix< Type >::relax(), residual(), fvMatrix< scalar >::solveSegregated(), sumA(), sumDiag(), sumMagOffDiag(), Tmul(), updateMatrixInterfaces(), and 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 777 of file lduMatrix.H.

References lduMesh::lduAddr(), mesh(), and lduAddressing::patchSchedule().

Referenced by initMatrixInterfaces(), and updateMatrixInterfaces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ diag() [1/3]

const Foam::scalarField & diag ( ) const

Definition at line 195 of file lduMatrix.C.

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

Referenced by faMatrix< Type >::addBoundaryDiag(), faMatrix< scalar >::addBoundaryDiag(), fvMatrix< Type >::addBoundaryDiag(), fvMatrix< scalar >::addBoundaryDiag(), faMatrix< Type >::addCmptAvBoundaryDiag(), faMatrix< scalar >::addCmptAvBoundaryDiag(), fvMatrix< Type >::addCmptAvBoundaryDiag(), fvMatrix< scalar >::addCmptAvBoundaryDiag(), velocityDampingConstraint::addDamping(), oversetFvMeshBase::addInterpolation(), interRegionExplicitPorositySource::addSup(), interRegionExplicitPorositySource::addSup(), solidificationMeltingSource::addSup(), Amul(), cyclicACMIFvPatchField< Type >::manipulateMatrix(), cyclicAMIFvPatchField< Type >::manipulateMatrix(), mixedEnergyFvPatchScalarField::manipulateMatrix(), oversetFvPatchField< Type >::manipulateMatrix(), waWallFunctionFvPatchScalarField::manipulateMatrix(), oversetFvMeshBase::normalisation(), Foam::operator<<(), faMatrix< Type >::setComponentReference(), faMatrix< scalar >::setComponentReference(), fvMatrix< Type >::setComponentReference(), fvMatrix< scalar >::setComponentReference(), fvMatrix< Type >::setValuesFromList(), faMatrix< Type >::solve(), faMatrix< scalar >::solve(), fvMatrix< Type >::solveCoupled(), oversetFvMeshBase::solveOverset(), fvMatrix< scalar >::solver(), fvMatrix< Type >::solveSegregated(), fvMatrix< scalar >::solveSegregated(), Foam::Expression::Sp(), sumDiag(), Foam::Expression::SuSp(), cyclicFvPatchField< scalar >::write(), and oversetFvMeshBase::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ upper() [1/3]

const Foam::scalarField & upper ( ) const

Definition at line 235 of file lduMatrix.C.

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

Referenced by oversetFvMeshBase::addInterpolation(), Amul(), DICPreconditioner::calcReciprocalD(), DILUPreconditioner::calcReciprocalD(), oversetFvPatchField< Type >::fringeFlux(), H(), H1(), cyclicACMIFvPatchField< Type >::manipulateMatrix(), cyclicAMIFvPatchField< Type >::manipulateMatrix(), mixedEnergyFvPatchScalarField::manipulateMatrix(), oversetFvPatchField< Type >::manipulateMatrix(), waWallFunctionFvPatchScalarField::manipulateMatrix(), operator*=(), operator+=(), operator-=(), Foam::operator<<(), operator=(), residual(), faMatrix< Type >::setValuesFromList(), fvMatrix< Type >::setValuesFromList(), fvMatrix< Type >::solveCoupled(), oversetFvMeshBase::solveOverset(), fvMatrix< scalar >::solveSegregated(), oversetFvPatchField< Type >::storeFringeCoefficients(), sumA(), Tmul(), fvMatrix< Type >::transferFvMatrixCoeffs(), cyclicFvPatchField< scalar >::write(), and oversetFvMeshBase::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lower() [1/3]

const Foam::scalarField & lower ( ) const

Definition at line 306 of file lduMatrix.C.

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

Referenced by oversetFvMeshBase::addInterpolation(), Amul(), DILUPreconditioner::calcReciprocalD(), oversetFvPatchField< Type >::fringeFlux(), H(), H1(), cyclicACMIFvPatchField< Type >::manipulateMatrix(), cyclicAMIFvPatchField< Type >::manipulateMatrix(), mixedEnergyFvPatchScalarField::manipulateMatrix(), oversetFvPatchField< Type >::manipulateMatrix(), waWallFunctionFvPatchScalarField::manipulateMatrix(), operator*=(), operator+=(), operator-=(), Foam::operator<<(), operator=(), residual(), faMatrix< Type >::setValuesFromList(), fvMatrix< Type >::setValuesFromList(), fvMatrix< Type >::solveCoupled(), oversetFvMeshBase::solveOverset(), fvMatrix< scalar >::solveSegregated(), oversetFvPatchField< Type >::storeFringeCoefficients(), sumA(), Tmul(), fvMatrix< Type >::transferFvMatrixCoeffs(), cyclicFvPatchField< scalar >::write(), and oversetFvMeshBase::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ diag() [2/3]

Foam::scalarField & diag ( )

Definition at line 208 of file lduMatrix.C.

References lduAddr().

Here is the call graph for this function:

◆ upper() [2/3]

Foam::scalarField & upper ( )

Definition at line 255 of file lduMatrix.C.

References lduAddr().

Here is the call graph for this function:

◆ lower() [2/3]

Foam::scalarField & lower ( )

Definition at line 326 of file lduMatrix.C.

References lduAddr().

Here is the call graph for this function:

◆ diag() [3/3]

Foam::scalarField & diag ( label size )

Definition at line 220 of file lduMatrix.C.

◆ upper() [3/3]

Foam::scalarField & upper ( label nCoeffs )

Definition at line 281 of file lduMatrix.C.

◆ lower() [3/3]

Foam::scalarField & lower ( label nCoeffs )

Definition at line 351 of file lduMatrix.C.

◆ hasLowerCSR()

bool hasLowerCSR ( ) const

inlinenoexcept

Definition at line 803 of file lduMatrix.H.

References Foam::noexcept.

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

Here is the caller graph for this function:

◆ lowerCSR() [1/2]

const Foam::scalarField & lowerCSR ( ) const

Definition at line 376 of file lduMatrix.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lowerCSR() [2/2]

Foam::scalarField & lowerCSR ( )

Definition at line 404 of file lduMatrix.C.

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

Here is the call graph for this function:

◆ work() [1/2]

const Foam::solveScalarField & work ( ) const

Work array.

Definition at line 443 of file lduMatrix.C.

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

Here is the call graph for this function:

◆ work() [2/2]

Foam::solveScalarField & work ( label size ) const

Work array.

Definition at line 432 of file lduMatrix.C.

◆ matrixTypeName()

Foam::word matrixTypeName ( ) const

The matrix type (empty, diagonal, symmetric, ...).

Definition at line 178 of file lduMatrix.C.

Referenced by operator+=(), and operator-=().

Here is the caller graph for this function:

◆ hasDiag()

bool hasDiag ( ) const

inlinenoexcept

Definition at line 827 of file lduMatrix.H.

References Foam::noexcept.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ hasUpper()

bool hasUpper ( ) const

inlinenoexcept

Definition at line 828 of file lduMatrix.H.

References Foam::noexcept.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ hasLower()

bool hasLower ( ) const

inlinenoexcept

Definition at line 829 of file lduMatrix.H.

References Foam::noexcept.

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

Here is the caller graph for this function:

◆ diagonal()

bool diagonal ( ) const

inlinenoexcept

Matrix has diagonal only.

Definition at line 834 of file lduMatrix.H.

References Foam::noexcept.

Referenced by operator+=(), and operator-=().

Here is the caller graph for this function:

◆ symmetric()

bool symmetric ( ) const

inlinenoexcept

Matrix is symmetric.

Definition at line 842 of file lduMatrix.H.

References Foam::noexcept.

Referenced by lduMatrix::preconditioner::New(), operator*=(), operator+=(), operator-=(), faMatrix< Type >::setValuesFromList(), and fvMatrix< Type >::setValuesFromList().

Here is the caller graph for this function:

◆ asymmetric()

bool asymmetric ( ) const

inlinenoexcept

Matrix is asymmetric (ie, full).

Definition at line 850 of file lduMatrix.H.

References Foam::noexcept.

Referenced by cyclicACMIFvPatchField< Type >::manipulateMatrix(), cyclicAMIFvPatchField< Type >::manipulateMatrix(), mixedEnergyFvPatchScalarField::manipulateMatrix(), lduMatrix::preconditioner::New(), operator*=(), operator+=(), operator-=(), faMatrix< Type >::setValuesFromList(), fvMatrix< Type >::setValuesFromList(), fvMatrix< scalar >::solveSegregated(), fvMatrix< Type >::transferFvMatrixCoeffs(), and cyclicFvPatchField< scalar >::write().

Here is the caller graph for this function:

◆ sumDiag()

void sumDiag ( )

Definition at line 30 of file lduMatrixOperations.C.

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

Here is the call graph for this function:

◆ negSumDiag()

void negSumDiag ( )

Definition at line 47 of file lduMatrixOperations.C.

References Foam::diag(), lduAddr(), lduMatrix(), and UList< T >::size().

Here is the call graph for this function:

◆ sumMagOffDiag()

void sumMagOffDiag ( scalarField & sumOff ) const

Definition at line 64 of file lduMatrixOperations.C.

References lduAddr(), lduMatrix(), Foam::mag(), and UList< T >::size().

Referenced by faMatrix< Type >::relax(), and fvMatrix< Type >::relax().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Amul()

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

Matrix multiplication with updated interfaces.

Definition at line 31 of file lduMatrixATmul.C.

References UList< T >::begin(), tmp< T >::clear(), diag(), Foam::endl(), hasLowerCSR(), initMatrixInterfaces(), lduAddr(), lower(), lowerCSR(), UPstream::nRequests(), PoutInFunction, psi, UList< T >::size(), updateMatrixInterfaces(), and upper().

Here is the call graph for this function:

◆ Tmul()

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

Matrix transpose multiplication with updated interfaces.

Definition at line 149 of file lduMatrixATmul.C.

References UList< T >::begin(), tmp< T >::clear(), Foam::diag(), initMatrixInterfaces(), lduAddr(), lower(), UPstream::nRequests(), psi, updateMatrixInterfaces(), and upper().

Here is the call graph for this function:

◆ sumA()

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

Sum the coefficients on each row of the matrix.

Definition at line 213 of file lduMatrixATmul.C.

References Foam::diag(), forAll, lduAddr(), lower(), UPtrList< T >::set(), sumA(), and upper().

Referenced by sumA().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ residual() [1/2]

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

Definition at line 262 of file lduMatrixATmul.C.

References UList< T >::begin(), Foam::diag(), initMatrixInterfaces(), lduAddr(), lower(), UPstream::nRequests(), psi, updateMatrixInterfaces(), and upper().

Referenced by faMatrix< Type >::residual(), faMatrix< scalar >::residual(), fvMatrix< Type >::residual(), fvMatrix< scalar >::residual(), residual(), and setResidualField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ residual() [2/2]

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

Definition at line 337 of file lduMatrixATmul.C.

References tmp< T >::New(), psi, and residual().

Here is the call graph for this function:

◆ initMatrixInterfaces()

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

Initialise the update of interfaced interfaces for matrix operations.

Definition at line 26 of file lduMatrixUpdateMatrixInterfaces.C.

References Foam::add(), UPstream::buffered, UPstream::commsTypeNames, UPstream::defaultCommsType, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, lduAddr(), mesh(), UPstream::nonBlocking, patchSchedule(), UPstream::scheduled, UPtrList< T >::set(), and UPtrList< T >::size().

Referenced by Amul(), residual(), faMatrix< Type >::solve(), fvMatrix< Type >::solveSegregated(), and Tmul().

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, scalar > &	interfaceCoeffs,
		const lduInterfaceFieldPtrsList &	interfaces,
		const solveScalarField &	psiif,
		solveScalarField &	result,
		const direction	cmpt,
		const label	startRequest ) const

Update interfaced interfaces for matrix operations.

Definition at line 101 of file lduMatrixUpdateMatrixInterfaces.C.

References Foam::add(), UPstream::buffered, UPstream::commsTypeNames, UPstream::defaultCommsType, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, UPtrList< T >::get(), lduAddr(), mesh, UPstream::nonBlocking, UPstream::nPollProcInterfaces, patchSchedule(), UPstream::scheduled, UPtrList< T >::set(), UPtrList< T >::size(), UPstream::waitRequests(), and UPstream::waitSomeRequests().

Referenced by Amul(), residual(), faMatrix< Type >::solve(), fvMatrix< Type >::solveSegregated(), and Tmul().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setResidualField()

void setResidualField	(	const scalarField &	residual,
		const word &	fieldName,
		const bool	initial ) const

Set the residual field using an IOField on the object registry if it exists.

Definition at line 456 of file lduMatrix.C.

References DebugInfo, Foam::endl(), objectRegistry::findObject(), objectRegistry::getObjectPtr(), mesh, residual(), IOobject::scopedName(), and fvMesh::thisDb().

Referenced by GAMGSolver::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ H() [1/4]

template<class Type>

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

Referenced by faMatrix< Type >::H(), faMatrix< scalar >::H(), fvMatrix< Type >::H(), and fvMatrix< scalar >::H().

Here is the caller graph for this function:

◆ H() [2/4]

template<class Type>

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

◆ H1()

Foam::tmp< Foam::scalarField > H1 ( ) const

Definition at line 352 of file lduMatrixATmul.C.

References lduAddr(), lower(), tmp< T >::New(), upper(), and Foam::Zero.

Referenced by fvMatrix< Type >::H1(), and fvMatrix< scalar >::H1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ faceH() [1/4]

template<class Type>

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

Referenced by faceH(), faMatrix< Type >::flux(), and fvMatrix< Type >::flux().

Here is the caller graph for this function:

◆ faceH() [2/4]

template<class Type>

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

◆ info()

InfoProxy< lduMatrix > info ( ) const

inlinenoexcept

Return info proxy, used to print matrix information to a stream.

Definition at line 979 of file lduMatrix.H.

References Foam::noexcept.

◆ operator=() [1/2]

void operator= ( const lduMatrix & A )

Copy assignment.

Definition at line 85 of file lduMatrixOperations.C.

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

Referenced by faMatrix< Type >::operator=(), and fvMatrix< Type >::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/2]

void operator= ( lduMatrix && A )

Move assignment.

Definition at line 117 of file lduMatrixOperations.C.

References A, and lduMatrix().

Here is the call graph for this function:

◆ negate()

void negate ( )

Definition at line 130 of file lduMatrixOperations.C.

Referenced by faMatrix< Type >::negate(), and fvMatrix< Type >::negate().

Here is the caller graph for this function:

◆ operator+=()

void operator+= ( const lduMatrix & A )

Definition at line 149 of file lduMatrixOperations.C.

References A, asymmetric(), Foam::diag(), diagonal(), Foam::endl(), lduMatrix(), lower(), matrixTypeName(), Foam::nl, symmetric(), upper(), and WarningInFunction.

Referenced by faMatrix< Type >::operator+=(), and fvMatrix< Type >::operator+=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator-=()

void operator-= ( const lduMatrix & A )

Definition at line 221 of file lduMatrixOperations.C.

References A, asymmetric(), Foam::diag(), diagonal(), Foam::endl(), lduMatrix(), lower(), matrixTypeName(), Foam::nl, symmetric(), upper(), and WarningInFunction.

Referenced by faMatrix< Type >::operator-=(), and fvMatrix< Type >::operator-=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator*=() [1/2]

void operator*= ( const scalarField & sf )

Definition at line 293 of file lduMatrixOperations.C.

References asymmetric(), lduAddr(), lower(), symmetric(), and upper().

Referenced by faMatrix< Type >::operator*=(), faMatrix< Type >::operator*=(), fvMatrix< Type >::operator*=(), and fvMatrix< Type >::operator*=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator*=() [2/2]

void operator*= ( scalar s )

Definition at line 323 of file lduMatrixOperations.C.

References s().

Here is the call graph for this function:

◆ H() [3/4]

template<class Type>

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

Definition at line 30 of file lduMatrixTemplates.C.

References UList< T >::begin(), lduAddr(), lower(), lduAddressing::lowerAddr(), Foam::New(), psi, UList< T >::size(), upper(), and lduAddressing::upperAddr().

Here is the call graph for this function:

◆ H() [4/4]

template<class Type>

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

Definition at line 60 of file lduMatrixTemplates.C.

References H().

Here is the call graph for this function:

◆ faceH() [3/4]

template<class Type>

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

Definition at line 70 of file lduMatrixTemplates.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, lduAddr(), lduMatrix(), Foam::New(), psi, and UList< T >::size().

Here is the call graph for this function:

◆ faceH() [4/4]

template<class Type>

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

Definition at line 104 of file lduMatrixTemplates.C.

References faceH().

Here is the call graph for this function:

◆ operator<< [1/2]

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

friend

References lduMatrix().

◆ operator<< [2/2]

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

friend

Member Data Documentation

◆ normTypesNames_

const Foam::Enum< Foam::lduMatrix::normTypes > normTypesNames_

static

Names for the normTypes.

Definition at line 134 of file lduMatrix.H.

Referenced by LduMatrix< Type, DType, LUType >::solver::readControls(), and lduMatrix::solver::readControls().

◆ defaultMaxIter

const label defaultMaxIter = 1000

staticconstexpr

Default maximum number of iterations for solvers (1000).

Definition at line 139 of file lduMatrix.H.

Referenced by lduMatrix::solver::readControls(), PBiCG::solve(), and lduMatrix::solver::solver().

◆ defaultTolerance

const Foam::scalar defaultTolerance = 1e-6

static

Default (absolute) tolerance (1e-6).

Definition at line 144 of file lduMatrix.H.

Referenced by lduMatrix::solver::readControls(), and lduMatrix::solver::solver().

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

src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrix.H
src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrix.C
src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrixATmul.C
src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrixOperations.C
src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrixTemplates.C
src/OpenFOAM/matrices/lduMatrix/lduMatrix/lduMatrixUpdateMatrixInterfaces.C

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ normTypes

Constructor & Destructor Documentation

◆ lduMatrix() [1/5]

◆ lduMatrix() [2/5]

◆ lduMatrix() [3/5]

◆ lduMatrix() [4/5]

◆ lduMatrix() [5/5]

◆ ~lduMatrix()

Member Function Documentation

◆ ClassName()

◆ mesh()

◆ setLduMesh()

◆ lduAddr()

◆ patchSchedule()

◆ diag() [1/3]

◆ upper() [1/3]

◆ lower() [1/3]

◆ diag() [2/3]

◆ upper() [2/3]

◆ lower() [2/3]

◆ diag() [3/3]

◆ upper() [3/3]

◆ lower() [3/3]

◆ hasLowerCSR()

◆ lowerCSR() [1/2]

◆ lowerCSR() [2/2]

◆ work() [1/2]

◆ work() [2/2]

◆ matrixTypeName()

◆ hasDiag()

◆ hasUpper()

◆ hasLower()

◆ diagonal()

◆ symmetric()

◆ asymmetric()

◆ sumDiag()

◆ negSumDiag()

◆ sumMagOffDiag()

◆ Amul()

◆ Tmul()

◆ sumA()

◆ residual() [1/2]

◆ residual() [2/2]

◆ initMatrixInterfaces()

◆ updateMatrixInterfaces()

◆ setResidualField()

◆ H() [1/4]

◆ H() [2/4]

◆ H1()

◆ faceH() [1/4]

◆ faceH() [2/4]

◆ info()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ negate()

◆ operator+=()

◆ operator-=()

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ H() [3/4]

◆ H() [4/4]

◆ faceH() [3/4]

◆ faceH() [4/4]

Friends And Related Symbol Documentation

◆ operator<< [1/2]

◆ operator<< [2/2]

Member Data Documentation

◆ normTypesNames_

◆ defaultMaxIter

◆ defaultTolerance