A special matrix type and solver, designed for finite volume solutions of scalar equations. Face addressing is used to make all matrix assembly and solution loops vectorise. More...

Inheritance diagram for fvMatrix< Type >:

[legend]

Collaboration diagram for fvMatrix< Type >:

[legend]

Classes
class	fvSolver
	Solver class returned by the solver function used for systems in which it is useful to cache the solver for reuse. More...

Public Types
typedef GeometricField< Type, fvPatchField, volMesh >	psiFieldType
	The geometric field type for psi. More...

typedef GeometricField< Type, fvsPatchField, surfaceMesh >	faceFluxFieldType
	Field type for face flux (for non-orthogonal correction) More...

typedef std::unique_ptr< faceFluxFieldType >	faceFluxFieldPtrType
	Declare return type of the faceFluxCorrectionPtr() function. More...

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

Public Member Functions
	ClassName ("fvMatrix")

	fvMatrix (const GeometricField< Type, fvPatchField, volMesh > &psi, const dimensionSet &ds)
	Construct given a field to solve for. More...

	fvMatrix (const fvMatrix< Type > &)
	Copy construct. More...

	fvMatrix (const tmp< fvMatrix< Type >> &)
	Copy/move construct from tmp<fvMatrix<Type>> More...

	fvMatrix (const GeometricField< Type, fvPatchField, volMesh > &psi, Istream &is)
	Deprecated(2022-05) - construct with dimensionSet instead. More...

tmp< fvMatrix< Type > >	clone () const
	Construct and return a clone. More...

virtual	~fvMatrix ()
	Destructor. More...

label	nMatrices () const

const fvMatrix< Type > &	matrix (const label i) const

fvMatrix< Type > &	matrix (const label i)

label	globalPatchID (const label fieldi, const label patchi) const

void	transferFvMatrixCoeffs ()
	Transfer lower, upper, diag and source to this fvMatrix. More...

void	createOrUpdateLduPrimitiveAssembly ()
	Create or update ldu assembly. More...

lduPrimitiveMeshAssembly *	lduMeshPtr ()
	Access to lduPrimitiveMeshAssembly. More...

const lduPrimitiveMeshAssembly *	lduMeshPtr () const
	Const Access to lduPrimitiveMeshAssembly. More...

void	manipulateMatrix (direction cmp)
	Manipulate matrix. More...

void	setBounAndInterCoeffs ()
	Manipulate boundary/internal coeffs for coupling. More...

void	setInterfaces (lduInterfaceFieldPtrsList &, PtrDynList< lduInterfaceField > &newInterfaces)
	Set interfaces. More...

void	mapContributions (label fieldi, const FieldField< Field, Type > &fluxContrib, FieldField< Field, Type > &contrib, bool internal) const
	Add internal and boundary contribution to local patches. More...

const lduPrimitiveMeshAssembly &	lduMeshAssembly ()
	Return optional lduAdressing. More...

const GeometricField< Type, fvPatchField, volMesh > &	psi (const label i=0) const
	Return psi. More...

GeometricField< Type, fvPatchField, volMesh > &	psi (const label i=0)

void	clear ()
	Clear multiple fvMatrices. More...

const dimensionSet &	dimensions () const noexcept

Field< Type > &	source () noexcept

const Field< Type > &	source () const noexcept

const FieldField< Field, Type > &	internalCoeffs () const noexcept
	fvBoundary scalar field containing pseudo-matrix coeffs for internal cells More...

FieldField< Field, Type > &	internalCoeffs () noexcept
	fvBoundary scalar field containing pseudo-matrix coeffs for internal cells More...

const FieldField< Field, Type > &	boundaryCoeffs () const noexcept
	fvBoundary scalar field containing pseudo-matrix coeffs for boundary cells More...

FieldField< Field, Type > &	boundaryCoeffs () noexcept
	fvBoundary scalar field containing pseudo-matrix coeffs for boundary cells More...

faceFluxFieldPtrType &	faceFluxCorrectionPtr ()
	Return pointer to face-flux non-orthogonal correction field. More...

void	faceFluxCorrectionPtr (faceFluxFieldType *flux)
	Set pointer to face-flux non-orthogonal correction field. More...

bool	hasFaceFluxCorrection () const noexcept
	True if face-flux non-orthogonal correction field exists. More...

void	setValues (const labelUList &cellLabels, const Type &value)
	Set solution in given cells to the specified value and eliminate the corresponding equations from the matrix. More...

void	setValues (const labelUList &cellLabels, const UList< Type > &values)
	Set solution in given cells to the specified values and eliminate the corresponding equations from the matrix. More...

void	setValues (const labelUList &cellLabels, const UIndirectList< Type > &values)
	Set solution in given cells to the specified values and eliminate the corresponding equations from the matrix. More...

void	setReference (const label celli, const Type &value, const bool forceReference=false)
	Set reference level for solution. More...

void	setReferences (const labelUList &cellLabels, const Type &value, const bool forceReference=false)
	Set reference level for solution. More...

void	setReferences (const labelUList &cellLabels, const UList< Type > &values, const bool forceReference=false)
	Set reference level for solution. More...

void	setComponentReference (const label patchi, const label facei, const direction cmpt, const scalar value)
	Set reference level for a component of the solution on a given patch face. More...

void	addFvMatrix (fvMatrix< Type > &matrix)
	Add fvMatrix. More...

void	relax (const scalar alpha)
	Relax matrix (for steady-state solution). More...

void	relax ()
	Relax matrix (for steady-state solution). More...

void	boundaryManipulate (typename GeometricField< Type, fvPatchField, volMesh >::Boundary &values)
	Manipulate based on a boundary field. More...

autoPtr< fvSolver >	solver (const dictionary &)
	Construct and return the solver. More...

autoPtr< fvSolver >	solver ()
	Construct and return the solver. More...

SolverPerformance< Type >	solveSegregatedOrCoupled (const dictionary &)
	Solve segregated or coupled returning the solution statistics. More...

SolverPerformance< Type >	solveSegregatedOrCoupled ()
	Solve segregated or coupled returning the solution statistics. More...

SolverPerformance< Type >	solveSegregated (const dictionary &)
	Solve segregated returning the solution statistics. More...

SolverPerformance< Type >	solveCoupled (const dictionary &)
	Solve coupled returning the solution statistics. More...

SolverPerformance< Type >	solve (const dictionary &)
	Solve returning the solution statistics. More...

SolverPerformance< Type >	solve (const word &name)
	Solve returning the solution statistics. More...

SolverPerformance< Type >	solve ()
	Solve returning the solution statistics. More...

tmp< Field< Type > >	residual () const
	Return the matrix residual. More...

tmp< scalarField >	D () const
	Return the matrix scalar diagonal. More...

tmp< Field< Type > >	DD () const
	Return the matrix Type diagonal. More...

tmp< volScalarField >	A () const
	Return the central coefficient. More...

tmp< GeometricField< Type, fvPatchField, volMesh > >	H () const
	Return the H operation source. More...

