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

Public Types
typedef GeometricField< Type, fvsPatchField, surfaceMesh > *	surfaceTypeFieldPtr
	Declare return type of the faceFluxCorrectionPtr() function. More...

Public Member Functions
	ClassName ("fvMatrix")

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

	fvMatrix (const fvMatrix< Type > &)
	Construct as copy. More...

	fvMatrix (const tmp< fvMatrix< Type >> &)
	Construct as copy of tmp<fvMatrix<Type>> deleting argument. More...

	fvMatrix (const GeometricField< Type, fvPatchField, volMesh > &, Istream &)
	Construct from Istream given field to solve for. More...

tmp< fvMatrix< Type > >	clone () const
	Clone. More...

virtual	~fvMatrix ()
	Destructor. More...

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

const dimensionSet &	dimensions () const

Field< Type > &	source ()

const Field< Type > &	source () const

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

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

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

void	setValues (const labelUList &cells, const UList< Type > &values)
	Set solution in given cells to the specified values. More...

void	setValues (const labelUList &cells, const UIndirectList< Type > &values)
	Set solution in given cells to the specified values. More...

void	setReference (const label celli, const Type &value, 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. 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 >	solve (const dictionary &)
	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 ()
	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...

void	operator= (const fvMatrix< Type > &)

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

void	negate ()

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 zero &)

void	operator-= (const 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
int	count () const
	Return the current reference count. More...

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

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

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

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

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

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

	lduMatrix (const lduMesh &)
	Construct given an LDU addressed mesh. More...

	lduMatrix (const lduMatrix &)
	Construct as copy. More...

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

	lduMatrix (const lduMesh &, Istream &)
	Construct given an LDU addressed mesh and an Istream. More...

	~lduMatrix ()
	Destructor. More...

const lduMesh &	mesh () const
	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

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

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 &cells, const ListType< Type > &values)
	Set solution in given cells to the specified values. More...

Protected Member Functions inherited from refCount
	refCount ()
	Construct null initializing count to 0. 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 > &)

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 72 of file fvPatchField.H.

Member Typedef Documentation

◆ surfaceTypeFieldPtr

typedef GeometricField<Type, fvsPatchField, surfaceMesh>* surfaceTypeFieldPtr

Declare return type of the faceFluxCorrectionPtr() function.

Definition at line 321 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 268 of file fvMatrix.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), Foam::endl(), regIOobject::eventNo(), forAll, InfoInFunction, DimensionedField< Type, GeoMesh >::mesh(), patchi, and Foam::Zero.

Referenced by fvMatrix< Type >::fvMatrix(), fvMatrix< Type >::fvSolver::fvSolver(), and fvMatrix< Type >::setValuesFromList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fvMatrix() [2/4]

fvMatrix ( const fvMatrix< Type > & fvm )

Construct as copy.

Definition at line 322 of file fvMatrix.C.

References Foam::endl(), and InfoInFunction.

Here is the call graph for this function:

◆ fvMatrix() [3/4]

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

Construct as copy of tmp<fvMatrix<Type>> deleting argument.

Definition at line 352 of file fvMatrix.C.

References Foam::endl(), fvMatrix< Type >::fvMatrix(), and InfoInFunction.

Here is the call graph for this function:

◆ fvMatrix() [4/4]

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

Construct from Istream given field to solve for.

Definition at line 408 of file fvMatrix.C.

References Foam::endl(), forAll, InfoInFunction, DimensionedField< Type, GeoMesh >::mesh(), patchi, and Foam::Zero.

Here is the call graph for this function:

◆ ~fvMatrix()

~fvMatrix ( )

virtual

Destructor.

Definition at line 467 of file fvMatrix.C.

References Foam::endl(), InfoInFunction, and fvMatrix< Type >::setValues().

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

Here is the call graph for this function:

Here is the caller 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 38 of file fvMatrix.C.

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

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

Here is the call graph for this function:

Here is the caller 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 61 of file fvMatrix.C.

References fvMatrix< Type >::subtractFromInternalField().

Here is the call graph for this function:

◆ 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 75 of file fvMatrix.C.

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

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

Here is the call graph for this function:

Here is the caller 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 98 of file fvMatrix.C.

References fvMatrix< Type >::addBoundaryDiag().

Here is the call graph for this function:

◆ addBoundaryDiag()

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

protected

Definition at line 111 of file fvMatrix.C.

References Foam::component(), forAll, and patchi.

Referenced by fvMatrix< Type >::H(), fvMatrix< Type >::residual(), and fvMatrix< Type >::subtractFromInternalField().

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 129 of file fvMatrix.C.

