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

Inheritance diagram for fvPatch:

[legend]

Collaboration diagram for fvPatch:

Public Types
typedef fvBoundaryMesh	BoundaryMesh

Public Member Functions
	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
	Return the polyPatch. More...

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

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
	Return the index of this patch in the fvBoundaryMesh. More...

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

template<class T >
const List< T >::subList	patchSlice (const List< T > &l) const
	Slice list to patch. 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. More...

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

const scalarField &	deltaCoeffs () const
	Return the face - cell distance coeffient. 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 >
void	patchInternalField (const UList< Type > &, Field< Type > &) const
	Return given internal field next to patch as patch field. More...

template<class GeometricField , class Type >
const GeometricField::PatchFieldType &	patchField (const GeometricField &) const
	Return the corresponding patchField of the named field. More...

template<class GeometricField , class Type >
const GeometricField::PatchFieldType &	lookupPatchField (const word &name, const GeometricField =NULL, const Type =NULL) const
	Lookup and return the patchField of the named field from the. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	patchInternalField (const UList< Type > &f) 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 bool	constraintType (const word &pt)
	Return true if the given type is a constraint type. More...

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

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

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

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

Private Member Functions
	fvPatch (const fvPatch &)
	Disallow construct as copy. More...

void	operator= (const fvPatch &)
	Disallow assignment. More...

Private Attributes
const polyPatch &	polyPatch_
	Reference to the underlying polyPatch. More...

const fvBoundaryMesh &	boundaryMesh_
	Reference to boundary mesh. More...

Friends
class	fvBoundaryMesh

class	surfaceInterpolation

Detailed Description

A finiteVolume patch using a polyPatch and a fvBoundaryMesh.

Source files

Definition at line 61 of file fvPatch.H.

Member Typedef Documentation

◆ BoundaryMesh

typedef fvBoundaryMesh BoundaryMesh

Definition at line 97 of file fvPatch.H.

Constructor & Destructor Documentation

◆ fvPatch() [1/2]

fvPatch ( const fvPatch & )

private

Disallow construct as copy.

◆ fvPatch() [2/2]

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

Construct from polyPatch and fvBoundaryMesh.

Definition at line 46 of file fvPatch.C.

◆ ~fvPatch()

~fvPatch ( )

virtual

Destructor.

Definition at line 55 of file fvPatch.C.

Member Function Documentation

◆ operator=()

void operator= ( const fvPatch & )

private

Disallow assignment.

◆ makeWeights()

void makeWeights ( scalarField & w ) const

protectedvirtual

Make patch weighting factors.

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

Definition at line 150 of file fvPatch.C.

References w().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initMovePoints()

void initMovePoints ( )

protectedvirtual

Initialise the patches for moving points.

Reimplemented in immersedBoundaryFvPatch.

Definition at line 156 of file fvPatch.C.

◆ movePoints()

void movePoints ( )

protectedvirtual

Correct patches after moving points.

Reimplemented in immersedBoundaryFvPatch.

Definition at line 160 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 33 of file fvPatchNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, and Foam::nl.

Referenced by fvBoundaryMesh::addPatches(), and meshRefinement::appendPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patch()

const polyPatch& patch ( ) const

inline

Return the polyPatch.

Definition at line 143 of file fvPatch.H.

References fvPatch::polyPatch_.