tmp< volScalarField >	H1 () const
	Return H(1) More...

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	flux () const
	Return the face-flux field from the matrix. More...

const dictionary &	solverDict (const word &name) const
	Return the solver dictionary (from fvSolution) for `name`. More...

const dictionary &	solverDict () const
	Return the solver dictionary for psi, taking into account finalIteration. More...

void	operator= (const fvMatrix< Type > &)

void	operator= (const tmp< fvMatrix< Type >> &)

void	negate ()
	Inplace negate. More...

void	operator+= (const fvMatrix< Type > &)

void	operator+= (const tmp< fvMatrix< Type >> &)

void	operator-= (const fvMatrix< Type > &)

void	operator-= (const tmp< fvMatrix< Type >> &)

void	operator+= (const DimensionedField< Type, volMesh > &)

void	operator+= (const tmp< DimensionedField< Type, volMesh >> &)

void	operator+= (const tmp< GeometricField< Type, fvPatchField, volMesh >> &)

void	operator-= (const DimensionedField< Type, volMesh > &)

void	operator-= (const tmp< DimensionedField< Type, volMesh >> &)

void	operator-= (const tmp< GeometricField< Type, fvPatchField, volMesh >> &)

void	operator+= (const dimensioned< Type > &)

void	operator-= (const dimensioned< Type > &)

void	operator+= (const Foam::zero)

void	operator-= (const Foam::zero)

void	operator*= (const volScalarField::Internal &)

void	operator*= (const tmp< volScalarField::Internal > &)

void	operator*= (const tmp< volScalarField > &)

void	operator*= (const dimensioned< scalar > &)

template<>
void	setComponentReference (const label patchi, const label facei, const direction, const scalar value)

template<>
Foam::autoPtr< Foam::fvMatrix< Foam::scalar >::fvSolver >	solver (const dictionary &solverControls)

template<>
Foam::solverPerformance	solveSegregated (const dictionary &solverControls)

template<>
Foam::tmp< Foam::scalarField >	residual () const

template<>
Foam::tmp< Foam::volScalarField >	H () const

template<>
Foam::tmp< Foam::volScalarField >	H1 () const

template<>
void	setComponentReference (const label patchi, const label facei, const direction, const scalar value)

template<>
autoPtr< fvMatrix< scalar >::fvSolver >	solver (const dictionary &)

template<>
solverPerformance	solveSegregated (const dictionary &)

template<>
tmp< scalarField >	residual () const

template<>
tmp< volScalarField >	H () const

template<>
tmp< volScalarField >	H1 () const

Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...

int	use_count () const noexcept
	Return the current reference count. More...

bool	unique () const noexcept
	Return true if the reference count is zero. More...

void	operator++ () noexcept
	Increment the reference count. More...

void	operator++ (int) noexcept
	Increment the reference count. More...

void	operator-- () noexcept
	Decrement the reference count. More...

void	operator-- (int) noexcept
	Decrement the reference count. More...

Public Member Functions inherited from lduMatrix
	ClassName ("lduMatrix")

	lduMatrix (const lduMesh &mesh)
	Construct (without coefficients) for an LDU addressed mesh. More...

	lduMatrix (const lduMatrix &)
	Copy construct. More...

	lduMatrix (lduMatrix &&)
	Move construct. More...

	lduMatrix (lduMatrix &, bool reuse)
	Construct as copy or re-use as specified. More...

	lduMatrix (const lduMesh &mesh, Istream &is)
	Construct given an LDU addressed mesh and an Istream from which the coefficients are read. More...

	~lduMatrix ()=default
	Destructor. More...

const lduMesh &	mesh () const noexcept
	Return the LDU mesh from which the addressing is obtained. More...

void	setLduMesh (const lduMesh &m)
	Set the LDU mesh containing the addressing. More...

const lduAddressing &	lduAddr () const
	Return the LDU addressing. More...

const lduSchedule &	patchSchedule () const
	Return the patch evaluation schedule. More...

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

solveScalarField &	work (label size) const
	Work array. More...

word	matrixTypeName () const
	The matrix type (empty, diagonal, symmetric, ...) More...

bool	hasDiag () const noexcept

bool	hasUpper () const noexcept

bool	hasLower () const noexcept

bool	diagonal () const noexcept
	Matrix has diagonal only. More...

bool	symmetric () const noexcept
	Matrix is symmetric. More...

bool	asymmetric () const noexcept
	Matrix is asymmetric (ie, full) More...

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

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

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

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

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

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. 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 noexcept
	Return info proxy, used to print matrix information to a stream. More...

void	operator= (const lduMatrix &)
	Copy assignment. More...

void	operator= (lduMatrix &&)
	Move assignment. More...

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

Protected Member Functions
template<class Type2 >
void	addToInternalField (const labelUList &addr, const Field< Type2 > &pf, Field< Type2 > &intf) const
	Add patch contribution to internal field. More...

template<class Type2 >
void	addToInternalField (const labelUList &addr, const tmp< Field< Type2 >> &tpf, Field< Type2 > &intf) const

template<class Type2 >
void	subtractFromInternalField (const labelUList &addr, const Field< Type2 > &pf, Field< Type2 > &intf) const
	Subtract patch contribution from internal field. More...

template<class Type2 >
void	subtractFromInternalField (const labelUList &addr, const tmp< Field< Type2 >> &tpf, Field< Type2 > &intf) const

bool	checkImplicit (const label fieldi=0)
	Name the implicit assembly addressing. More...

void	addBoundaryDiag (scalarField &diag, const direction cmpt) const

void	addCmptAvBoundaryDiag (scalarField &diag) const

void	addBoundarySource (Field< Type > &source, const bool couples=true) const

template<template< class > class ListType>
void	setValuesFromList (const labelUList &cellLabels, const ListType< Type > &values)
	Set solution in given cells to the specified values. More...

Friends
class	fvSolver
	Declare friendship with the fvSolver class. More...

tmp< GeometricField< Type, fvPatchField, volMesh > >	operator & (const fvMatrix< Type > &, const DimensionedField< Type, volMesh > &)

tmp< GeometricField< Type, fvPatchField, volMesh > >	operator & (const fvMatrix< Type > &, const tmp< GeometricField< Type, fvPatchField, volMesh >> &)

tmp< GeometricField< Type, fvPatchField, volMesh > >	operator & (const tmp< fvMatrix< Type >> &, const DimensionedField< Type, volMesh > &)

tmp< GeometricField< Type, fvPatchField, volMesh > >	operator & (const tmp< fvMatrix< Type >> &, const tmp< GeometricField< Type, fvPatchField, volMesh >> &)

Ostream &	operator (Ostream &, const fvMatrix< Type > &)

Additional Inherited Members
Static Public Attributes inherited from lduMatrix
static const Enum< normTypes >	normTypesNames_
	Names for the normTypes. More...

static constexpr const label	defaultMaxIter = 1000
	Default maximum number of iterations for solvers (1000) More...

static const scalar	defaultTolerance = 1e-6
	Default (absolute) tolerance (1e-6) More...

Detailed Description

template<class Type>
class Foam::fvMatrix< Type >