References fvMatrix< Type >::addBoundarySource(), Foam::cmptAv(), forAll, and patchi.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addBoundarySource()

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

protected

Definition at line 145 of file fvMatrix.C.

References Foam::cmptMultiply(), fvPatchField< Type >::coupled(), forAll, patchi, fvPatchField< Type >::patchNeighbourField(), and fvMatrix< Type >::setValuesFromList().

Referenced by fvMatrix< Type >::addCmptAvBoundaryDiag(), fvMatrix< Type >::H(), and fvMatrix< Type >::residual().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValuesFromList()

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

protected

Set solution in given cells to the specified values.

Definition at line 178 of file fvMatrix.C.

References polyMesh::boundaryMesh(), Foam::constant::universal::c, cells, primitiveMesh::cells(), Foam::diag(), forAll, fvMatrix< Type >::fvMatrix(), primitiveMesh::isInternalFace(), mesh, fvMesh::neighbour(), fvMesh::owner(), patchi, primitiveFieldRef(), psi, polyBoundaryMesh::whichPatch(), and Foam::Zero.

Referenced by fvMatrix< Type >::addBoundarySource(), and fvMatrix< Type >::setValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClassName()

ClassName ( "fvMatrix< Type >" )

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

Here is the caller graph for this function:

◆ clone()

Foam::tmp< Foam::fvMatrix< Type > > clone ( ) const

Clone.

Definition at line 455 of file fvMatrix.C.

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

Here is the caller graph for this function:

◆ psi()

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

inline

◆ dimensions()

const dimensionSet& dimensions ( ) const

inline

Definition at line 289 of file fvMatrix.H.

Referenced by explicitPorositySource::addSup(), meanVelocityForce::addSup(), interRegionExplicitPorositySource::addSup(), SemiImplicitSource< Type >::addSup(), rotorDiskSource::addSup(), Foam::checkMethod(), fixedCoeff::correct(), powerLaw::correct(), DarcyForchheimer::correct(), solidification::correct(), and fvMatrix< Type >::flux().

Here is the caller graph for this function:

◆ source() [1/2]

Field<Type>& source ( )

inline

Definition at line 294 of file fvMatrix.H.

Referenced by MRFZone::addCoriolis(), interRegionExplicitPorositySource::addSup(), radialActuationDiskSource::addSup(), actuationDiskSource::addSup(), solidificationMeltingSource::addSup(), effectivenessHeatExchangerSource::addSup(), fixedCoeff::correct(), DarcyForchheimer::correct(), EulerD2dt2Scheme< Type >::fvmD2dt2(), EulerDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), gaussLaplacianScheme< Type, GType >::fvmLaplacian(), fvMatrix< Type >::operator+=(), fvMatrix< Type >::operator-=(), fvMatrix< Type >::relax(), fvMatrix< Type >::setReference(), ThermoCloud< Foam::DSMCCloud >::Sh(), ReactingCloud< Foam::DSMCCloud >::Srho(), KinematicCloud< Cloud< basicKinematicCollidingParcel > >::SU(), and ReactingCloud< Foam::DSMCCloud >::SYi().

Here is the caller graph for this function:

◆ source() [2/2]

const Field<Type>& source ( ) const

inline

Definition at line 299 of file fvMatrix.H.

References fvMatrix< Type >::boundaryCoeffs(), and fvMatrix< Type >::internalCoeffs().

Here is the call graph for this function:

◆ internalCoeffs()

FieldField<Field, Type>& internalCoeffs ( )

inline

fvBoundary scalar field containing pseudo-matrix coeffs

for internal cells

Definition at line 306 of file fvMatrix.H.

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

Here is the caller graph for this function:

◆ boundaryCoeffs()

FieldField<Field, Type>& boundaryCoeffs ( )

inline

fvBoundary scalar field containing pseudo-matrix coeffs

for boundary cells

Definition at line 313 of file fvMatrix.H.

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

Here is the caller graph for this function:

◆ faceFluxCorrectionPtr()

surfaceTypeFieldPtr& faceFluxCorrectionPtr ( )

inline

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

Definition at line 324 of file fvMatrix.H.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValues() [1/2]

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

Set solution in given cells to the specified values.

and eliminate the corresponding equations from the matrix.

Definition at line 486 of file fvMatrix.C.

References fvMatrix< Type >::setValuesFromList().

Referenced by FixedValueConstraint< Type >::constrain(), fixedTemperatureConstraint::constrain(), fvMatrix< Type >::faceFluxCorrectionPtr(), fixedInternalValueFvPatchField< Type >::manipulateMatrix(), epsilonWallFunctionFvPatchScalarField::manipulateMatrix(), omegaWallFunctionFvPatchScalarField::manipulateMatrix(), and fvMatrix< Type >::~fvMatrix().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValues() [2/2]

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

