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

Inheritance diagram for fvPatch:

[legend]

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

	fvPatch (const fvPatch &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvPatch ()
	Destructor. More...

const polyPatch &	patch () const
	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
	Return the index of this patch in the fvBoundaryMesh. More...

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

const objectRegistry &	db () const
	Return the local object registry. 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...

tmp< scalarField >	polyFaceFraction () const
	Return the fraction of the poly-face that each fv-face in this. More...

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

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

virtual const scalarField &	deltaCoeffs () const
	Return the face - cell distance coefficient. 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::Patch &	patchField (const GeometricField &) const
	Return the corresponding patchField of the named field. More...

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

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

void	operator= (const fvPatch &)=delete
	Disallow default bitwise assignment. 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...

Detailed Description

A finiteVolume patch using a polyPatch and a fvBoundaryMesh.

Source files

Definition at line 63 of file fvPatch.H.

Constructor & Destructor Documentation

◆ fvPatch() [1/2]

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

Construct from polyPatch and fvBoundaryMesh.

Definition at line 46 of file fvPatch.C.

◆ fvPatch() [2/2]

fvPatch ( const fvPatch & )

delete

Disallow default bitwise copy construction.

◆ ~fvPatch()

~fvPatch ( )

virtual

Destructor.

Definition at line 55 of file fvPatch.C.

Member Function Documentation

◆ 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 31 of file fvPatchNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, InfoInFunction, Foam::nl, and fvPatch::patch().

Referenced by fvMeshAdder::add(), fvMesh::addPatch(), and fvMesh::swap().

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

Referenced by Foam::levelSetFraction(), mappedValueFvPatchField< Type >::mappedValueFvPatchField(), fvPatch::New(), 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 126 of file fvPatch.H.

References patchIdentifier::name().

Referenced by advectiveFvPatchField< Type >::advectiveFvPatchField(), Foam::checkNonConformalCoupledPatchOrdering(), Foam::checkNonConformalErrorPatchOrdering(), Foam::checkProcMeshesOrdering(), cyclicFvPatchField< Type >::cyclicFvPatchField(), genericFvPatchField< Type >::genericFvPatchField(), mappedFvPatchBaseBase::getMap(), FvFaceCellWave< Type, TrackingData >::handleCyclicPatches(), FvFaceCellWave< Type, TrackingData >::handleProcPatches(), mappedValueFvPatchField< Type >::mappedValueFvPatchField(), processorCyclicFvPatchField< Type >::processorCyclicFvPatchField(), processorFvPatchField< Type >::processorFvPatchField(), symmetryFvPatchField< Type >::symmetryFvPatchField(), symmetryPlaneFvPatchField< Type >::symmetryPlaneFvPatchField(), coupledTemperatureFvPatchScalarField::updateCoeffs(), wedgeFvPatchField< Type >::wedgeFvPatchField(), wallHeatFlux::write(), wallHeatTransferCoeff::write(), wallShearStress::write(), and yPlus::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.

Reimplemented in nonConformalMappedWallFvPatch, nonConformalProcessorCyclicFvPatch, nonConformalErrorFvPatch, and nonConformalCyclicFvPatch.

Definition at line 132 of file fvPatch.H.

References polyPatch::start().

Referenced by CentredFitSnGradData< Polynomial >::calcFit(), extendedFaceToCellStencil::collectData(), extendedCellToFaceStencil::collectData(), conformedFvPatchField< Type >::conform(), pointLinear< Type >::correction(), fvMeshSubset::interpolate(), inversePointDistanceDiffusivity::operator()(), Foam::fvMeshStitcherTools::origNcMagSfb(), fvPatch::patchSlice(), constSolidThermo::readProperty(), conformedFvPatchField< Type >::unconform(), extendedCellToFaceStencil::weightedSum(), and extendedUpwindCellToFaceStencil::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 nonConformalMappedWallFvPatch, nonConformalProcessorCyclicFvPatch, nonConformalErrorFvPatch, nonConformalCyclicFvPatch, and emptyFvPatch.

Definition at line 138 of file fvPatch.H.

References UList< T >::size().

Referenced by Foam::checkNonConformalErrorPatchOrdering(), conformedFvPatchField< Type >::conform(), FvFaceCellWave< Type, TrackingData >::handleCyclicPatches(), FvFaceCellWave< Type, TrackingData >::handleProcPatches(), fvMeshSubset::interpolate(), Foam::levelSetFraction(), Foam::fvMeshStitcherTools::origNcMagSfb(), fvMeshStitcher::patchCoupleds(), fvPatch::patchInternalField(), fvPatch::patchSlice(), PatchCollisionDensity< CloudType >::preEvolve(), radiationCoupledBase::radiationCoupledBase(), and movingMappedWallVelocityFvPatchVectorField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Return true if this patch is coupled.

Reimplemented in processorFvPatch, nonConformalProcessorCyclicFvPatch, nonConformalCyclicFvPatch, and coupledFvPatch.

Definition at line 144 of file fvPatch.H.

References polyPatch::coupled().

Referenced by Foam::fvc::smooth(), Foam::fvc::spread(), and Foam::fvc::sweep().

Here is the call graph for this function:

Here is the caller 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< T >::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 156 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

inline

Return boundaryMesh reference.

Definition at line 162 of file fvPatch.H.

Referenced by filmFvPatch::deltaCoeffs(), nonConformalMappedFvPatchBase::fromNeighbour(), cyclicFvPatch::nbrPatch(), cyclicFvPatch::neighbFvPatch(), nonConformalFvPatch::origPatch(), processorCyclicFvPatch::referPatch(), timeVaryingMappedFvPatchField< Type >::time(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), and activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

◆ db()

const Foam::objectRegistry & db ( ) const

Return the local object registry.

Definition at line 93 of file fvPatch.C.

◆ patchSlice()

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

inline

Slice list to patch.

Definition at line 172 of file fvPatch.H.

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

Referenced by domainDecomposition::procFaceAddressingBf().

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 nonConformalMappedWallFvPatch, nonConformalProcessorCyclicFvPatch, nonConformalErrorFvPatch, nonConformalCyclicFvPatch, emptyFvPatch, and coupledFvPatch.

Definition at line 99 of file fvPatch.C.

Referenced by nearWallFields::calcAddressing(), VoFFilmTransfer::correct(), LRR< BasicMomentumTransportModel >::correct(), SSG< BasicMomentumTransportModel >::correct(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), pointLinear< Type >::correction(), coupledFvPatch::faceCells(), VoFFilmTransfer::filmVoFTransferRate(), inversePointDistanceDiffusivity::operator()(), wallCellWallFunctionFvPatchScalarField::patchFieldAddToCellField(), fvPatch::patchInternalField(), Foam::fvc::smooth(), Foam::fvc::spread(), Foam::fvc::sweep(), VoFFilmTransfer::TransferRate(), fWallFunctionFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), and v2WallFunctionFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ Cf()

