A finiteVolume patch using a polyPatch and a fvBoundaryMesh. More...

Inheritance diagram for fvPatch:

[legend]

Public Types
typedef fvBoundaryMesh	BoundaryMesh
	The boundary type associated with the patch. More...

Public Member Functions
virtual void	makeWeights (scalarField &) const
	Make patch weighting factors. More...

virtual void	makeDeltaCoeffs (scalarField &) const
	Correct patch deltaCoeffs. More...

virtual void	makeNonOrthoDeltaCoeffs (scalarField &) const
	Correct patch non-ortho deltaCoeffs. More...

virtual void	makeNonOrthoCorrVectors (vectorField &) const
	Correct patch non-ortho correction vectors. More...

virtual void	initMovePoints ()
	Initialise the patches for moving points. More...

virtual void	movePoints ()
	Correct patches after moving points. More...

	TypeName (polyPatch::typeName_())
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, fvPatch, polyPatch,(const polyPatch &patch, const fvBoundaryMesh &bm),(patch, bm))

	fvPatch (const polyPatch &, const fvBoundaryMesh &)
	Construct from polyPatch and fvBoundaryMesh. More...

virtual	~fvPatch ()
	Destructor. More...

const polyPatch &	patch () const noexcept
	Return the polyPatch. More...

virtual const word &	name () const
	Return name. More...

virtual label	start () const
	Return start label of this patch in the polyMesh face list. More...

virtual label	size () const
	Return size. More...

virtual bool	coupled () const
	Return true if this patch is coupled. More...

label	index () const noexcept
	Return the index of this patch in the fvBoundaryMesh. More...

const fvBoundaryMesh &	boundaryMesh () const noexcept
	Return boundaryMesh reference. More...

template<class T >
const List< T >::subList	patchSlice (const List< T > &l) const
	Slice List to patch, using the virtual patch size. More...

template<class T >
const List< T >::subList	patchRawSlice (const List< T > &l) const
	Slice List to patch, using the underlying polyPatch information. More...

virtual const labelUList &	faceCells () const
	Return faceCells. More...

const vectorField &	Cf () const
	Return face centres. More...

tmp< vectorField >	Cn () const
	Return neighbour cell centres. More...

const vectorField &	Sf () const
	Return face area vectors. More...

const scalarField &	magSf () const
	Return face area magnitudes. More...

tmp< vectorField >	nf () const
	Return face normals. More...

virtual tmp< vectorField >	delta () const
	Return cell-centre to face-centre vector except for coupled patches for which the cell-centre to coupled-cell-centre vector is returned. More...

const scalarField &	weights () const
	Return patch weighting factors. More...

const scalarField &	deltaCoeffs () const
	Return the face - cell distance coefficient except for coupled patches for which the cell-centre to coupled-cell-centre distance coefficient is returned. More...

template<class Type >
void	patchInternalField (const UList< Type > &f, const labelUList &faceCells, Field< Type > &pfld) const
	Extract internal field next to patch using faceCells mapping. More...

template<class Type >
tmp< Field< Type > >	patchInternalField (const UList< Type > &) const
	Return given internal field next to patch as patch field. More...

template<class Type >
tmp< Field< Type > >	patchInternalField (const UList< Type > &f, const labelUList &faceCells) const
	Return given internal field next to patch as patch field using provided addressing. More...

template<class Type >
void	patchInternalField (const UList< Type > &, Field< Type > &) const
	Return given internal field next to patch as patch field. More...

template<class GeometricField , class AnyType = bool>
const GeometricField::Patch &	patchField (const GeometricField &gf) const
	Return the patch field of the GeometricField corresponding to this patch. More...

template<class GeometricField , class AnyType = bool>
const GeometricField::Patch &	lookupPatchField (const word &name, const GeometricField =nullptr, const AnyType =nullptr) const
	Lookup the named field from the local registry and return the patch field corresponding to this patch. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	patchInternalField (const UList< Type > &f) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	patchInternalField (const UList< Type > &f, const labelUList &faceCells) const

Static Public Member Functions
static autoPtr< fvPatch >	New (const polyPatch &, const fvBoundaryMesh &)
	Return a pointer to a new patch created on freestore from polyPatch. More...