Set solution in given cells to the specified values.

and eliminate the corresponding equations from the matrix.

Definition at line 497 of file fvMatrix.C.

References fvMatrix< Type >::setReference(), and fvMatrix< Type >::setValuesFromList().

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 508 of file fvMatrix.C.

References lduMatrix::diag(), and fvMatrix< Type >::source().

Referenced by Foam::CorrectPhi(), fvMatrix< Type >::faceFluxCorrectionPtr(), and fvMatrix< Type >::setValues().

Here is the call graph for this function:

Here is the caller 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 33 of file fvMatrixSolve.C.

References Foam::diag(), patchi, and fvMatrix< Type >::solve().

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

Here is the call graph for this function:

Here is the caller 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 523 of file fvMatrix.C.

References Foam::constant::atomic::alpha, Foam::cmptMag(), Foam::cmptMax(), Foam::cmptMin(), Foam::component(), fvPatchField< Type >::coupled(), fvMatrix< Type >::D(), lduMatrix::diag(), Foam::endl(), forAll, InfoInFunction, lduMatrix::lduAddr(), Foam::mag(), Foam::max(), UPstream::msgType(), Foam::nl, lduAddressing::patchAddr(), patchi, Foam::reduce(), Foam::returnReduce(), List< T >::size(), List< Type >::size(), fvMatrix< Type >::source(), and lduMatrix::sumMagOffDiag().

Referenced by dynamicLagrangian< BasicTurbulenceModel >::correct(), thixotropicViscosity::correct(), kOmegaSST< LESeddyViscosity< BasicTurbulenceModel >, BasicTurbulenceModel >::correct(), scalarTransport::execute(), and thermalBaffle::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 674 of file fvMatrix.C.

References fvMatrix< Type >::boundaryManipulate(), and Foam::name().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ boundaryManipulate()

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

Manipulate based on a boundary field.

Definition at line 691 of file fvMatrix.C.

References forAll, and patchi.

Referenced by kOmegaSST< LESeddyViscosity< BasicTurbulenceModel >, BasicTurbulenceModel >::correct(), fvMatrix< Type >::faceFluxCorrectionPtr(), and fvMatrix< Type >::relax().

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 280 of file fvMatrixSolve.C.

Referenced by fvMatrix< Type >::faceFluxCorrectionPtr(), and fvMatrix< Type >::setComponentReference().

Here is the caller graph for this function:

◆ solve() [1/2]

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

Solve segregated or coupled returning the solution statistics.

Use the given solver controls

Definition at line 57 of file fvMatrixSolve.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, dictionary::lookupOrDefault(), messageStream::masterStream(), mesh, dictionary::readIfPresent(), and fvMatrix< Type >::solveSegregated().

Referenced by Implicit< CloudType >::cacheFields(), Foam::checkMethod(), dynamicLagrangian< BasicTurbulenceModel >::correct(), Foam::CorrectPhi(), scalarTransport::execute(), thermalBaffle::solveEnergy(), and kinematicSingleLayer::solveThickness().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ solveSegregated() [1/3]

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

Solve segregated returning the solution statistics.

Use the given solver controls