A special matrix type and solver, designed for finite volume solutions of scalar equations. Face addressing is used to make all matrix assembly and solution loops vectorise.

Source files

Definition at line 64 of file fvPatchField.H.

Member Typedef Documentation

◆ psiFieldType

typedef GeometricField<Type, fvPatchField, volMesh> psiFieldType

The geometric field type for psi.

Definition at line 126 of file fvMatrix.H.

◆ faceFluxFieldType

typedef GeometricField<Type, fvsPatchField, surfaceMesh> faceFluxFieldType

Field type for face flux (for non-orthogonal correction)

Definition at line 133 of file fvMatrix.H.

◆ faceFluxFieldPtrType

typedef std::unique_ptr<faceFluxFieldType> faceFluxFieldPtrType

Declare return type of the faceFluxCorrectionPtr() function.

Definition at line 582 of file fvMatrix.H.

Constructor & Destructor Documentation

◆ fvMatrix() [1/4]

fvMatrix	(	const GeometricField< Type, fvPatchField, volMesh > &	psi,
		const dimensionSet &	ds
	)

Construct given a field to solve for.

Definition at line 351 of file fvMatrix.C.

References DebugInFunction, Foam::endl(), forAll, psi, and Foam::Zero.

Here is the call graph for this function:

◆ fvMatrix() [2/4]

fvMatrix ( const fvMatrix< Type > & fvm )

Copy construct.

Definition at line 394 of file fvMatrix.C.

References DebugInFunction, Foam::endl(), and IOobject::name().

Here is the call graph for this function:

◆ fvMatrix() [3/4]

fvMatrix ( const tmp< fvMatrix< Type >> & tmat )

Copy/move construct from tmp<fvMatrix<Type>>

Definition at line 420 of file fvMatrix.C.

References DebugInFunction, Foam::endl(), and IOobject::name().

Here is the call graph for this function:

◆ fvMatrix() [4/4]

fvMatrix	(	const GeometricField< Type, fvPatchField, volMesh > &	psi,
		Istream &	is
	)

inline

Deprecated(2022-05) - construct with dimensionSet instead.

Deprecated:: (2022-05) - construct with dimensionSet instead

Definition at line 363 of file fvMatrix.H.

◆ ~fvMatrix()

~fvMatrix ( )

virtual

Destructor.

Definition at line 458 of file fvMatrix.C.

References DebugInFunction, and Foam::endl().

Here is the call graph for this function:

Member Function Documentation

◆ addToInternalField() [1/2]

void addToInternalField	(	const labelUList &	addr,
		const Field< Type2 > &	pf,
		Field< Type2 > &	intf
	)		const

protected

Add patch contribution to internal field.

Definition at line 41 of file fvMatrix.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, UList< T >::size(), and UList< Type >::size().

Here is the call graph for this function:

◆ addToInternalField() [2/2]

void addToInternalField	(	const labelUList &	addr,
		const tmp< Field< Type2 >> &	tpf,
		Field< Type2 > &	intf
	)		const

protected

Definition at line 65 of file fvMatrix.C.

◆ subtractFromInternalField() [1/2]

void subtractFromInternalField	(	const labelUList &	addr,
		const Field< Type2 > &	pf,
		Field< Type2 > &	intf
	)		const

protected

Subtract patch contribution from internal field.

Definition at line 79 of file fvMatrix.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, UList< T >::size(), and UList< Type >::size().

Here is the call graph for this function:

◆ subtractFromInternalField() [2/2]

void subtractFromInternalField	(	const labelUList &	addr,
		const tmp< Field< Type2 >> &	tpf,
		Field< Type2 > &	intf
	)		const

protected

Definition at line 103 of file fvMatrix.C.

◆ checkImplicit()

bool checkImplicit ( const label fieldi = 0 )

protected

Name the implicit assembly addressing.

Returns: true if assembly is used

Definition at line 314 of file fvMatrix.C.

References Foam::ensightOutput::debug, Foam::endl(), forAll, Foam::name(), Foam::Pout, and psi.

Here is the call graph for this function:

◆ addBoundaryDiag()

void addBoundaryDiag	(	scalarField &	diag,
		const direction	cmpt
	)		const

protected

Definition at line 116 of file fvMatrix.C.

References Foam::component(), Foam::diag(), forAll, and psi.

Referenced by fvMatrix< Type >::residual().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCmptAvBoundaryDiag()

void addCmptAvBoundaryDiag ( scalarField & diag ) const

protected

Definition at line 144 of file fvMatrix.C.

References Foam::cmptAv(), Foam::diag(), forAll, and psi.

Here is the call graph for this function:

◆ addBoundarySource()

void addBoundarySource	(	Field< Type > &	source,
		const bool	couples = `true`
	)		const

protected

Definition at line 169 of file fvMatrix.C.

References Foam::cmptMultiply(), fvPatchFieldBase::coupled(), forAll, fvPatchField< Type >::patchNeighbourField(), and psi.

Referenced by fvMatrix< Type >::residual().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValuesFromList()

void setValuesFromList	(	const labelUList &	cellLabels,
		const ListType< Type > &	values
	)

protected

Set solution in given cells to the specified values.

Definition at line 219 of file fvMatrix.C.

References cells, Foam::diag(), forAll, Foam::stringOps::lower(), mesh, primitiveFieldRef(), psi, Foam::stringOps::upper(), Foam::HashTableOps::values(), and Foam::Zero.

Here is the call graph for this function:

◆ ClassName()

ClassName ( "fvMatrix< Type >" )

◆ clone()

tmp<fvMatrix<Type> > clone ( ) const

inline

Construct and return a clone.

Definition at line 374 of file fvMatrix.H.

References Foam::New().

Referenced by fvMatrix< Type >::addFvMatrix().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nMatrices()

label nMatrices ( ) const

inline

Definition at line 392 of file fvMatrix.H.

◆ matrix() [1/2]

const fvMatrix<Type>& matrix ( const label i ) const

inline

Definition at line 397 of file fvMatrix.H.

Referenced by fvMatrix< Type >::psi().

Here is the caller graph for this function:

◆ matrix() [2/2]

fvMatrix<Type>& matrix ( const label i )

inline

Definition at line 402 of file fvMatrix.H.

◆ globalPatchID()

label globalPatchID	(	const label	fieldi,
		const label	patchi
	)		const

inline

Definition at line 408 of file fvMatrix.H.

References fvMatrix< Type >::lduMeshPtr(), and lduPrimitiveMeshAssembly::patchMap().

Here is the call graph for this function:

◆ transferFvMatrixCoeffs()

void transferFvMatrixCoeffs ( )

Transfer lower, upper, diag and source to this fvMatrix.

Definition at line 814 of file fvMatrix.C.

References Foam::diag(), Foam::faceMap(), forAll, Foam::stringOps::lower(), List< Type >::setSize(), UList< T >::size(), Foam::stringOps::upper(), and Foam::Zero.

Here is the call graph for this function:

◆ createOrUpdateLduPrimitiveAssembly()

void createOrUpdateLduPrimitiveAssembly ( )

