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

Inheritance diagram for fvPatch:

[legend]

Public Types
typedef fvMesh	Mesh
	Mesh type. More...

typedef fvBoundaryMesh	BoundaryMesh
	Boundary mesh type. More...

typedef faceZone	Zone
	Zone type. More...

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 &	poly () 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	constraint () const
	Return true if this patch is a constraint type. 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 objectRegistry &	db () const
	Return the local object registry. More...

const fvMesh &	mesh () const
	Return mesh reference. More...

const Time &	time () const
	Return time. 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...

const DimensionedField< vector, fvPatch > &	C () const
	Return dimensioned 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...

template<class Type >
tmp< DimensionedField< Type, fvPatch > >	lookupField (const word &) const
	Lookup a dimensioned field for this geometry. More...

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

const fvMesh &	operator() () const
	Return reference to fvMesh. More...

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

template<class Type >
Foam::tmp< Foam::DimensionedField< Type, Foam::fvPatch > >	lookupField (const word &name) 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...

Detailed Description

A finiteVolume patch using a polyPatch and a fvBoundaryMesh.

Source files

Definition at line 57 of file fvPatch.H.

Member Typedef Documentation

◆ Mesh

typedef fvMesh Mesh

Mesh type.

Definition at line 76 of file fvPatch.H.

◆ BoundaryMesh

typedef fvBoundaryMesh BoundaryMesh

Boundary mesh type.

Definition at line 79 of file fvPatch.H.

◆ Zone

typedef faceZone Zone

Zone type.

Definition at line 82 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 DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

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:

◆ poly()

const polyPatch& poly ( ) const

inline

Return the polyPatch.

Definition at line 129 of file fvPatch.H.

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

References patchIdentifier::name().

Referenced by advectiveFvPatchField< Type >::advectiveFvPatchField(), Foam::checkNonConformalCoupledPatchOrdering(), Foam::checkNonConformalErrorPatchOrdering(), Foam::checkProcMeshesOrdering(), genericFvPatchField< Type >::genericFvPatchField(), mappedFvPatchBaseBase::getMap(), FvFaceCellWave< Type, TrackingData >::handleCyclicPatches(), FvFaceCellWave< Type, TrackingData >::handleProcPatches(), mappedValueFvPatchField< Type >::mappedValueFvPatchField(), processorFvPatchField< Type >::processorFvPatchField(), surfaceFieldValue::read(), coupledTemperatureFvPatchScalarField::updateCoeffs(), 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 141 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(), 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 147 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(), fvPatch::patchInternalField(), fvPatch::patchSlice(), PatchCollisionDensity< CloudType >::preEvolve(), radiationCoupledBase::radiationCoupledBase(), movingMappedWallVelocityFvPatchVectorField::updateCoeffs(), wallHeatFlux::write(), and wallHeatTransferCoeff::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ constraint()

virtual bool constraint ( ) const

inlinevirtual

Return true if this patch is a constraint type.

Definition at line 153 of file fvPatch.H.

References polyPatch::constraint().

Here is the call 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 159 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:

◆ index()

label index ( ) const

inline

Return the index of this patch in the fvBoundaryMesh.

Definition at line 165 of file fvPatch.H.

References patchIdentifier::index().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ db()

const Foam::objectRegistry & db ( ) const

Return the local object registry.

Definition at line 61 of file fvPatch.C.

◆ mesh()

const Foam::fvMesh & mesh ( ) const

Return mesh reference.

Definition at line 67 of file fvPatch.C.

Referenced by filmFvPatch::deltaCoeffs(), nonConformalMappedFvPatchBase::fromNeighbour(), and processorFvPatch::makeWeights().

Here is the caller graph for this function:

◆ time()

const Foam::Time & time ( ) const

Return time.

Definition at line 73 of file fvPatch.C.

References objectRegistry::time().

Referenced by timeVaryingMappedFvPatchField< Type >::time().

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

Referenced by cyclicFvPatch::nbrPatch(), cyclicFvPatch::neighbFvPatch(), nonConformalFvPatch::origPatch(), processorCyclicFvPatch::referPatch(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), and activePressureForceBaffleVelocityFvPatchVectorField::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.

Definition at line 187 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 79 of file fvPatch.C.

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

Here is the caller graph for this function:

◆ Cf()

const Foam::vectorField & Cf ( ) const