static const fvPatch &	lookupPatch (const polyPatch &p)
	Lookup the polyPatch index on corresponding fvMesh. More...

static bool	constraintType (const word &patchType)
	Return true if the given type is a constraint type. More...

static wordList	constraintTypes ()
	Return a list of all the constraint patch types. More...

Friends
class	fvBoundaryMesh

class	surfaceInterpolation

Detailed Description

A finiteVolume patch using a polyPatch and a fvBoundaryMesh.

Source files

Definition at line 68 of file fvPatch.H.

Member Typedef Documentation

◆ BoundaryMesh

typedef fvBoundaryMesh BoundaryMesh

The boundary type associated with the patch.

Definition at line 136 of file fvPatch.H.

Constructor & Destructor Documentation

◆ fvPatch()

fvPatch	(	const polyPatch &	p,
		const fvBoundaryMesh &	bm
	)

Construct from polyPatch and fvBoundaryMesh.

Definition at line 59 of file fvPatch.C.

◆ ~fvPatch()

~fvPatch ( )

virtual

Destructor.

Definition at line 68 of file fvPatch.C.

Member Function Documentation

◆ makeWeights()

void makeWeights ( scalarField & w ) const

virtual

Make patch weighting factors.

Reimplemented in cyclicACMIFvPatch, cyclicFvPatch, cyclicAMIFvPatch, coupledFvPatch, and processorFvPatch.

Definition at line 151 of file fvPatch.C.

Referenced by cyclicAMIFvPatch::makeWeights(), and cyclicACMIFvPatch::makeWeights().

Here is the caller graph for this function:

◆ makeDeltaCoeffs()

void makeDeltaCoeffs ( scalarField & w ) const

virtual

Correct patch deltaCoeffs.

Reimplemented in cyclicAMIFvPatch, and mappedVariableThicknessWallFvPatch.

Definition at line 157 of file fvPatch.C.

◆ makeNonOrthoDeltaCoeffs()

void makeNonOrthoDeltaCoeffs ( scalarField & w ) const

virtual

Correct patch non-ortho deltaCoeffs.

Reimplemented in cyclicAMIFvPatch.

Definition at line 161 of file fvPatch.C.

◆ makeNonOrthoCorrVectors()

void makeNonOrthoCorrVectors ( vectorField & w ) const

virtual

Correct patch non-ortho correction vectors.

Reimplemented in cyclicAMIFvPatch.

Definition at line 165 of file fvPatch.C.

◆ initMovePoints()

void initMovePoints ( )

virtual

Initialise the patches for moving points.

Definition at line 169 of file fvPatch.C.

◆ movePoints()

void movePoints ( )

virtual

Correct patches after moving points.

Reimplemented in cyclicACMIFvPatch, and cyclicAMIFvPatch.

Definition at line 173 of file fvPatch.C.

◆ TypeName()

TypeName ( polyPatch::typeName_() )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		fvPatch	,
		polyPatch	,
		(const polyPatch &patch, const fvBoundaryMesh &bm)	,
		(patch, bm)
	)

◆ New()

Foam::autoPtr< Foam::fvPatch > New	(	const polyPatch &	patch,
		const fvBoundaryMesh &	bm
	)

static

Return a pointer to a new patch created on freestore from polyPatch.

Definition at line 28 of file fvPatchNew.C.

References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, and Foam::foamVersion::patch.

Referenced by fvMeshAdder::add(), and meshRefinement::appendPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupPatch()

const Foam::fvPatch & lookupPatch ( const polyPatch & p )

static

Lookup the polyPatch index on corresponding fvMesh.

Note: Fatal if the polyPatch is not associated with a fvMesh

Definition at line 42 of file fvPatch.C.