Definition at line 104 of file fvMatrixSolve.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), Field< Type >::component(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::diag(), Foam::endl(), Foam::Info, messageStream::masterStream(), mesh, DimensionedField< Type, GeoMesh >::mesh(), IOobject::name(), Foam::New(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), SolverPerformance< Type >::print(), psi, solve(), fvMatrix< Type >::solveCoupled(), and SolverPerformance< Type >::solverName().

Referenced by fvMatrix< Type >::faceFluxCorrectionPtr(), fvMatrix< Type >::fvSolver::solve(), and fvMatrix< Type >::solve().

Here is the call graph for this function:

Here is the caller 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 220 of file fvMatrixSolve.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::diag(), LduMatrix< Type, DType, LUType >::diag(), Foam::endl(), Foam::Info, messageStream::masterStream(), mesh, DimensionedField< Type, GeoMesh >::mesh(), IOobject::name(), SolverPerformance< Type >::print(), and psi.

Referenced by fvMatrix< Type >::faceFluxCorrectionPtr(), and fvMatrix< Type >::solveSegregated().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ solve() [2/2]

Foam::SolverPerformance< Type > solve ( )

Solve returning the solution statistics.

Solver controls read from fvSolution

Definition at line 314 of file fvMatrixSolve.C.

References fvMatrix< Type >::fvSolver::solve().

Referenced by Foam::checkMethod(), and fvMatrix< Type >::setComponentReference().

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 331 of file fvMatrixSolve.C.

References fvMatrix< Type >::addBoundaryDiag(), fvMatrix< Type >::addBoundarySource(), Field< Type >::component(), tmp< T >::ref(), Field< Type >::replace(), and lduMatrix::residual().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ D()

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

Return the matrix scalar diagonal.

Definition at line 704 of file fvMatrix.C.

References fvMatrix< Type >::addCmptAvBoundaryDiag(), lduMatrix::diag(), and tmp< T >::ref().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DD()

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

Return the matrix Type diagonal.

Definition at line 713 of file fvMatrix.C.

References fvMatrix< Type >::addToInternalField(), fvPatchField< Type >::coupled(), lduMatrix::diag(), forAll, lduMatrix::lduAddr(), patchi, tmp< T >::ref(), and List< Type >::size().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ A()

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

Return the central coefficient.

Definition at line 737 of file fvMatrix.C.

References fvMatrix< Type >::D(), Foam::dimVol, IOobject::NO_READ, IOobject::NO_WRITE, and tmp< T >::ref().

Referenced by Foam::checkMethod(), meanVelocityForce::constrain(), fvMatrix< Type >::faceFluxCorrectionPtr(), and kinematicSingleLayer::solveThickness().

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 766 of file fvMatrix.C.

References fvMatrix< Type >::addBoundaryDiag(), fvMatrix< Type >::addBoundarySource(), fvMatrix< Type >::addCmptAvBoundaryDiag(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimVol, lduMatrix::H(), IOobject::NO_READ, IOobject::NO_WRITE, GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), tmp< T >::ref(), and GeometricField< Type, PatchField, GeoMesh >::replace().

Referenced by fvMatrix< Type >::faceFluxCorrectionPtr(), and kinematicSingleLayer::solveThickness().

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 828 of file fvMatrix.C.

References fvMatrix< Type >::addToInternalField(), Foam::component(), fvPatchField< Type >::coupled(), Foam::dimVol, fvMatrix< Type >::flux(), forAll, lduMatrix::H1(), lduMatrix::lduAddr(), IOobject::NO_READ, IOobject::NO_WRITE, patchi, GeometricField< Type, PatchField, GeoMesh >::ref(), and List< Type >::size().

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

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 876 of file fvMatrix.C.

References Foam::abort(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), Foam::cmptMultiply(), fvMatrix< Type >::dimensions(), lduMatrix::faceH(), Foam::FatalError, FatalErrorInFunction, forAll, IOobject::NO_READ, IOobject::NO_WRITE, patchi, GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), and tmp< T >::ref().

Referenced by Implicit< CloudType >::cacheFields(), Foam::checkMethod(), Foam::CorrectPhi(), fvMatrix< Type >::faceFluxCorrectionPtr(), fvMatrix< Type >::H1(), and kinematicSingleLayer::solveThickness().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [1/2]

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

Definition at line 963 of file fvMatrix.C.

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

Referenced by fvMatrix< Type >::faceFluxCorrectionPtr(), 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= ( const tmp< fvMatrix< Type >> & tfvmv )

Definition at line 999 of file fvMatrix.C.

References fvMatrix< Type >::operator=().

Here is the call graph for this function:

◆ negate()

void negate ( )

Definition at line 1007 of file fvMatrix.C.

References lduMatrix::negate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator+=() [1/7]

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

Definition at line 1022 of file fvMatrix.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator+=() [2/7]

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

Definition at line 1048 of file fvMatrix.C.

References fvMatrix< Type >::operator+=().

Here is the call graph for this function:

◆ operator-=() [1/7]

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

Definition at line 1056 of file fvMatrix.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator-=() [2/7]

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

Definition at line 1080 of file fvMatrix.C.

References fvMatrix< Type >::operator-=().

Here is the call graph for this function:

◆ operator+=() [3/7]

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

Definition at line 1089 of file fvMatrix.C.

References Foam::checkMethod(), and fvMatrix< Type >::source().

Here is the call graph for this function:

◆ operator+=() [4/7]

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

Definition at line 1100 of file fvMatrix.C.

References fvMatrix< Type >::operator+=().

Here is the call graph for this function:

◆ operator+=() [5/7]

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

Definition at line 1111 of file fvMatrix.C.

References fvMatrix< Type >::operator+=().

Here is the call graph for this function:

◆ operator-=() [3/7]

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

Definition at line 1122 of file fvMatrix.C.

References Foam::checkMethod(), and fvMatrix< Type >::source().

Here is the call graph for this function:

◆ operator-=() [4/7]

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

Definition at line 1133 of file fvMatrix.C.

References fvMatrix< Type >::operator-=().

Here is the call graph for this function:

◆ operator-=() [5/7]

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

Definition at line 1144 of file fvMatrix.C.

References fvMatrix< Type >::operator-=().

Here is the call graph for this function:

◆ operator+=() [6/7]

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

Definition at line 1155 of file fvMatrix.C.

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

Here is the call graph for this function:

◆ operator-=() [6/7]

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

Definition at line 1165 of file fvMatrix.C.

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

Here is the call graph for this function:

◆ operator+=() [7/7]

void operator+= ( const zero & )

Definition at line 1175 of file fvMatrix.C.

◆ operator-=() [7/7]

void operator-= ( const zero & )

Definition at line 1183 of file fvMatrix.C.

◆ operator*=() [1/4]

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

Definition at line 1191 of file fvMatrix.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator*=() [2/4]

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

Definition at line 1221 of file fvMatrix.C.

References fvMatrix< Type >::operator*=().

Here is the call graph for this function:

◆ operator*=() [3/4]

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

Definition at line 1232 of file fvMatrix.C.

References fvMatrix< Type >::operator*=().

Here is the call graph for this function:

◆ operator*=() [4/4]

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

Definition at line 1243 of file fvMatrix.C.

References Foam::checkMethod(), and 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 33 of file fvScalarMatrix.C.

References Foam::diag(), patchi, and fvMatrix< Type >::solver().

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 58 of file fvScalarMatrix.C.

References Foam::diag(), Foam::endl(), Foam::Info, messageStream::masterStream(), mesh, Foam::New(), and fvMatrix< Type >::fvSolver::solve().

Here is the call graph for this function:

◆ solveSegregated() [2/3]

Foam::solverPerformance solveSegregated ( const dictionary & solverControls )

Definition at line 138 of file fvScalarMatrix.C.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::diag(), Foam::endl(), Foam::Info, messageStream::masterStream(), mesh, DimensionedField< Type, GeoMesh >::mesh(), IOobject::name(), Foam::New(), GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), SolverPerformance< Type >::print(), psi, and solve().

Here is the call graph for this function:

◆ residual() [2/3]

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

Definition at line 187 of file fvScalarMatrix.C.

References tmp< T >::ref().

Here is the call graph for this function:

◆ H() [2/3]

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

Definition at line 211 of file fvScalarMatrix.C.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::dimVol, GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), and tmp< T >::ref().

Here is the call graph for this function:

◆ H1() [2/3]

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

Definition at line 243 of file fvScalarMatrix.C.

References Foam::dimVol, and GeometricField< Type, PatchField, GeoMesh >::ref().

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

Detailed Description

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

Member Typedef Documentation

◆ surfaceTypeFieldPtr

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]

◆ addBoundaryDiag()

◆ addCmptAvBoundaryDiag()

◆ addBoundarySource()

◆ setValuesFromList()

◆ ClassName()

◆ clone()

◆ psi()

◆ dimensions()

◆ source() [1/2]

◆ source() [2/2]

◆ internalCoeffs()

◆ boundaryCoeffs()

◆ faceFluxCorrectionPtr()

◆ setValues() [1/2]

◆ setValues() [2/2]

◆ setReference()

◆ setComponentReference() [1/3]

◆ relax() [1/2]

◆ relax() [2/2]

◆ boundaryManipulate()

◆ solver() [1/4]

◆ solver() [2/4]

◆ solve() [1/2]

◆ solveSegregated() [1/3]

◆ solveCoupled()

◆ solve() [2/2]

◆ residual() [1/3]

◆ D()

◆ DD()

◆ A()

◆ H() [1/3]

◆ H1() [1/3]

◆ flux()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ negate()

◆ operator+=() [1/7]

◆ operator+=() [2/7]

◆ operator-=() [1/7]

◆ operator-=() [2/7]

◆ operator+=() [3/7]

◆ operator+=() [4/7]

◆ operator+=() [5/7]

◆ operator-=() [3/7]

◆ operator-=() [4/7]

◆ operator-=() [5/7]

◆ operator+=() [6/7]

◆ operator-=() [6/7]

◆ operator+=() [7/7]

◆ operator-=() [7/7]

◆ operator*=() [1/4]

◆ operator*=() [2/4]

◆ operator*=() [3/4]

◆ operator*=() [4/4]

◆ setComponentReference() [2/3]

◆ solver() [3/4]

◆ solveSegregated() [2/3]

◆ residual() [2/3]

◆ H() [2/3]

◆ H1() [2/3]

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