Referenced by nearWallFields::calcAddressing(), nearWallDist::calculate(), vtkPV4Foam::convertVolField(), vtkPV3Foam::convertVolFields(), fvMeshSubset::interpolate(), mappedVariableThicknessWallFvPatch::makeDeltaCoeffs(), SLTSDdtScheme< Type >::relaxedDiag(), cyclicACMIFvPatch::updateAreas(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs(), energyRegionCoupledFvPatchScalarField::weights(), regionSizeDistribution::write(), and Foam::writeSurfFields().

Here is the caller graph for this function:

◆ name()

const word& name ( ) const

inline

Return name.

Definition at line 149 of file fvPatch.H.

References patchIdentifier::name(), and fvPatch::polyPatch_.

Referenced by fvPatchMapper::calcAddressing(), yPlus::calcYPlus(), fWallFunctionFvPatchScalarField::checkType(), v2WallFunctionFvPatchScalarField::checkType(), kLowReWallFunctionFvPatchScalarField::checkType(), epsilonWallFunctionFvPatchScalarField::checkType(), omegaWallFunctionFvPatchScalarField::checkType(), meshToMesh0::interpolate(), immersedBoundaryFvPatch::makeGamma(), immersedBoundaryFvPatch::makeTriAddressing(), epsilonWallFunctionFvPatchScalarField::manipulateMatrix(), omegaWallFunctionFvPatchScalarField::manipulateMatrix(), fvMeshDistribute::testField(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), coupledFixedValueFvPatchField< Type >::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), turbulentBoundaryCoupledFvPatchScalarField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), thermalBaffle1DFvPatchScalarField< solidType >::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), yPlusWriter::write(), wallHeatFluxWriter::write(), and wallShearStressWriter::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ start()

label start ( ) const

inline

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

Definition at line 155 of file fvPatch.H.

References fvPatch::polyPatch_, and polyPatch::start().

Referenced by nearWallFields::calcAddressing(), CentredFitData< Polynomial >::calcFit(), UpwindFitData< Polynomial >::calcFit(), CentredFitSnGradData< Polynomial >::calcFit(), Foam::fvc::cellReduce(), extendedFaceToCellStencil::collectData(), extendedCellToFaceStencil::collectData(), inverseFaceDistanceDiffusivity::correct(), inversePointDistanceDiffusivity::correct(), pointLinear< Type >::correction(), fvMeshSubset::interpolate(), fvMeshDistribute::mapBoundaryFields(), fvMeshDistribute::mapExposedFaces(), mappedPatchFieldBase< Type >::mappedField(), fvPatch::patchSlice(), parFvFieldReconstructor::reconstructFvSurfaceField(), dynamicRefineFvMesh::refine(), fvMeshDistribute::testField(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), myMappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), mappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), extendedUpwindCellToFaceStencil::weightedSum(), and extendedCellToFaceStencil::weightedSum().

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 161 of file fvPatch.H.

References fvPatch::polyPatch_.

Referenced by cyclicAMIFvPatch::coupled(), cyclicACMIFvPatch::delta(), fvMeshSubset::interpolate(), immersedBoundaryFvPatch::makeIbSamplingWeights(), immersedBoundaryFvPatch::makeTriAddressing(), epsilonWallFunctionFvPatchScalarField::manipulateMatrix(), omegaWallFunctionFvPatchScalarField::manipulateMatrix(), fvPatch::patchSlice(), and fvPatchMapper::size().

Here is the caller graph for this function:

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Return true if this patch is coupled.

Reimplemented in cyclicACMIFvPatch, cyclicAMIFvPatch, regionCoupledWallFvPatch, regionCoupledFvPatch, processorFvPatch, and coupledFvPatch.

Definition at line 167 of file fvPatch.H.

References polyPatch::coupled(), and fvPatch::polyPatch_.

Here is the call graph for this function:

◆ constraintType()

bool constraintType ( const word & pt )

static

Return true if the given type is a constraint type.

Definition at line 61 of file fvPatch.C.

◆ constraintTypes()

Foam::wordList constraintTypes ( )

static

Return a list of all the constraint patch types.

Definition at line 67 of file fvPatch.C.

References List::setSize().

Here is the call graph for this function:

◆ index()

label index ( ) const

inline

Return the index of this patch in the fvBoundaryMesh.

Definition at line 179 of file fvPatch.H.

References patchIdentifier::index(), and fvPatch::polyPatch_.