Return face centres.

Definition at line 85 of file fvPatch.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), fvMesh::Cf(), and mesh.

Referenced by nearWallFields::calcAddressing(), and processorFvPatch::makeWeights().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ C()

const Foam::DimensionedField< Foam::vector, Foam::fvPatch > & C ( ) const

Return dimensioned face centres.

Definition at line 92 of file fvPatch.C.

References Foam::dimLength, mesh, Foam::name(), IOobject::NO_READ, IOobject::NO_WRITE, and Foam::dimensions::time.

Referenced by processorFvPatch::makeWeights().

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

References primitiveMesh::cellCentres(), forAll, mesh, 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 147 of file fvPatch.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), mesh, and fvMesh::Sf().

Referenced by cyclicFvPatch::makeWeights(), processorFvPatch::makeWeights(), 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 153 of file fvPatch.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), fvMesh::magSf(), and mesh.

Referenced by conformedFvPatchField< Type >::conform(), wallCellWallFunctionFvPatchScalarField::initMaster(), wallCellWallFunctionFvPatchScalarField::patchFieldsToWallCellField(), activeBaffleVelocityFvPatchVectorField::updateCoeffs(), activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs(), movingMappedWallVelocityFvPatchVectorField::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 141 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, nonConformalErrorFvPatch, and cyclicFvPatch.

Definition at line 159 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 167 of file fvPatch.C.

References fvMesh::conformal(), and mesh.

Here is the call graph for this function:

◆ makeWeights()

void makeWeights ( scalarField & w ) const

virtual

Make patch weighting factors.

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

Definition at line 181 of file fvPatch.C.

◆ weights()

const Foam::scalarField & weights ( ) const

Return patch weighting factors.

Definition at line 193 of file fvPatch.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), mesh, and surfaceInterpolation::weights().

Here is the call graph for this function:

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

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), surfaceInterpolation::deltaCoeffs(), and mesh.

Referenced by semiPermeableBaffleMassFractionFvPatchScalarField::calcPhiYp(), VoFFilmTransfer::correct(), filmFvPatch::deltaCoeffs(), and filmSurfaceVelocityFvPatchVectorField::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 53 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 71 of file fvPatchTemplates.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::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 81 of file fvPatchTemplates.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::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 91 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:

◆ lookupField() [1/2]

tmp<DimensionedField<Type, fvPatch> > lookupField ( const word & ) const

Lookup a dimensioned field for this geometry.

◆ operator=()

void operator= ( const fvPatch & )

delete

Disallow default bitwise assignment.

◆ operator()()

const Foam::fvMesh & operator() ( ) const

Return reference to fvMesh.

Definition at line 199 of file fvPatch.C.

References mesh.

◆ patchInternalField() [3/3]

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

Definition at line 33 of file fvPatchTemplates.C.

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

Here is the call graph for this function:

◆ lookupField() [2/2]

Foam::tmp<Foam::DimensionedField<Type, Foam::fvPatch> > lookupField ( const word & name ) const

Definition at line 105 of file fvPatchTemplates.C.

References Foam::abort(), GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), Foam::FatalError, FatalErrorInFunction, Foam::name(), Foam::nl, IOobject::NO_READ, IOobject::NO_WRITE, sf(), Foam::dimensions::time, and Foam::typeName().

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 Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Mesh

◆ BoundaryMesh

◆ Zone

Constructor & Destructor Documentation

◆ fvPatch() [1/2]

◆ fvPatch() [2/2]

◆ ~fvPatch()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ poly()

◆ name()

◆ start()

◆ size()

◆ constraint()

◆ coupled()

◆ index()

◆ db()

◆ mesh()

◆ time()

◆ boundaryMesh()

◆ patchSlice()

◆ faceCells()

◆ Cf()

◆ C()

◆ Cn()

◆ Sf()

◆ magSf()

◆ nf()

◆ delta()

◆ polyFaceFraction()

◆ makeWeights()

◆ weights()

◆ deltaCoeffs()

◆ patchInternalField() [1/3]

◆ patchInternalField() [2/3]

◆ patchField() [1/2]

◆ patchField() [2/2]

◆ lookupPatchField()

◆ lookupField() [1/2]

◆ operator=()

◆ operator()()

◆ patchInternalField() [3/3]

◆ lookupField() [2/2]