References fvMesh::boundary(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and p.

Here is the call graph for this function:

◆ patch()

const polyPatch& patch ( ) const

inlinenoexcept

Return the polyPatch.

Definition at line 200 of file fvPatch.H.

Referenced by reconstructedDistanceFunction::constructRDF(), Foam::evaluateConstraintTypes(), mappedVariableThicknessWallFvPatch::makeDeltaCoeffs(), trackingInverseDistance::markBoundaries(), inverseDistance::markBoundaries(), cyclicACMIFvPatch::movePoints(), parseDriver::pointSize(), cyclicACMIFvPatch::resetPatchAreas(), parseDriver::size(), outletMappedUniformInletHeatAdditionFvPatchField::updateCoeffs(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs(), and regionSizeDistribution::write().

Here is the caller graph for this function:

◆ name()

virtual const word& name ( ) const

inlinevirtual

Return name.

Definition at line 208 of file fvPatch.H.

References patchIdentifier::name().

Referenced by fieldExtents::calcFieldExtents(), wallHeatFlux::execute(), meshToMesh0::interpolate(), oversetFvPatchField< Type >::manipulateMatrix(), fvMeshDistribute::testField(), cyclicACMIFvPatch::updateAreas(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), thermalBaffle1DFvPatchScalarField< solidType >::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), and wallShearStress::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ start()

virtual label start ( ) const

inlinevirtual

Return start label of this patch in the polyMesh face list.

Definition at line 216 of file fvPatch.H.

References polyPatch::start().

Referenced by CentredFitSnGradData< Polynomial >::calcFit(), inverseFaceDistanceDiffusivity::correct(), inversePointDistanceDiffusivity::correct(), pointLinear< Type >::correction(), dynamicRefineFvMesh::mapFields(), fvMeshAdder::MapSurfaceField(), Foam::oversetAdjustPhi(), fvPatch::patchSlice(), oversetFvPatchField< Type >::storeFringeCoefficients(), fvMeshDistribute::testField(), and mappedVelocityFluxFixedValueFvPatchField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ size()

virtual label size ( ) const

inlinevirtual

Return size.

Reimplemented in emptyFvPatch.

Definition at line 224 of file fvPatch.H.

Here is the caller graph for this function:

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Return true if this patch is coupled.

Reimplemented in cyclicAMIFvPatch, cyclicACMIFvPatch, processorFvPatch, and coupledFvPatch.

Definition at line 232 of file fvPatch.H.

References polyPatch::coupled().

Here is the call graph for this function:

◆ constraintType()

bool constraintType ( const word & patchType )

static

Return true if the given type is a constraint type.

Definition at line 74 of file fvPatch.C.

References UList< T >::found().

Here is the call graph for this function:

◆ constraintTypes()

Foam::wordList constraintTypes ( )

static

Return a list of all the constraint patch types.

Definition at line 85 of file fvPatch.C.

References forAllConstIters().

Here is the call graph for this function:

◆ index()

label index ( ) const

inlinenoexcept

Return the index of this patch in the fvBoundaryMesh.

Definition at line 250 of file fvPatch.H.

References patchIdentifier::index().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ boundaryMesh()

const fvBoundaryMesh& boundaryMesh ( ) const

inlinenoexcept

Return boundaryMesh reference.

Definition at line 258 of file fvPatch.H.

Referenced by cyclicAMIFvPatch::coupled(), parseDriver::mesh(), cyclicFvPatch::neighbFvPatch(), cyclicACMIFvPatch::neighbFvPatch(), cyclicAMIFvPatch::neighbFvPatch(), cyclicFvPatch::neighbPatch(), cyclicACMIFvPatch::neighbPatch(), cyclicAMIFvPatch::neighbPatch(), cyclicACMIFvPatch::nonOverlapPatch(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), outletMappedUniformInletHeatAdditionFvPatchField::updateCoeffs(), and porousBafflePressureFvPatchField< Type >::updateCoeffs().

Here is the caller graph for this function:

◆ patchSlice()

const List<T>::subList patchSlice ( const List< T > & l ) const

inline

Slice List to patch, using the virtual patch size.

Definition at line 267 of file fvPatch.H.

References fvPatch::size(), and fvPatch::start().

Referenced by fvFieldDecomposer::reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patchRawSlice()

const List<T>::subList patchRawSlice ( const List< T > & l ) const

inline

Slice List to patch, using the underlying polyPatch information.

Definition at line 277 of file fvPatch.H.

References polyPatch::start().

Here is the call graph for this function:

◆ faceCells()

const Foam::labelUList & faceCells ( ) const

virtual

Return faceCells.

Reimplemented in coupledFvPatch, oversetFvPatch, and emptyFvPatch.

Definition at line 107 of file fvPatch.C.

Referenced by curvatureSeparation::calcCosAngle(), omegaWallFunctionFvPatchScalarField::calculateTurbulenceFields(), epsilonWallFunctionFvPatchScalarField::calculateTurbulenceFields(), inverseFaceDistanceDiffusivity::correct(), inversePointDistanceDiffusivity::correct(), contactAngleForce::correct(), SSG< BasicTurbulenceModel >::correct(), LRR< BasicTurbulenceModel >::correct(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), pointLinear< Type >::correction(), coupledFvPatch::faceCells(), cellVolumeWeight::findHoles(), inverseDistance::findHoles(), trackingInverseDistance::markBoundaries(), inverseDistance::markBoundaries(), cellVolumeWeight::markPatchCells(), Foam::oversetAdjustPhi(), oversetFvPatchField< Type >::storeFringeCoefficients(), energyJumpAMIFvPatchScalarField::updateCoeffs(), energyJumpFvPatchScalarField::updateCoeffs(), and kLowReWallFunctionFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ Cf()

const Foam::vectorField & Cf ( ) const

Return face centres.

Definition at line 113 of file fvPatch.C.

References boundaryMesh::mesh().

Referenced by fieldExtents::calcFieldExtents(), meshToMesh0::interpolate(), cyclicAMIFvPatch::movePoints(), and cyclicACMIFvPatch::resetPatchAreas().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Cn()

Foam::tmp< Foam::vectorField > Cn ( ) const

Return neighbour cell centres.

Definition at line 119 of file fvPatch.C.

References mesh.

◆ Sf()

const Foam::vectorField & Sf ( ) const

Return face area vectors.

Definition at line 131 of file fvPatch.C.

References boundaryMesh::mesh().

Referenced by cyclicAMIFvPatch::movePoints(), cyclicACMIFvPatch::resetPatchAreas(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), and activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ magSf()

const Foam::scalarField & magSf ( ) const

Return face area magnitudes.

Definition at line 137 of file fvPatch.C.

References boundaryMesh::mesh().

Referenced by parseDriver::areaAverage(), parseDriver::areaSum(), parseDriver::field_faceArea(), cyclicAMIFvPatch::movePoints(), cyclicACMIFvPatch::movePoints(), cyclicACMIFvPatch::resetPatchAreas(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), outletMappedUniformInletHeatAdditionFvPatchField::updateCoeffs(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs(), and outletMappedUniformInletFvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nf()

Foam::tmp< Foam::vectorField > nf ( ) const

Return face normals.

Definition at line 125 of file fvPatch.C.

Referenced by curvatureSeparation::calcCosAngle(), ReynoldsAnalogy::Cf(), processorFvPatch::makeWeights(), cyclicFvPatch::makeWeights(), cyclicAMIFvPatch::makeWeights(), cyclicACMIFvPatch::makeWeights(), boundaryAdjointContributionIncompressible::pressureSource(), and boundaryAdjointContributionIncompressible::tangentVelocitySource().

Here is the caller graph for this function:

◆ delta()

Foam::tmp< Foam::vectorField > delta ( ) const

virtual

Return cell-centre to face-centre vector except for coupled patches for which the cell-centre to coupled-cell-centre vector is returned.

Reimplemented in cyclicAMIFvPatch, cyclicACMIFvPatch, cyclicFvPatch, processorFvPatch, and coupledFvPatch.

Definition at line 143 of file fvPatch.C.

◆ weights()

const Foam::scalarField & weights ( ) const

Return patch weighting factors.

Definition at line 183 of file fvPatch.C.

References boundaryMesh::mesh().

Here is the call graph for this function:

◆ deltaCoeffs()

const Foam::scalarField & deltaCoeffs ( ) const

Return the face - cell distance coefficient except for coupled patches for which the cell-centre to coupled-cell-centre distance coefficient is returned.

Definition at line 177 of file fvPatch.C.

References boundaryMesh::mesh().

Referenced by contactAngleForce::correct(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), and humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the call graph for this function: