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 Member Functions
	ClassName ("fvMatrix")

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

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

	fvMatrix (const tmp< fvMatrix< Type >> &)
	Copy constructor of tmp<fvMatrix<Type>> deleting argument. More...

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

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

virtual	~fvMatrix ()
	Destructor. More...

VolField< Type > &	psi ()

const VolField< Type > &	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...

SurfaceField< Type > *&	faceFluxCorrectionPtr ()
	Return pointer to face-flux non-orthogonal correction field. More...

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

template<template< class > class ListType>
void	setValues (const labelUList &cells, const ListType< Type > &values, const scalarList &fractions, const bool hasDdt=true)
	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...

scalar	relaxationFactor () const
	Return the relaxation factor for this equation. 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 VolField< Type >::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 (const word &name)
	Solve segregated or 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< VolInternalField< Type > >	Su () const
	Return the explicit source. More...

tmp< volScalarField::Internal >	Sp () const
	Return the implicit source. More...

tmp< VolField< Type > >	H () const
	Return the H operation source. More...

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

tmp< SurfaceField< Type > >	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, fvMesh > &)

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

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

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

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

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

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

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

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

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

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

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

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

Foam::solverPerformance	solveSegregated (const dictionary &solverControls)

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

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

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

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

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

solverPerformance	solveSegregated (const dictionary &)

tmp< scalarField >	residual () const

tmp< volScalarField >	H () const

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

void	operator= (const refCount &)=delete
	Disallow bitwise assignment. More...

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

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

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

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

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

void	setValue (const label celli, const Type &value)
	Set solution in the given cell to the specified value. More...

void	setValue (const label celli, const Type &value, const scalar fraction, const scalarField &ddtDiag)
	Set solution in the given cell to the specified value. More...

Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...

	refCount (const refCount &)=delete
	Disallow copy. More...

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

tmp< VolField< Type > >	operator& (const fvMatrix< Type > &, const DimensionedField< Type, fvMesh > &)

tmp< VolField< Type > >	operator& (const fvMatrix< Type > &, const tmp< VolField< Type >> &)

tmp< VolField< Type > >	operator& (const tmp< fvMatrix< Type >> &, const DimensionedField< Type, fvMesh > &)

tmp< VolField< Type > >	operator& (const tmp< fvMatrix< Type >> &, const tmp< VolField< Type >> &)

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 114 of file fvMatrix.H.

Constructor & Destructor Documentation

◆ fvMatrix() [1/4]

fvMatrix	(	const VolField< Type > &	psi,
		const dimensionSet &	ds
	)

Construct given a field to solve for.

Definition at line 284 of file fvMatrix.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryFieldRef(), Foam::endl(), regIOobject::eventNo(), forAll, InfoInFunction, patchi, fvMatrix< Type >::psi(), GeometricBoundaryField< Type, GeoMesh, PrimitiveField >::updateCoeffs(), and Foam::Zero.

Here is the call graph for this function:

◆ fvMatrix() [2/4]

fvMatrix ( const fvMatrix< Type > & fvm )

Copy constructor.

Definition at line 338 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 )

Copy constructor of tmp<fvMatrix<Type>> deleting argument.

Definition at line 367 of file fvMatrix.C.

References Foam::endl(), and InfoInFunction.

Here is the call graph for this function:

◆ fvMatrix() [4/4]

fvMatrix	(	const VolField< Type > &	psi,
		Istream &	is
	)

Construct from Istream given field to solve for.

Definition at line 421 of file fvMatrix.C.

References Foam::endl(), forAll, InfoInFunction, patchi, fvMatrix< Type >::psi(), and Foam::Zero.

Here is the call graph for this function:

◆ ~fvMatrix()

~fvMatrix

virtual

Destructor.

Definition at line 481 of file fvMatrix.C.

References Foam::endl(), and InfoInFunction.

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

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, UList< T >::size(), and List< T >::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 62 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 76 of file fvMatrix.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, UList< T >::size(), and List< T >::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 99 of file fvMatrix.C.

◆ addBoundaryDiag()

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

protected

Definition at line 112 of file fvMatrix.C.

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

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

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

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

Here is the call graph for this function:

◆ addBoundarySource()

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

protected

Definition at line 146 of file fvMatrix.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValue() [1/2]