Referenced by fvPatchMapper::calcAddressing(), epsilonLowReWallFunctionFvPatchScalarField::calculate(), epsilonWallFunctionFvPatchScalarField::calculate(), omegaWallFunctionFvPatchScalarField::calculate(), energyJumpAMIFvPatchScalarField::updateCoeffs(), energyJumpFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), fWallFunctionFvPatchScalarField::updateCoeffs(), v2WallFunctionFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), and filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ boundaryMesh()

const fvBoundaryMesh& boundaryMesh ( ) const

inline

Return boundaryMesh reference.

Definition at line 185 of file fvPatch.H.

References fvPatch::boundaryMesh_.

Referenced by thermalBaffle1DFvPatchScalarField< solidType >::baffleThickness(), regionCoupledBaseFvPatch::nbrFvMesh(), regionCoupledBaseFvPatch::nbrMesh(), cyclicFvPatch::neighbFvPatch(), cyclicAMIFvPatch::neighbFvPatch(), cyclicACMIFvPatch::neighbFvPatch(), cyclicFvPatch::neighbPatch(), cyclicAMIFvPatch::neighbPatch(), cyclicACMIFvPatch::neighbPatch(), cyclicACMIFvPatch::nonOverlapPatch(), thermalBaffle1DFvPatchScalarField< solidType >::Qs(), thermalBaffle1DFvPatchScalarField< solidType >::solid(), immersedBoundaryVelocityWallFunctionFvPatchVectorField::tauWall(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), thermalBaffle1DFvPatchScalarField< solidType >::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs(), immersedBoundaryWallFunctionFvPatchField< Type >::wallMask(), immersedBoundaryVelocityWallFunctionFvPatchVectorField::wallMask(), immersedBoundaryVelocityWallFunctionFvPatchVectorField::wallTangentialValue(), and immersedBoundaryWallFunctionFvPatchField< Type >::wallValue().

Here is the caller graph for this function:

◆ patchSlice()

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

inline

Slice list to patch.

Definition at line 192 of file fvPatch.H.

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

Referenced by fvPatchMapper::calcAddressing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ faceCells()

const Foam::labelUList & faceCells ( ) const

virtual

Return faceCells.

Reimplemented in regionCoupledWallFvPatch, regionCoupledFvPatch, coupledFvPatch, and emptyFvPatch.

Definition at line 93 of file fvPatch.C.

Here is the caller graph for this function:

◆ Cf()

const Foam::vectorField & Cf ( ) const

Return face centres.

Definition at line 99 of file fvPatch.C.

References boundaryMesh::mesh().

Referenced by meshToMesh0::interpolate(), and main().

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 105 of file fvPatch.C.

References forAll, and boundaryMesh::mesh().

Here is the call graph for this function:

◆ Sf()

const Foam::vectorField & Sf ( ) const

Return face area vectors.

Definition at line 130 of file fvPatch.C.

References boundaryMesh::mesh().

Referenced by cyclicACMIFvPatch::updateAreas(), 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 136 of file fvPatch.C.

References boundaryMesh::mesh().

Referenced by cyclicACMIFvPatch::updateAreas(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), outletMappedUniformInletFvPatchField< Type >::updateCoeffs(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), and activePressureForceBaffleVelocityFvPatchVectorField::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 124 of file fvPatch.C.

Referenced by nearWallFields::calcAddressing(), curvatureSeparation::calcCosAngle(), processorFvPatch::makeWeights(), cyclicFvPatch::makeWeights(), cyclicAMIFvPatch::makeWeights(), cyclicACMIFvPatch::makeWeights(), and energyRegionCoupledFvPatchScalarField::weights().

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 coupledFvPatch, cyclicACMIFvPatch, cyclicAMIFvPatch, processorFvPatch, and cyclicFvPatch.

Definition at line 142 of file fvPatch.C.

Referenced by cyclicACMIFvPatch::delta(), cyclicACMIFvPatch::makeWeights(), and energyRegionCoupledFvPatchScalarField::weights().

Here is the caller graph for this function:

◆ weights()

const Foam::scalarField & weights ( ) const

Return patch weighting factors.

Definition at line 170 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 coeffient.