const Foam::vectorField & Cf ( ) const

Return face centres.

Definition at line 105 of file fvPatch.C.

Referenced by nearWallFields::calcAddressing(), and movingMappedWallVelocityFvPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

◆ Cn()

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

Return neighbour cell centres.

Definition at line 111 of file fvPatch.C.

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

Here is the call graph for this function:

◆ Sf()

const Foam::vectorField & Sf ( ) const

Return face area vectors.

Definition at line 136 of file fvPatch.C.

Referenced by cyclicFvPatch::makeWeights(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), and activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

◆ magSf()

const Foam::scalarField & magSf ( ) const

Return face area magnitudes.

Definition at line 142 of file fvPatch.C.

Referenced by conformedFvPatchField< Type >::conform(), wallCellWallFunctionFvPatchScalarField::initMaster(), wallCellWallFunctionFvPatchScalarField::patchFieldsToWallCellField(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs(), movingMappedWallVelocityFvPatchVectorField::updateCoeffs(), and outletMappedUniformInletFvPatchField< Type >::updateCoeffs().

Here is the caller graph for this function:

◆ nf()

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

Return face normals.

Definition at line 130 of file fvPatch.C.

Referenced by nearWallFields::calcAddressing(), dynamic::cosTheta(), nonConformalCoupledFvPatch::makeWeights(), and movingMappedWallVelocityFvPatchVectorField::updateCoeffs().

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, processorFvPatch, nonConformalProcessorCyclicFvPatch, nonConformalErrorFvPatch, nonConformalCyclicFvPatch, and cyclicFvPatch.

Definition at line 148 of file fvPatch.C.

◆ polyFaceFraction()

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

Return the fraction of the poly-face that each fv-face in this.

patch covers. Will be equal to one, unless the mesh is non-conformal.

Definition at line 156 of file fvPatch.C.

◆ makeWeights()

void makeWeights ( scalarField & w ) const

virtual

Make patch weighting factors.

Reimplemented in coupledFvPatch, processorFvPatch, nonConformalProcessorCyclicFvPatch, nonConformalCyclicFvPatch, and cyclicFvPatch.

Definition at line 170 of file fvPatch.C.

◆ weights()

const Foam::scalarField & weights ( ) const

Return patch weighting factors.

Definition at line 182 of file fvPatch.C.

◆ deltaCoeffs()

const Foam::scalarField & deltaCoeffs ( ) const

virtual

Return the face - cell distance coefficient.

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

Reimplemented in filmFvPatch.

Definition at line 176 of file fvPatch.C.

Referenced by semiPermeableBaffleMassFractionFvPatchScalarField::calcPhiYp(), VoFFilmTransfer::correct(), filmFvPatch::deltaCoeffs(), and filmSurfaceVelocityFvPatchVectorField::updateCoeffs().

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(), forAll, and List< T >::setSize().

Here is the call graph for this function:

◆ patchField() [1/2]

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

Return the corresponding patchField of the named field.

Definition at line 70 of file fvPatchTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField().

Here is the call graph for this function:

◆ patchField() [2/2]

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

Return the corresponding patchField reference of the named field.

Definition at line 80 of file fvPatchTemplates.C.

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

Here is the call graph for this function:

◆ lookupPatchField()

const GeometricField::Patch & lookupPatchField ( const word & name ) const

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

local objectRegistry.

Definition at line 90 of file fvPatchTemplates.C.

References Foam::name().

Referenced by semiPermeableBaffleMassFractionFvPatchScalarField::calcPhiYp(), temperatureDependent::cosTheta(), filmSurfaceVelocityFvPatchVectorField::updateCoeffs(), mappedFilmPressureFvPatchScalarField::updateCoeffs(), mappedFlowRateVelocityFvPatchVectorField::updateCoeffs(), and coupledTemperatureFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const fvPatch & )

delete

Disallow default bitwise assignment.

◆ patchInternalField() [3/3]

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

Definition at line 32 of file fvPatchTemplates.C.

References f(), fvPatch::faceCells(), forAll, tmp< T >::ref(), and fvPatch::size().

Here is the call graph for this function:

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/fvPatchNew.C
src/finiteVolume/fvMesh/fvPatches/fvPatch/fvPatchTemplates.C

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ fvPatch() [1/2]

◆ fvPatch() [2/2]

◆ ~fvPatch()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ patch()

◆ name()

◆ start()

◆ size()

◆ coupled()

◆ constraintType()

◆ constraintTypes()

◆ index()

◆ boundaryMesh()

◆ db()

◆ patchSlice()

◆ faceCells()

◆ Cf()

◆ Cn()

◆ Sf()

◆ magSf()

◆ nf()

◆ delta()

◆ polyFaceFraction()

◆ makeWeights()

◆ weights()

◆ deltaCoeffs()

◆ patchInternalField() [1/3]

◆ patchInternalField() [2/3]

◆ patchField() [1/2]

◆ patchField() [2/2]

◆ lookupPatchField()

◆ operator=()

◆ patchInternalField() [3/3]