void setValue	(	const label	celli,
		const Type &	value
	)

protected

Set solution in the given cell to the specified value.

Definition at line 178 of file fvMatrix.C.

References Foam::constant::universal::c, cells, primitiveMesh::cells(), Foam::diag(), forAll, primitiveMesh::isInternalFace(), mesh, fvMesh::neighbour(), primitiveMesh::nInternalFaces(), fvMesh::owner(), patches, fvMesh::polyBFacePatches(), fvMesh::polyBFacePatchFaces(), primitiveFieldRef(), psi, and Foam::Zero.

Here is the call graph for this function:

◆ setValue() [2/2]

void setValue	(	const label	celli,
		const Type &	value,
		const scalar	fraction,
		const scalarField &	ddtDiag
	)

protected

Set solution in the given cell to the specified value.

Definition at line 258 of file fvMatrix.C.

References Foam::diag(), Foam::units::fraction, primitiveFieldRef(), and psi.

Here is the call graph for this function:

◆ ClassName()

ClassName ( "fvMatrix< Type >" )

◆ clone()

Foam::tmp< Foam::fvMatrix< Type > > clone

Clone.

Definition at line 469 of file fvMatrix.C.

◆ psi() [1/2]

VolField<Type>& psi ( )

inline

Definition at line 289 of file fvMatrix.H.

Referenced by fvTotalSource::addSource(), interfaceTurbulenceDamping::addSup(), VoFSolidificationMelting::addSup(), oneResistanceHeatTransfer::addSup(), twoResistanceHeatTransfer::addSup(), VoFCavitation::addSup(), VoFClouds::addSup(), VoFFilmTransfer::addSup(), heatTransferLimitedPhaseChange::addSup(), homogeneousNucleation::addSup(), massDiffusionLimitedPhaseChange::addSup(), multiphaseEulerCavitation::addSup(), phaseSurfaceBoiling::addSup(), phaseSurfaceCondensation::addSup(), wallBoiling::addSup(), wallCondensation::addSup(), coefficientPhaseChange::addSup(), coefficientMassTransfer::addSup(), waveForcing::addSup(), filmCloudTransfer::addSup(), filmVoFTransfer::addSup(), bXiKernelCorr::addSup(), constantbXiIgnition::addSup(), GaussianbXiIgnition::addSup(), VoFTurbulenceDamping::addSup(), solidThermalEquilibrium::addSup(), radiation::addSup(), clouds::addSup(), porosityForce::addSup(), solidificationMelting::addSup(), interRegionPorosityForce::addSup(), massSourceBase::addSup(), massTransfer::addSup(), volumeSource::addSup(), cloud::addSup(), fvSpecificSource::addSupType(), fvTotalSource::addSupType(), massTransfer::addSupType(), Foam::checkMethod(), fvConstraints::constrain(), fvMatrix< Type >::fvMatrix(), Foam::operator+=(), Foam::operator-=(), zeroDimensionalFixedPressureConstraint::pEqnSource(), fvMatrix< Type >::fvSolver::solve(), and fvMatrix< Type >::solveSegregated().

Here is the caller graph for this function:

◆ psi() [2/2]

const VolField<Type>& psi ( ) const

inline

Definition at line 297 of file fvMatrix.H.

◆ dimensions()

const dimensionSet& dimensions ( ) const

inline

Definition at line 302 of file fvMatrix.H.

Referenced by fvTotalSource::addSource(), porosityForce::addSup(), interRegionPorosityForce::addSup(), rotorDisk::addSup(), fvTotalSource::addSupType(), massTransfer::addSupType(), Foam::checkMethod(), zeroDimensionalFixedPressureConstraint::constrain(), meanVelocityForce::constrain(), fvMatrix< Type >::operator*=(), Foam::operator+=(), Foam::operator-=(), fvMatrix< Type >::operator/=(), and zeroDimensionalFixedPressureConstraint::pEqnSource().

Here is the caller graph for this function:

◆ source() [1/2]

Field<Type>& source ( )

inline

Definition at line 307 of file fvMatrix.H.

Referenced by fvTotalSource::addSource(), propellerDisk::addSup(), heatSource::addSup(), effectivenessHeatExchanger::addSup(), actuationDisk::addSup(), radialActuationDisk::addSup(), solidificationMelting::addSup(), fvTotalSource::addSupType(), XiFluid::burn(), EulerD2dt2Scheme< Type >::fvmD2dt2(), backwardDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), EulerDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), gaussLaplacianScheme< Type, GType >::fvmLaplacian(), isothermalFilm::momentumPredictor(), Foam::operator+=(), Foam::operator-=(), incompressibleDenseParticleFluid::prePredictor(), ThermoCloud< CloudType >::Sh(), ReactingCloud< CloudType >::Srho(), MomentumCloud< CloudType >::SU(), and ReactingCloud< CloudType >::SYi().

Here is the caller graph for this function:

◆ source() [2/2]

const Field<Type>& source ( ) const

inline

Definition at line 312 of file fvMatrix.H.

◆ internalCoeffs()

FieldField<Field, Type>& internalCoeffs ( )

inline

fvBoundary scalar field containing pseudo-matrix coeffs

for internal cells

Definition at line 319 of file fvMatrix.H.

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

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 326 of file fvMatrix.H.

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

Here is the caller graph for this function:

◆ faceFluxCorrectionPtr()

SurfaceField<Type>*& faceFluxCorrectionPtr ( )

inline

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

Definition at line 332 of file fvMatrix.H.

Referenced by XiFluid::burn(), gaussConvectionScheme< Type >::fvmDiv(), and gaussLaplacianScheme< Type, GType >::fvmLaplacian().

Here is the caller graph for this function:

◆ setValues() [1/2]

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

Set solution in given cells to the specified values.

and eliminate the corresponding equations from the matrix.

Definition at line 500 of file fvMatrix.C.

References forAll.

Referenced by fixedTemperature::constrain(), and fixedInternalValueFvPatchField< Type >::manipulateMatrix().

Here is the caller graph for this function:

◆ setValues() [2/2]

void setValues	(	const labelUList &	cells,
		const ListType< Type > &	values,
		const scalarList &	fractions,
		const bool	hasDdt = `true`
	)

Set solution in given cells to the specified values.

and eliminate the corresponding equations from the matrix.

Definition at line 516 of file fvMatrix.C.

References alpha(), Foam::fvm::ddt(), lduMatrix::diag(), Foam::diag(), forAll, fractions(), and lduMatrix::hasDiag().

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

References Foam::diag().

Referenced by Foam::fv::CorrectPhi(), incompressibleDenseParticleFluid::correctPressure(), incompressibleFluid::correctPressure(), twoPhaseSolver::incompressiblePressureCorrector(), main(), and incompressibleMultiphaseVoF::pressureCorrector().

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(), and patchi.

Here is the call graph for this function:

◆ relaxationFactor()

Foam::scalar relaxationFactor

Return the relaxation factor for this equation.

Definition at line 577 of file fvMatrix.C.

References solutionControl::finalIteration().

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

References alpha(), Foam::cmptMag(), Foam::cmptMax(), Foam::cmptMin(), Foam::component(), fvPatchField< Type >::coupled(), Foam::saturationModels::D, Foam::diag(), Foam::endl(), forAll, InfoInFunction, Foam::mag(), Foam::max(), UPstream::msgType(), Foam::nl, patchi, Foam::reduce(), Foam::returnReduce(), Foam::fvm::S(), and List< T >::size().

Referenced by XiFluid::burn(), kineticTheoryModel::correct(), IATE::correct(), transport::correct(), Maxwell< BasicMomentumTransportModel >::correct(), dynamicLagrangian< BasicMomentumTransportModel >::correct(), radiativeIntensityRay::correct(), advectionDiffusion::correct(), age::execute(), phaseScalarTransport::execute(), scalarTransport::execute(), XiFluid::HbSolve(), XiFluid::HuSolve(), main(), incompressibleDenseParticleFluid::momentumPredictor(), populationBalanceModel::solve(), fractal::solve(), compressibleMultiphaseVoF::thermophysicalPredictor(), compressibleVoF::thermophysicalPredictor(), film::thermophysicalPredictor(), multicomponentFluid::thermophysicalPredictor(), solid::thermophysicalPredictor(), and XiFluid::ubSolve().

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

References relax().

Here is the call graph for this function:

◆ boundaryManipulate()

void boundaryManipulate ( typename VolField< Type >::Boundary & values )

Manipulate based on a boundary field.

Definition at line 760 of file fvMatrix.C.

References forAll, and patchi.

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

◆ solve() [1/3]

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(), mesh, dictionary::readIfPresent(), and Foam::type().

Referenced by XiFluid::burn(), Implicit< CloudType >::cacheFields(), kineticTheoryModel::correct(), IATE::correct(), transport::correct(), solidElectricalConduction::correct(), Maxwell< BasicMomentumTransportModel >::correct(), dynamicLagrangian< BasicMomentumTransportModel >::correct(), advectionDiffusion::correct(), Foam::fv::CorrectPhi(), incompressibleDenseParticleFluid::correctPressure(), incompressibleFluid::correctPressure(), age::execute(), phaseScalarTransport::execute(), scalarTransport::execute(), XiFluid::HbSolve(), XiFluid::HuSolve(), Foam::hydrostaticInitialisation(), twoPhaseSolver::incompressiblePressureCorrector(), main(), incompressibleDriftFlux::prePredictor(), compressibleMultiphaseVoF::pressureCorrector(), compressibleVoF::pressureCorrector(), incompressibleMultiphaseVoF::pressureCorrector(), solidDisplacement::pressureCorrector(), populationBalanceModel::solve(), fractal::solve(), phaseSystem::solve(), compressibleMultiphaseVoF::thermophysicalPredictor(), compressibleVoF::thermophysicalPredictor(), film::thermophysicalPredictor(), multicomponentFluid::thermophysicalPredictor(), solid::thermophysicalPredictor(), and XiFluid::ubSolve().

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 Field< Type >::component(), Foam::diag(), Foam::endl(), Foam::Info, mesh, Foam::New(), SolverPerformance< Type >::print(), psi, GeometricField< Type, GeoMesh, PrimitiveField >::replace(), 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 220 of file fvMatrixSolve.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::component(), Foam::diag(), Foam::endl(), Foam::Info, mesh, SolverPerformance< Type >::print(), and psi.

Here is the call graph for this function:

◆ solve() [2/3]

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

Solve segregated or coupled returning the solution statistics.

Solver controls read from fvSolution

Definition at line 315 of file fvMatrixSolve.C.

References solutionControl::finalIteration(), Foam::name(), and fvMatrix< Type >::solve().

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

References solutionControl::finalIteration().

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

Return the matrix residual.

Definition at line 348 of file fvMatrixSolve.C.

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

Here is the call graph for this function:

◆ D()

Foam::tmp< Foam::scalarField > D

Return the matrix scalar diagonal.

Definition at line 774 of file fvMatrix.C.

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

Here is the call graph for this function:

◆ DD()

Foam::tmp< Foam::Field< Type > > DD

Return the matrix Type diagonal.

Definition at line 783 of file fvMatrix.C.

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

Here is the call graph for this function:

◆ A()

Foam::tmp< Foam::volScalarField > A

Return the central coefficient.

Definition at line 807 of file fvMatrix.C.

References Foam::saturationModels::D, Foam::dimVolume, GeometricField< Type, GeoMesh, PrimitiveField >::New(), tmp< T >::ref(), and Foam::typeName().

Referenced by meanVelocityForce::constrain(), incompressibleDenseParticleFluid::correctPressure(), momentumTransferSystem::invADVfs(), momentumTransferSystem::invADVs(), main(), and compressibleVoF::thermophysicalPredictor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Su()

Foam::tmp< Foam::VolInternalField< Type > > Su

Return the explicit source.

Definition at line 828 of file fvMatrix.C.

References Foam::dimVolume.

Referenced by compressibleVoF::alphaSuSp(), incompressibleDriftFlux::alphaSuSp(), incompressibleVoF::alphaSuSp(), and XiFluid::burn().

Here is the caller graph for this function:

◆ Sp()

Foam::tmp< Foam::volScalarField::Internal > Sp

Return the implicit source.

Definition at line 846 of file fvMatrix.C.

References Foam::diag(), Foam::dimVolume, and DimensionedField< Type, GeoMesh, PrimitiveField >::New().

Referenced by compressibleVoF::alphaSuSp(), incompressibleDriftFlux::alphaSuSp(), incompressibleVoF::alphaSuSp(), and XiFluid::burn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ H() [1/3]