except for coupled patches for which the cell-centre to coupled-cell-centre distance coeffient is returned

Definition at line 164 of file fvPatch.C.

References boundaryMesh::mesh().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patchInternalField() [1/3]

tmp<Field<Type> > patchInternalField ( const UList< Type > & ) const

Return given internal field next to patch as patch field.

◆ patchInternalField() [2/3]

void patchInternalField	(	const UList< Type > &	f,
		Field< Type > &	pif
	)		const

Return given internal field next to patch as patch field.

Definition at line 52 of file fvPatchTemplates.C.

References f(), and forAll.

Here is the call graph for this function:

◆ patchField()

const GeometricField::PatchFieldType & patchField ( const GeometricField & gf ) const

Return the corresponding patchField of the named field.

Definition at line 70 of file fvPatchTemplates.C.

References GeometricField::boundaryField().

Referenced by porousBafflePressureFvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupPatchField()

const GeometricField::PatchFieldType & lookupPatchField	(	const word &	name,
		const GeometricField *	= `NULL`,
		const Type *	= `NULL`
	)		const

Lookup and return the patchField of the named field from the.

local objectRegistry. N.B. The dummy pointer arguments are used if this function is instantiated within a templated function to avoid a bug in gcc. See inletOutletFvPatchField.C and outletInletFvPatchField.C

Definition at line 32 of file fvPatchFvMeshTemplates.C.

References mesh, and Foam::name().

Referenced by totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), coupledFixedValueFvPatchField< Type >::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), turbulentBoundaryCoupledFvPatchScalarField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), and energyRegionCoupledFvPatchScalarField::weights().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patchInternalField() [3/3]

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

Definition at line 32 of file fvPatchTemplates.C.

References f(), and forAll.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ fvBoundaryMesh

friend class fvBoundaryMesh

friend

Definition at line 99 of file fvPatch.H.

◆ surfaceInterpolation

friend class surfaceInterpolation

friend

Definition at line 100 of file fvPatch.H.

Field Documentation

◆ polyPatch_

const polyPatch& polyPatch_

private

Reference to the underlying polyPatch.

Definition at line 66 of file fvPatch.H.

Referenced by fvPatch::coupled(), fvPatch::index(), fvPatch::name(), fvPatch::patch(), fvPatch::size(), and fvPatch::start().

◆ boundaryMesh_

const fvBoundaryMesh& boundaryMesh_

private

Reference to boundary mesh.

Definition at line 69 of file fvPatch.H.

Referenced by fvPatch::boundaryMesh().

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

src/finiteVolume/fvMesh/fvPatches/fvPatch/fvPatch.H
src/finiteVolume/fvMesh/fvPatches/fvPatch/fvPatch.C
src/finiteVolume/fvMesh/fvPatches/fvPatch/fvPatchFvMeshTemplates.C
src/finiteVolume/fvMesh/fvPatches/fvPatch/fvPatchNew.C
src/finiteVolume/fvMesh/fvPatches/fvPatch/fvPatchTemplates.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ BoundaryMesh

Constructor & Destructor Documentation

◆ fvPatch() [1/2]

◆ fvPatch() [2/2]

◆ ~fvPatch()

Member Function Documentation

◆ operator=()

◆ makeWeights()

◆ initMovePoints()

◆ movePoints()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ patch()

◆ name()

◆ start()

◆ size()

◆ coupled()

◆ constraintType()

◆ constraintTypes()

◆ index()

◆ boundaryMesh()

◆ patchSlice()

◆ faceCells()

◆ Cf()

◆ Cn()

◆ Sf()

◆ magSf()

◆ nf()

◆ delta()

◆ weights()

◆ deltaCoeffs()

◆ patchInternalField() [1/3]

◆ patchInternalField() [2/3]

◆ patchField()

◆ lookupPatchField()

◆ patchInternalField() [3/3]

Friends And Related Function Documentation

◆ fvBoundaryMesh

◆ surfaceInterpolation

Field Documentation

◆ polyPatch_

◆ boundaryMesh_