Create or update ldu assembly.

Definition at line 907 of file fvMatrix.C.

References lduAddressing::clearOut(), Foam::endl(), Foam::Info, io(), lduPrimitiveMesh::lduAddr(), DimensionedField< Type, GeoMesh >::mesh(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, psi, IOobjectOption::REGISTER, UPtrList< T >::set(), regIOobject::store(), and lduPrimitiveMeshAssembly::update().

Here is the call graph for this function:

◆ lduMeshPtr() [1/2]

Foam::lduPrimitiveMeshAssembly * lduMeshPtr ( )

Access to lduPrimitiveMeshAssembly.

Definition at line 881 of file fvMatrix.C.

Referenced by fvMatrix< Type >::globalPatchID(), and fvMatrix< Type >::lduMeshAssembly().

Here is the caller graph for this function:

◆ lduMeshPtr() [2/2]

const Foam::lduPrimitiveMeshAssembly * lduMeshPtr ( ) const

Const Access to lduPrimitiveMeshAssembly.

Definition at line 894 of file fvMatrix.C.

◆ manipulateMatrix()

void manipulateMatrix ( direction cmp )

Manipulate matrix.

Definition at line 791 of file fvMatrix.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), forAll, and psi.

Here is the call graph for this function:

◆ setBounAndInterCoeffs()

void setBounAndInterCoeffs ( )

Manipulate boundary/internal coeffs for coupling.

Definition at line 661 of file fvMatrix.C.

References boundary, GeometricField< Type, PatchField, GeoMesh >::boundaryField(), forAll, DimensionedField< Type, GeoMesh >::mesh(), psi, List< T >::set(), and Foam::Zero.

Here is the call graph for this function:

◆ setInterfaces()

void setInterfaces	(	lduInterfaceFieldPtrsList &	interfaces,
		PtrDynList< lduInterfaceField > &	newInterfaces
	)

Set interfaces.

Definition at line 471 of file fvMatrix.C.

References PtrDynList< T, SizeMin >::append(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), forAll, UPtrList< T >::last(), psi, UPtrList< T >::set(), and UPtrList< T >::setSize().

Here is the call graph for this function:

◆ mapContributions()

void mapContributions	(	label	fieldi,
		const FieldField< Field, Type > &	fluxContrib,
		FieldField< Field, Type > &	contrib,
		bool	internal
	)		const

Add internal and boundary contribution to local patches.

Definition at line 549 of file fvMatrix.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), lduPrimitiveMeshAssembly::cellBoundMap(), cellId, Foam::cmptMultiply(), faceId(), lduPrimitiveMeshAssembly::facePatchFaceMap(), forAll, DimensionedField< Type, GeoMesh >::mesh(), lduPrimitiveMeshAssembly::patchLocalToGlobalMap(), lduPrimitiveMeshAssembly::patchMap(), pp(), psi, List< Type >::setSize(), and PtrList< Field< Type > >::setSize().

Here is the call graph for this function:

◆ lduMeshAssembly()

const lduPrimitiveMeshAssembly& lduMeshAssembly ( )

inline

Return optional lduAdressing.

Definition at line 476 of file fvMatrix.H.

References fvMatrix< Type >::lduMeshPtr().

Referenced by mixedEnergyFvPatchScalarField::manipulateMatrix(), cyclicFvPatchField< vector >::manipulateMatrix(), cyclicACMIFvPatchField< Type >::manipulateMatrix(), and cyclicAMIFvPatchField< scalar >::manipulateMatrix().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ psi() [1/2]

const GeometricField<Type, fvPatchField, volMesh>& psi ( const label i = 0 ) const

inline

Return psi.

Definition at line 485 of file fvMatrix.H.

References fvMatrix< Type >::matrix().

Referenced by MRFZone::addCoriolis(), velocityDampingConstraint::addDamping(), oversetFvMeshBase::addInterpolation(), isotropic::addRegularisationTerm(), objectivePowerDissipation::addSource(), objectiveNutSqr::addSource(), objectiveIncompressible::addSource(), radiation::addSup(), topOSource::addSup(), multiphaseMangrovesSource::addSup(), patchCellsSource::addSup(), multiphaseMangrovesTurbulenceModel::addSup(), atmPlantCanopyUSource::addSup(), PhaseLimitStabilization< Type >::addSup(), radialActuationDiskSource::addSup(), explicitPorositySource::addSup(), interRegionExplicitPorositySource::addSup(), atmCoriolisUSource::addSup(), acousticDampingSource::addSup(), multiphaseStabilizedTurbulence::addSup(), interRegionHeatTransferModel::addSup(), jouleHeatingSource::addSup(), SemiImplicitSource< Type >::addSup(), solidificationMeltingSource::addSup(), rotorDiskSource::addSup(), Foam::checkMethod(), optionList::constrain(), oversetFvPatchField< Type >::fringeFlux(), cyclicFvPatchField< vector >::manipulateMatrix(), cyclicACMIFvPatchField< Type >::manipulateMatrix(), cyclicAMIFvPatchField< scalar >::manipulateMatrix(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransfer(), oversetFvMeshBase::normalisation(), Foam::oversetPatchPhiErr(), fvMatrix< Type >::psi(), regularisationPDE::setValues(), oversetFvMeshBase::solveOverset(), and oversetFvMeshBase::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ psi() [2/2]

GeometricField<Type, fvPatchField, volMesh>& psi ( const label i = 0 )

inline

Definition at line 497 of file fvMatrix.H.

References fvMatrix< Type >::matrix(), and fvMatrix< Type >::psi().

Here is the call graph for this function:

◆ clear()

void clear ( )

inline

Clear multiple fvMatrices.

Definition at line 521 of file fvMatrix.H.

References PtrList< T >::clear().

Here is the call graph for this function:

◆ dimensions()

const dimensionSet& dimensions ( ) const

inlinenoexcept

Definition at line 528 of file fvMatrix.H.

Referenced by fvMatrix< Type >::addFvMatrix(), patchCellsSource::addSup(), explicitPorositySource::addSup(), interRegionExplicitPorositySource::addSup(), meanVelocityForce::addSup(), fanMomentumSource::addSup(), SemiImplicitSource< Type >::addSup(), directionalPressureGradientExplicitSource::addSup(), rotorDiskSource::addSup(), Foam::checkMethod(), and fvMatrix< Type >::operator*=().

Here is the caller graph for this function:

◆ source() [1/2]

Field<Type>& source ( )

inlinenoexcept

Definition at line 533 of file fvMatrix.H.

Referenced by MRFZone::addCoriolis(), oversetFvMeshBase::addInterpolation(), radialActuationDiskSource::addSup(), interRegionExplicitPorositySource::addSup(), heatExchangerSource::addSup(), solidificationMeltingSource::addSup(), adjointkOmegaSST::addWallFunctionTerms(), EulerD2dt2Scheme< Type >::fvmD2dt2(), EulerDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), gaussLaplacianScheme< Type, GType >::fvmLaplacian(), fusedGaussLaplacianScheme< Type, GType >::fvmLaplacian(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvmLaplacian(), kaqRWallFunctionFvPatchScalarField::manipulateMatrix(), adjointOutletVelocityFluxFvPatchVectorField::manipulateMatrix(), adjointWallVelocityFvPatchVectorField::manipulateMatrix(), mixedEnergyFvPatchScalarField::manipulateMatrix(), oversetFvMeshBase::solveOverset(), and oversetFvMeshBase::write().

Here is the caller graph for this function:

◆ source() [2/2]

const Field<Type>& source ( ) const

inlinenoexcept

Definition at line 538 of file fvMatrix.H.

◆ internalCoeffs() [1/2]

const FieldField<Field, Type>& internalCoeffs ( ) const

inlinenoexcept

fvBoundary scalar field containing pseudo-matrix coeffs for internal cells

Definition at line 547 of file fvMatrix.H.

Referenced by oversetFvMeshBase::addInterpolation(), gaussConvectionScheme< Type >::fvmDiv(), fusedGaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), fusedGaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), waWallFunctionFvPatchScalarField::manipulateMatrix(), mixedEnergyFvPatchScalarField::manipulateMatrix(), cyclicFvPatchField< vector >::manipulateMatrix(), oversetFvPatchField< Type >::manipulateMatrix(), cyclicACMIFvPatchField< Type >::manipulateMatrix(), cyclicAMIFvPatchField< scalar >::manipulateMatrix(), oversetFvMeshBase::normalisation(), oversetFvMeshBase::solveOverset(), oversetFvPatchField< Type >::storeFringeCoefficients(), and oversetFvMeshBase::write().

Here is the caller graph for this function:

◆ internalCoeffs() [2/2]

FieldField<Field, Type>& internalCoeffs ( )

inlinenoexcept

fvBoundary scalar field containing pseudo-matrix coeffs for internal cells

Definition at line 556 of file fvMatrix.H.

◆ boundaryCoeffs() [1/2]

const FieldField<Field, Type>& boundaryCoeffs ( ) const

inlinenoexcept

fvBoundary scalar field containing pseudo-matrix coeffs for boundary cells

Definition at line 565 of file fvMatrix.H.

Referenced by oversetFvMeshBase::addInterpolation(), gaussConvectionScheme< Type >::fvmDiv(), fusedGaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), fusedGaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), waWallFunctionFvPatchScalarField::manipulateMatrix(), cyclicFvPatchField< vector >::manipulateMatrix(), oversetFvPatchField< Type >::manipulateMatrix(), cyclicACMIFvPatchField< Type >::manipulateMatrix(), cyclicAMIFvPatchField< scalar >::manipulateMatrix(), oversetFvMeshBase::solveOverset(), oversetFvPatchField< Type >::storeFringeCoefficients(), and oversetFvMeshBase::write().

Here is the caller graph for this function:

◆ boundaryCoeffs() [2/2]

FieldField<Field, Type>& boundaryCoeffs ( )

inlinenoexcept

fvBoundary scalar field containing pseudo-matrix coeffs for boundary cells

Definition at line 574 of file fvMatrix.H.

◆ faceFluxCorrectionPtr() [1/2]

faceFluxFieldPtrType& faceFluxCorrectionPtr ( )

inline

Return pointer to face-flux non-orthogonal correction field.

Definition at line 587 of file fvMatrix.H.

Referenced by gaussLaplacianScheme< Type, GType >::fvmLaplacian(), fusedGaussLaplacianScheme< Type, GType >::fvmLaplacian(), and relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvmLaplacian().

Here is the caller graph for this function:

◆ faceFluxCorrectionPtr() [2/2]

void faceFluxCorrectionPtr ( faceFluxFieldType * flux )

inline

Set pointer to face-flux non-orthogonal correction field.

Definition at line 595 of file fvMatrix.H.

◆ hasFaceFluxCorrection()

bool hasFaceFluxCorrection ( ) const

inlinenoexcept

True if face-flux non-orthogonal correction field exists.

Definition at line 603 of file fvMatrix.H.

◆ setValues() [1/3]

void setValues	(	const labelUList &	cellLabels,
		const Type &	value
	)

Set solution in given cells to the specified value and eliminate the corresponding equations from the matrix.

Definition at line 971 of file fvMatrix.C.

Referenced by FixedValueConstraint< Type >::constrain(), fixedTemperatureConstraint::constrain(), MapFieldConstraint< Type >::constrain(), fixedInternalValueFvPatchField< Type >::manipulateMatrix(), omegaWallFunctionFvPatchScalarField::manipulateMatrix(), epsilonWallFunctionFvPatchScalarField::manipulateMatrix(), and regularisationPDE::setValues().

Here is the caller graph for this function:

◆ setValues() [2/3]

void setValues	(	const labelUList &	cellLabels,
		const UList< Type > &	values
	)

Set solution in given cells to the specified values and eliminate the corresponding equations from the matrix.

Definition at line 982 of file fvMatrix.C.

References Foam::HashTableOps::values().

Here is the call graph for this function:

◆ setValues() [3/3]

void setValues	(	const labelUList &	cellLabels,
		const UIndirectList< Type > &	values
	)

Set solution in given cells to the specified values and eliminate the corresponding equations from the matrix.

Definition at line 993 of file fvMatrix.C.

References Foam::HashTableOps::values().

Here is the call graph for this function:

◆ setReference()

void setReference	(	const label	celli,
		const Type &	value,
		const bool	forceReference = `false`
	)

Set reference level for solution.

Definition at line 1004 of file fvMatrix.C.

References Foam::diag().

Referenced by Foam::CorrectPhi(), adjointSimple::mainIter(), and simple::mainIter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setReferences() [1/2]

void setReferences	(	const labelUList &	cellLabels,
		const Type &	value,
		const bool	forceReference = `false`
	)

Set reference level for solution.

Definition at line 1020 of file fvMatrix.C.

References cellId, Foam::diag(), and forAll.

Here is the call graph for this function:

◆ setReferences() [2/2]

void setReferences	(	const labelUList &	cellLabels,
		const UList< Type > &	values,
		const bool	forceReference = `false`
	)

Set reference level for solution.

Definition at line 1043 of file fvMatrix.C.

References cellId, Foam::diag(), forAll, and Foam::HashTableOps::values().

Here is the call graph for this function:

◆ setComponentReference() [1/3]

void setComponentReference	(	const label	patchi,
		const label	facei,
		const direction	cmpt,
		const scalar	value
	)

Set reference level for a component of the solution on a given patch face.

Definition at line 31 of file fvMatrixSolve.C.

References Foam::diag().

Here is the call graph for this function:

◆ addFvMatrix()

void addFvMatrix ( fvMatrix< Type > & matrix )

Add fvMatrix.

Definition at line 1065 of file fvMatrix.C.

References Foam::abort(), fvMatrix< Type >::clone(), fvMatrix< Type >::dimensions(), Foam::endl(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ relax() [1/2]

void relax ( const scalar alpha )

Relax matrix (for steady-state solution).

alpha = 1 : diagonally equal alpha < 1 : diagonally dominant alpha = 0 : do nothing Note: Requires positive diagonal.

Definition at line 1094 of file fvMatrix.C.

References Foam::constant::atomic::alpha, Foam::cmptMag(), Foam::cmptMax(), Foam::cmptMin(), Foam::component(), fvPatchFieldBase::coupled(), D, Foam::ensightOutput::debug, DebugInFunction, Foam::diag(), Foam::endl(), forAll, InfoInFunction, Foam::mag(), Foam::max(), UPstream::msgType(), Foam::nl, Foam::reduce(), Foam::returnReduce(), UList< Type >::size(), and Foam::Zero.

Referenced by jouleHeatingSource::addSup(), hydrostaticPressure::calculateAndWrite(), IATE::correct(), dynamicLagrangian< BasicTurbulenceModel >::correct(), thixotropicViscosity::correct(), SpalartAllmarasBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::correct(), kineticTheoryModel::correct(), kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::correct(), incompressiblePrimalSolver::correctBoundaryConditions(), waxSolventEvaporation::correctModel(), age::execute(), electricPotential::execute(), scalarTransport::execute(), energyTransport::execute(), simple::mainIter(), twoPhaseSystem::solve(), adjointEikonalSolver::solve(), populationBalanceModel::solve(), thermalBaffle::solveEnergy(), and thermalShell::solveEnergy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ relax() [2/2]

void relax ( )

Relax matrix (for steady-state solution).

alpha is read from controlDict

Definition at line 1242 of file fvMatrix.C.

References Foam::name(), and relax().

Here is the call graph for this function:

◆ boundaryManipulate()

void boundaryManipulate ( typename GeometricField< Type, fvPatchField, volMesh >::Boundary & values )

Manipulate based on a boundary field.

Definition at line 1260 of file fvMatrix.C.

References forAll.

Referenced by kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::correct(), adjointSimple::mainIter(), adjointMeshMovementSolver::solve(), multiphaseSystem::solveAlphas(), and oversetFvMeshBase::solveOverset().

Here is the caller graph for this function:

◆ solver() [1/4]

autoPtr<fvSolver> solver ( const dictionary & )

Construct and return the solver.

Use the given solver controls

◆ solver() [2/4]

Foam::autoPtr< typename Foam::fvMatrix< Type >::fvSolver > solver ( )

Construct and return the solver.

Solver controls read from fvSolution

Definition at line 327 of file fvMatrixSolve.C.

◆ solveSegregatedOrCoupled() [1/2]

Foam::SolverPerformance< Type > solveSegregatedOrCoupled ( const dictionary & solverControls )

Solve segregated or coupled returning the solution statistics.

Use the given solver controls

Definition at line 55 of file fvMatrixSolve.C.

References addProfiling, Foam::ensightOutput::debug, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::getOrDefault(), Foam::Info, messageStream::masterStream(), mesh, regionName, and solve().

Referenced by velocityComponentLaplacianFvMotionSolver::solve(), velocityLaplacianFvMotionSolver::solve(), displacementComponentLaplacianFvMotionSolver::solve(), displacementSBRStressFvMotionSolver::solve(), solidBodyDisplacementLaplacianFvMotionSolver::solve(), displacementLaplacianFvMotionSolver::solve(), and fvMesh::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ solveSegregatedOrCoupled() [2/2]

Foam::SolverPerformance< Type > solveSegregatedOrCoupled ( )

Solve segregated or coupled returning the solution statistics.

Solver controls read from fvSolution

Definition at line 309 of file fvMatrixSolve.C.

◆ solveSegregated() [1/3]

Foam::SolverPerformance< Type > solveSegregated ( const dictionary & solverControls )

Solve segregated returning the solution statistics.

Use the given solver controls

Definition at line 105 of file fvMatrixSolve.C.

References Field< Type >::component(), Foam::ensightOutput::debug, Foam::diag(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::getOrDefault(), Foam::Info, messageStream::masterStream(), mesh, Foam::expressions::Detail::nComponents(), Foam::New(), SolverPerformance< Type >::print(), psi, refPtr< Container< Type > >::ref(), solve(), and SolverPerformance< Type >::solverName().

Here is the call graph for this function:

◆ solveCoupled()

Foam::SolverPerformance< Type > solveCoupled ( const dictionary & solverControls )

Solve coupled returning the solution statistics.

Use the given solver controls

Definition at line 244 of file fvMatrixSolve.C.

References Foam::ensightOutput::debug, Foam::diag(), LduMatrix< Type, DType, LUType >::diag(), Foam::endl(), dictionary::getOrDefault(), Foam::Info, Foam::stringOps::lower(), messageStream::masterStream(), mesh, SolverPerformance< Type >::print(), psi, and Foam::stringOps::upper().

Here is the call graph for this function:

◆ solve() [1/3]

Foam::SolverPerformance< Type > solve ( const dictionary & solverControls )

Solve returning the solution statistics.

Use the given solver controls

Definition at line 317 of file fvMatrixSolve.C.

Referenced by jouleHeatingSource::addSup(), Implicit< CloudType >::cacheFields(), hydrostaticPressure::calculateAndWrite(), dynamicLagrangian< BasicTurbulenceModel >::correct(), kineticTheoryModel::correct(), Foam::CorrectPhi(), age::execute(), electricPotential::execute(), scalarTransport::execute(), energyTransport::execute(), adjointSimple::mainIter(), simple::mainIter(), pLaplacianMotionSolver::solve(), elasticityMotionSolver::solve(), twoPhaseSystem::solve(), adjointEikonalSolver::solve(), multiphaseSystem::solveAlphas(), reactingOneDim::solveContinuity(), thermalBaffle::solveEnergy(), thermalShell::solveEnergy(), Helmholtz::solveEqn(), shapeDesignVariables::solveMeshMovementEqn(), kinematicSingleLayer::solveThickness(), and MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi().

Here is the caller graph for this function:

◆ solve() [2/3]

Foam::SolverPerformance< Type > solve ( const word & name )

Solve returning the solution statistics.

Uses name solver controls from fvSolution

Definition at line 341 of file fvMatrixSolve.C.

References fvMatrix< Type >::solve(), and fvMatrix< Type >::solverDict().

Here is the call graph for this function:

◆ solve() [3/3]

Foam::SolverPerformance< Type > solve ( )

Solve returning the solution statistics.

Solver controls read from fvSolution

Definition at line 348 of file fvMatrixSolve.C.

References fvMatrix< Type >::solverDict().

Referenced by fvMatrix< Type >::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ residual() [1/3]

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

Return the matrix residual.

Definition at line 355 of file fvMatrixSolve.C.

References fvMatrix< Type >::addBoundaryDiag(), fvMatrix< Type >::addBoundarySource(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), Field< Type >::component(), Foam::expressions::Detail::nComponents(), Foam::New(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), FieldField< Field, Type >::replace(), lduMatrix::residual(), GeometricBoundaryField< Type, PatchField, GeoMesh >::scalarInterfaces(), UList< T >::size(), and Foam::Zero.

Here is the call graph for this function:

◆ D()

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

Return the matrix scalar diagonal.

Definition at line 1273 of file fvMatrix.C.

References Foam::diag(), and tmp< T >::New().

Here is the call graph for this function:

◆ DD()

Foam::tmp< Foam::Field< Type > > DD ( ) const

Return the matrix Type diagonal.

Definition at line 1282 of file fvMatrix.C.

References fvPatchFieldBase::coupled(), Foam::diag(), forAll, tmp< T >::ref(), and UList< Type >::size().

Here is the call graph for this function:

◆ A()

Foam::tmp< Foam::volScalarField > A ( ) const

Return the central coefficient.

Definition at line 1306 of file fvMatrix.C.

References D, Foam::dimVol, fvPatchFieldBase::extrapolatedCalculatedType(), and GeometricField< scalar, fvPatchField, volMesh >::New().

Referenced by meanVelocityForce::constrain(), directionalPressureGradientExplicitSource::constrain(), incompressiblePrimalSolver::correctBoundaryConditions(), and simple::mainIter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ H() [1/3]

Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > H ( ) const

Return the H operation source.

Definition at line 1325 of file fvMatrix.C.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimVol, fvPatchFieldBase::extrapolatedCalculatedType(), lduMatrix::H(), Foam::expressions::Detail::nComponents(), GeometricField< Type, PatchField, GeoMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), GeometricField< Type, PatchField, GeoMesh >::replace(), and Foam::Zero.

Referenced by incompressiblePrimalSolver::correctBoundaryConditions(), and simple::mainIter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ H1() [1/3]

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

Return H(1)

Definition at line 1377 of file fvMatrix.C.

References Foam::component(), fvPatchFieldBase::coupled(), Foam::dimVol, fvPatchFieldBase::extrapolatedCalculatedType(), forAll, lduMatrix::H1(), GeometricField< scalar, fvPatchField, volMesh >::New(), and UList< Type >::size().

Referenced by simple::mainIter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ flux()

Foam::tmp< Foam::GeometricField< Type, Foam::fvsPatchField, Foam::surfaceMesh > > flux ( ) const

Return the face-flux field from the matrix.

Definition at line 1415 of file fvMatrix.C.

References Foam::abort(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), Foam::cmptMultiply(), lduMatrix::faceH(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::expressions::Detail::nComponents(), GeometricField< Type, PatchField, GeoMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), and DimensionedField< Type, GeoMesh >::setOriented().

Referenced by Implicit< CloudType >::cacheFields(), incompressiblePrimalSolver::correctBoundaryConditions(), Foam::CorrectPhi(), scalarTransport::execute(), adjointSimple::mainIter(), simple::mainIter(), twoPhaseSystem::solve(), multiphaseSystem::solveAlphas(), kinematicSingleLayer::solveThickness(), and MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ solverDict() [1/2]

const Foam::dictionary & solverDict ( const word & name ) const

Return the solver dictionary (from fvSolution) for name.

Definition at line 1519 of file fvMatrix.C.

References Foam::name().

Here is the call graph for this function:

◆ solverDict() [2/2]

const Foam::dictionary & solverDict ( ) const

Return the solver dictionary for psi, taking into account finalIteration.

Definition at line 1528 of file fvMatrix.C.

Referenced by fvMatrix< Type >::solve().

Here is the caller graph for this function:

◆ operator=() [1/2]

void operator= ( const fvMatrix< Type > & fvmv )

Definition at line 1540 of file fvMatrix.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and lduMatrix::operator=().

Here is the call graph for this function:

◆ operator=() [2/2]

void operator= ( const tmp< fvMatrix< Type >> & tfvmv )

Definition at line 1578 of file fvMatrix.C.

◆ negate()

void negate ( )

Inplace negate.

Definition at line 1586 of file fvMatrix.C.

References lduMatrix::negate().

Here is the call graph for this function:

◆ operator+=() [1/7]

void operator+= ( const fvMatrix< Type > & fvmv )

Definition at line 1601 of file fvMatrix.C.

References Foam::checkMethod(), and lduMatrix::operator+=().

Here is the call graph for this function:

◆ operator+=() [2/7]

void operator+= ( const tmp< fvMatrix< Type >> & tfvmv )

Definition at line 1630 of file fvMatrix.C.

◆ operator-=() [1/7]

void operator-= ( const fvMatrix< Type > & fvmv )

Definition at line 1638 of file fvMatrix.C.

References Foam::checkMethod(), and lduMatrix::operator-=().

Here is the call graph for this function:

◆ operator-=() [2/7]

void operator-= ( const tmp< fvMatrix< Type >> & tfvmv )

Definition at line 1667 of file fvMatrix.C.

◆ operator+=() [3/7]

void operator+= ( const DimensionedField< Type, volMesh > & su )

Definition at line 1676 of file fvMatrix.C.

References Foam::checkMethod().

Here is the call graph for this function:

◆ operator+=() [4/7]

void operator+= ( const tmp< DimensionedField< Type, volMesh >> & tsu )

Definition at line 1687 of file fvMatrix.C.

◆ operator+=() [5/7]

void operator+= ( const tmp< GeometricField< Type, fvPatchField, volMesh >> & tsu )

Definition at line 1698 of file fvMatrix.C.

◆ operator-=() [3/7]

void operator-= ( const DimensionedField< Type, volMesh > & su )

Definition at line 1709 of file fvMatrix.C.

References Foam::checkMethod().

Here is the call graph for this function:

◆ operator-=() [4/7]

void operator-= ( const tmp< DimensionedField< Type, volMesh >> & tsu )

Definition at line 1720 of file fvMatrix.C.

◆ operator-=() [5/7]

void operator-= ( const tmp< GeometricField< Type, fvPatchField, volMesh >> & tsu )

Definition at line 1731 of file fvMatrix.C.

◆ operator+=() [6/7]

void operator+= ( const dimensioned< Type > & su )

Definition at line 1742 of file fvMatrix.C.

References DimensionedField< Type, GeoMesh >::mesh(), and psi.

Here is the call graph for this function:

◆ operator-=() [6/7]

void operator-= ( const dimensioned< Type > & su )

Definition at line 1752 of file fvMatrix.C.

References DimensionedField< Type, GeoMesh >::mesh(), and psi.

Here is the call graph for this function:

◆ operator+=() [7/7]

void operator+= ( const Foam::zero )

inline

Definition at line 858 of file fvMatrix.H.

◆ operator-=() [7/7]

void operator-= ( const Foam::zero )

inline

Definition at line 859 of file fvMatrix.H.

◆ operator*=() [1/4]

void operator*= ( const volScalarField::Internal & dsf )

Definition at line 1762 of file fvMatrix.C.

References Foam::abort(), fvMatrix< Type >::dimensions(), Foam::FatalError, FatalErrorInFunction, forAll, and lduMatrix::operator*=().

Here is the call graph for this function:

◆ operator*=() [2/4]

void operator*= ( const tmp< volScalarField::Internal > & tfld )

Definition at line 1792 of file fvMatrix.C.

◆ operator*=() [3/4]

void operator*= ( const tmp< volScalarField > & tfld )

Definition at line 1803 of file fvMatrix.C.

◆ operator*=() [4/4]

void operator*= ( const dimensioned< scalar > & ds )

Definition at line 1814 of file fvMatrix.C.

References lduMatrix::operator*=().

Here is the call graph for this function:

◆ setComponentReference() [2/3]

void setComponentReference	(	const label	patchi,
		const label	facei,
		const direction	,
		const scalar	value
	)

Definition at line 34 of file fvScalarMatrix.C.

References Foam::diag().

Here is the call graph for this function:

◆ solver() [3/4]

Foam::autoPtr< Foam::fvMatrix< Foam::scalar >::fvSolver > solver ( const dictionary & solverControls )

Definition at line 59 of file fvScalarMatrix.C.

References addProfiling, Foam::ensightOutput::debug, Foam::diag(), Foam::endl(), Foam::Info, messageStream::masterStream(), mesh, Foam::New(), regionName, and solve().

Here is the call graph for this function:

◆ solveSegregated() [2/3]

Foam::solverPerformance solveSegregated ( const dictionary & solverControls )

Definition at line 155 of file fvScalarMatrix.C.

References Foam::ensightOutput::debug, Foam::diag(), Foam::endl(), forAll, dictionary::getOrDefault(), Foam::Info, Foam::stringOps::lower(), messageStream::masterStream(), mesh, Foam::name(), Foam::New(), SolverPerformance< Type >::print(), psi, tmp< T >::ref(), UList< T >::size(), Foam::stringOps::upper(), and Foam::Zero.

Here is the call graph for this function:

◆ residual() [2/3]

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

Definition at line 308 of file fvScalarMatrix.C.

References psi, refPtr< Container< Type > >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ H() [2/3]

Foam::tmp< Foam::volScalarField > H ( ) const

Definition at line 337 of file fvScalarMatrix.C.

References Foam::dimVol, Foam::fieldTypes::extrapolatedCalculatedType, H(), and Foam::New().

Here is the call graph for this function:

◆ H1() [2/3]

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

Definition at line 359 of file fvScalarMatrix.C.

References Foam::dimVol, Foam::fieldTypes::extrapolatedCalculatedType, and Foam::New().

Here is the call graph for this function:

◆ setComponentReference() [3/3]

void setComponentReference	(	const label	patchi,
		const label	facei,
		const direction	,
		const scalar	value
	)

◆ solver() [4/4]

autoPtr< fvMatrix< scalar >::fvSolver > solver ( const dictionary & )

◆ solveSegregated() [3/3]

solverPerformance solveSegregated ( const dictionary & )

◆ residual() [3/3]

tmp< scalarField > residual ( ) const

◆ H() [3/3]

tmp< volScalarField > H ( ) const

◆ H1() [3/3]

tmp< volScalarField > H1 ( ) const

Friends And Related Function Documentation

◆ fvSolver

friend class fvSolver

friend

Declare friendship with the fvSolver class.

Definition at line 203 of file fvMatrix.H.

◆ operator & [1/4]

tmp<GeometricField<Type, fvPatchField, volMesh> > operator&	(	const fvMatrix< Type > &	,
		const DimensionedField< Type, volMesh > &
	)

friend

◆ operator & [2/4]

tmp<GeometricField<Type, fvPatchField, volMesh> > operator&	(	const fvMatrix< Type > &	,
		const tmp< GeometricField< Type, fvPatchField, volMesh >> &
	)

friend

◆ operator & [3/4]

tmp<GeometricField<Type, fvPatchField, volMesh> > operator&	(	const tmp< fvMatrix< Type >> &	,
		const DimensionedField< Type, volMesh > &
	)

friend

◆ operator & [4/4]

tmp<GeometricField<Type, fvPatchField, volMesh> > operator&	(	const tmp< fvMatrix< Type >> &	,
		const tmp< GeometricField< Type, fvPatchField, volMesh >> &
	)

friend

◆ operator

Ostream& operator	(	Ostream &	,
		const fvMatrix< Type > &
	)

friend

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

src/finiteVolume/fields/fvPatchFields/fvPatchField/fvPatchField.H
src/finiteVolume/fvMatrices/fvMatrix/fvMatrix.H
src/finiteVolume/fvMatrices/fvMatrix/fvMatrix.C
src/finiteVolume/fvMatrices/fvMatrix/fvMatrixSolve.C

Classes

Public Types

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

template<class Type> class Foam::fvMatrix< Type >

Member Typedef Documentation

◆ psiFieldType

◆ faceFluxFieldType

◆ faceFluxFieldPtrType

Constructor & Destructor Documentation

◆ fvMatrix() [1/4]

◆ fvMatrix() [2/4]

◆ fvMatrix() [3/4]

◆ fvMatrix() [4/4]

◆ ~fvMatrix()

Member Function Documentation

◆ addToInternalField() [1/2]

◆ addToInternalField() [2/2]

◆ subtractFromInternalField() [1/2]

◆ subtractFromInternalField() [2/2]

◆ checkImplicit()

◆ addBoundaryDiag()

◆ addCmptAvBoundaryDiag()

◆ addBoundarySource()

◆ setValuesFromList()

◆ ClassName()

◆ clone()

◆ nMatrices()

◆ matrix() [1/2]

◆ matrix() [2/2]

◆ globalPatchID()

◆ transferFvMatrixCoeffs()

◆ createOrUpdateLduPrimitiveAssembly()

◆ lduMeshPtr() [1/2]

◆ lduMeshPtr() [2/2]

◆ manipulateMatrix()

◆ setBounAndInterCoeffs()

◆ setInterfaces()

◆ mapContributions()

◆ lduMeshAssembly()

◆ psi() [1/2]

◆ psi() [2/2]

◆ clear()

◆ dimensions()

◆ source() [1/2]

◆ source() [2/2]

◆ internalCoeffs() [1/2]

◆ internalCoeffs() [2/2]

◆ boundaryCoeffs() [1/2]

◆ boundaryCoeffs() [2/2]

◆ faceFluxCorrectionPtr() [1/2]

◆ faceFluxCorrectionPtr() [2/2]

◆ hasFaceFluxCorrection()

◆ setValues() [1/3]

◆ setValues() [2/3]

◆ setValues() [3/3]

◆ setReference()

◆ setReferences() [1/2]

◆ setReferences() [2/2]

◆ setComponentReference() [1/3]

◆ addFvMatrix()

◆ relax() [1/2]

◆ relax() [2/2]

◆ boundaryManipulate()

◆ solver() [1/4]

◆ solver() [2/4]

◆ solveSegregatedOrCoupled() [1/2]

◆ solveSegregatedOrCoupled() [2/2]

◆ solveSegregated() [1/3]

◆ solveCoupled()

◆ solve() [1/3]

◆ solve() [2/3]

◆ solve() [3/3]

◆ residual() [1/3]

◆ D()

◆ DD()

◆ A()

template<class Type>
class Foam::fvMatrix< Type >