Foam::tmp< Foam::VolField< Type > > H

Return the H operation source.

Definition at line 867 of file fvMatrix.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::correctBoundaryConditions(), DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), Foam::dimVolume, lduMatrix::H(), Field< Type >::negate(), GeometricField< Type, GeoMesh, PrimitiveField >::primitiveFieldRef(), tmp< T >::ref(), GeometricField< Type, GeoMesh, PrimitiveField >::replace(), and Foam::typeName().

Referenced by incompressibleDenseParticleFluid::correctPressure(), momentumTransferSystem::invADVfs(), momentumTransferSystem::invADVs(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ H1() [1/3]

Foam::tmp< Foam::volScalarField > H1

Return H(1)

Definition at line 922 of file fvMatrix.C.

References Foam::component(), GeometricField< Type, GeoMesh, PrimitiveField >::correctBoundaryConditions(), fvPatchField< Type >::coupled(), Foam::dimVolume, forAll, lduMatrix::H1(), GeometricField< Type, GeoMesh, PrimitiveField >::New(), patchi, GeometricField< Type, GeoMesh, PrimitiveField >::primitiveFieldRef(), tmp< T >::ref(), List< T >::size(), and Foam::typeName().

Here is the call graph for this function:

◆ flux()

Foam::tmp< Foam::SurfaceField< Type > > flux

Return the face-flux field from the matrix.

Definition at line 962 of file fvMatrix.C.

References Foam::abort(), GeometricField< Type, GeoMesh, PrimitiveField >::boundaryFieldRef(), Foam::cmptMultiply(), lduMatrix::faceH(), Foam::FatalError, FatalErrorInFunction, forAll, patchi, GeometricField< Type, GeoMesh, PrimitiveField >::primitiveFieldRef(), and tmp< T >::ref().

Referenced by XiFluid::burn(), Implicit< CloudType >::cacheFields(), solidElectricalConduction::correct(), Foam::fv::CorrectPhi(), incompressibleDenseParticleFluid::correctPressure(), incompressibleFluid::correctPressure(), twoPhaseSolver::incompressiblePressureCorrector(), main(), incompressibleDriftFlux::prePredictor(), compressibleMultiphaseVoF::pressureCorrector(), compressibleVoF::pressureCorrector(), incompressibleMultiphaseVoF::pressureCorrector(), solidDisplacement::pressureCorrector(), and phaseSystem::solve().

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

◆ negate()

void negate

Definition at line 1087 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 1102 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 1128 of file fvMatrix.C.

References Foam::operator+=().

Here is the call graph for this function:

◆ operator-=() [1/7]

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

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

References Foam::operator-=().

Here is the call graph for this function:

◆ operator+=() [3/7]

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

Definition at line 1168 of file fvMatrix.C.

References Foam::checkMethod().

Here is the call graph for this function:

◆ operator+=() [4/7]

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

Definition at line 1179 of file fvMatrix.C.

References Foam::operator+=().

Here is the call graph for this function:

◆ operator+=() [5/7]

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

Definition at line 1190 of file fvMatrix.C.

References Foam::operator+=().

Here is the call graph for this function:

◆ operator-=() [3/7]

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

Definition at line 1201 of file fvMatrix.C.

References Foam::checkMethod().

Here is the call graph for this function:

◆ operator-=() [4/7]

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

Definition at line 1212 of file fvMatrix.C.

References Foam::operator-=().

Here is the call graph for this function:

◆ operator-=() [5/7]

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

Definition at line 1223 of file fvMatrix.C.

References Foam::operator-=().

Here is the call graph for this function:

◆ operator+=() [6/7]

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

Definition at line 1234 of file fvMatrix.C.

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

Here is the call graph for this function:

◆ operator-=() [6/7]

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

Definition at line 1244 of file fvMatrix.C.

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

Here is the call graph for this function:

◆ operator+=() [7/7]

void operator+= ( const zero & )

Definition at line 1254 of file fvMatrix.C.

◆ operator-=() [7/7]

void operator-= ( const zero & )

Definition at line 1262 of file fvMatrix.C.

◆ operator*=() [1/4]

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

Definition at line 1270 of file fvMatrix.C.

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

Here is the call graph for this function:

◆ operator*=() [2/4]

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

Definition at line 1303 of file fvMatrix.C.

References Foam::operator*=().

Here is the call graph for this function:

◆ operator*=() [3/4]

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

Definition at line 1314 of file fvMatrix.C.

References Foam::operator*=().

Here is the call graph for this function:

◆ operator*=() [4/4]

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

Definition at line 1325 of file fvMatrix.C.

References fvMatrix< Type >::dimensions(), and lduMatrix::operator*=().

Here is the call graph for this function:

◆ operator/=() [1/4]

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

Definition at line 1344 of file fvMatrix.C.

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

Here is the call graph for this function:

◆ operator/=() [2/4]

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

Definition at line 1377 of file fvMatrix.C.

◆ operator/=() [3/4]

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

Definition at line 1388 of file fvMatrix.C.

◆ operator/=() [4/4]

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

Definition at line 1399 of file fvMatrix.C.

References fvMatrix< Type >::dimensions(), 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(), and patchi.

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, mesh, and Foam::New().

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 fvMatrix< Type >::addBoundaryDiag(), fvMatrix< Type >::addBoundarySource(), Residuals< Type >::append(), lduMatrix::diag(), Foam::endl(), Foam::Info, lduMatrix::mesh(), lduMatrix::solver::New(), SolverPerformance< Type >::print(), and fvMatrix< Type >::psi().

Here is the call graph for this function:

◆ residual() [2/3]

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

Definition at line 188 of file fvScalarMatrix.C.

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

Here is the call graph for this function:

◆ H() [2/3]

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

Definition at line 212 of file fvScalarMatrix.C.

References fvMatrix< Type >::addBoundarySource(), GeometricField< Type, GeoMesh, PrimitiveField >::correctBoundaryConditions(), Foam::dimVolume, lduMatrix::H(), GeometricField< Type, GeoMesh, PrimitiveField >::New(), GeometricField< Type, GeoMesh, PrimitiveField >::primitiveFieldRef(), tmp< T >::ref(), and Foam::typeName().

Here is the call graph for this function:

◆ H1() [2/3]

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

Definition at line 237 of file fvScalarMatrix.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::correctBoundaryConditions(), Foam::dimVolume, lduMatrix::H1(), GeometricField< Type, GeoMesh, PrimitiveField >::New(), GeometricField< Type, GeoMesh, PrimitiveField >::primitiveFieldRef(), tmp< T >::ref(), and Foam::typeName().

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 147 of file fvMatrix.H.

◆ operator& [1/4]

tmp<VolField<Type> > operator&	(	const fvMatrix< Type > &	,
		const DimensionedField< Type, fvMesh > &
	)

friend

◆ operator& [2/4]

tmp<VolField<Type> > operator&	(	const fvMatrix< Type > &	,
		const tmp< VolField< Type >> &
	)

friend

◆ operator& [3/4]

tmp<VolField<Type> > operator&	(	const tmp< fvMatrix< Type >> &	,
		const DimensionedField< Type, fvMesh > &
	)

friend

◆ operator& [4/4]

tmp<VolField<Type> > operator&	(	const tmp< fvMatrix< Type >> &	,
		const tmp< VolField< Type >> &
	)

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 Member Functions

Protected Member Functions

Friends

Detailed Description

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

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()

◆ setValue() [1/2]

◆ setValue() [2/2]

◆ ClassName()

◆ clone()

◆ psi() [1/2]

◆ psi() [2/2]

◆ dimensions()

◆ source() [1/2]

◆ source() [2/2]

◆ internalCoeffs()

◆ boundaryCoeffs()

◆ faceFluxCorrectionPtr()

◆ setValues() [1/2]

◆ setValues() [2/2]

◆ setReference()

◆ setComponentReference() [1/3]

◆ relaxationFactor()

◆ relax() [1/2]

◆ relax() [2/2]

◆ boundaryManipulate()

◆ solver() [1/4]

◆ solver() [2/4]

◆ solve() [1/3]

◆ solveSegregated() [1/3]

◆ solveCoupled()

◆ solve() [2/3]

◆ solve() [3/3]

◆ residual() [1/3]

◆ D()

◆ DD()

◆ A()

◆ Su()

◆ Sp()

◆ 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]

◆ operator/=() [1/4]

◆ operator/=() [2/4]

◆ operator/=() [3/4]

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