patchIdentifier Class Reference

Identifies a patch by name, patch index and physical type. More...

Inheritance diagram for patchIdentifier:

Public Member Functions
	patchIdentifier (const patchIdentifier &)=default
	Copy construct. More...
patchIdentifier &	operator= (const patchIdentifier &)=default
	Copy assignment. More...
virtual	~patchIdentifier ()=default
	Destructor. More...
	patchIdentifier ()
	Default construct, with index zero. More...
	patchIdentifier (const word &name, const label index)
	Construct from mandatory components. More...
	patchIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
	Construct from components. More...
	patchIdentifier (const word &name, const dictionary &dict, const label index)
	Construct from dictionary. More...
	patchIdentifier (const patchIdentifier &p, const label index)
	Copy construct, resetting the index. More...
const word &	name () const
	The patch name. More...
word &	name ()
	Modifiable patch name. More...
const word &	physicalType () const
	The (optional) physical type of the patch. More...
word &	physicalType ()
	Modifiable (optional) physical type of the patch. More...
label	index () const
	The index of this patch in the boundaryMesh. More...
label &	index ()
	Modifiable index of this patch in the boundaryMesh. More...
const wordList &	inGroups () const
	The (optional) groups that the patch belongs to. More...
wordList &	inGroups ()
	Modifiable (optional) groups that the patch belongs to. More...
bool	inGroup (const word &name) const
	True if the patch is in named group. More...
void	write (Ostream &os) const

Static Public Member Functions
static word	defaultName (const label n=-1)
	Default patch name: "patch" or "patchN". More...

Detailed Description

Identifies a patch by name, patch index and physical type.

Source files

• patchIdentifier.H
• patchIdentifier.C

Definition at line 54 of file patchIdentifier.H.

Constructor & Destructor Documentation

patchIdentifier() [1/6]

patchIdentifier ( const patchIdentifier &  )

default

Copy construct.

~patchIdentifier()

virtual ~patchIdentifier ( )

virtualdefault

Destructor.

patchIdentifier() [2/6]

patchIdentifier

(

)

Default construct, with index zero.

Definition at line 34 of file patchIdentifier.C.

patchIdentifier() [3/6]

patchIdentifier	(	const word &	name,
		const label	index
	)

Construct from mandatory components.

Definition at line 42 of file patchIdentifier.C.

patchIdentifier() [4/6]

patchIdentifier	(	const word &	name,
		const label	index,
		const word &	physicalType,
		const wordList &	inGroups = wordList()
	)

Construct from components.

Definition at line 53 of file patchIdentifier.C.

patchIdentifier() [5/6]

patchIdentifier	(	const word &	name,
		const dictionary &	dict,
		const label	index
	)

Construct from dictionary.

Definition at line 68 of file patchIdentifier.C.

References dict, and dictionary::readIfPresent().

Here is the call graph for this function:

patchIdentifier() [6/6]

patchIdentifier	(	const patchIdentifier &	p,
		const label	index
	)

Copy construct, resetting the index.

Definition at line 82 of file patchIdentifier.C.

Member Function Documentation

defaultName()

static word defaultName ( const label  n = -1 )

inlinestatic

Default patch name: "patch" or "patchN".

Definition at line 75 of file patchIdentifier.H.

References n.

Referenced by voxelMeshSearch::makeMesh().

Here is the caller graph for this function:

operator=()

patchIdentifier& operator= ( const patchIdentifier &  )

default

Copy assignment.

Referenced by polyPatch::operator=().

Here is the caller graph for this function:

name() [1/2]

const word& name ( ) const

inline

The patch name.

Definition at line 134 of file patchIdentifier.H.

Referenced by cyclicAMIPolyPatch::addAMIFaces(), polyTopoChange::addMesh(), boundaryMesh::addPatch(), boundaryRadiationProperties::boundaryRadiationProperties(), symmetryPlanePolyPatch::calcGeometry(), wedgePolyPatch::calcGeometry(), mappedPatchBase::calcMapping(), boundaryMesh::changeFaces(), boundaryMesh::changePatchType(), hexRef8::checkMesh(), lumpedPointMovement::checkPatchControl(), emptyFaPatch::clone(), symmetryFaPatch::clone(), faPatch::clone(), ConstantField< Type >::ConstantField(), boundaryMesh::deletePatch(), snappyLayerDriver::doLayers(), extendedCellToCellStencil::extendedCellToCellStencil(), extendedCellToFaceStencil::extendedCellToFaceStencil(), extendedFaceToCellStencil::extendedFaceToCellStencil(), coupleGroupIdentifier::findOtherPatchID(), FaceCellWave< Type, TrackingData >::handleCyclicPatches(), FaceCellWave< Type, TrackingData >::handleProcPatches(), particle< Type >::hitCyclicAMIPatch(), patchIdentifier::inGroup(), trackingInverseDistance::markBoundaries(), facePointPatch::name(), fvPatch::name(), polyBoundaryMesh::neighbourEdges(), cyclicACMIPolyPatch::nonOverlapPatchID(), boundaryMesh::patchify(), patchInteractionDataList::patchInteractionDataList(), fvMeshDistribute::printMeshInfo(), boundaryMesh::read(), AMIWeights::reportPatch(), cyclicACMIPolyPatch::resetAMI(), cyclicACMIFvPatch::resetPatchAreas(), cyclicAMIPolyPatch::restoreScaledGeometry(), motionSmootherAlgo::scaleMesh(), cyclicACMIPolyPatch::scalePatchFaceAreas(), solidAbsorption::solidAbsorption(), processorCyclicPolyPatch::tag(), meshRefinement::testSyncBoundaryFaceList(), cyclicPolyPatch::transformGlobalFace(), cyclicACMIPolyPatch::updateAreas(), vtkWrite::write(), boundaryMesh::writeTriSurface(), and AMIWeights::writeWeightField().

Here is the caller graph for this function:

name() [2/2]

word& name ( )

inline

Modifiable patch name.

Definition at line 140 of file patchIdentifier.H.

physicalType() [1/2]

const word& physicalType ( ) const

inline

The (optional) physical type of the patch.

Definition at line 146 of file patchIdentifier.H.

Referenced by boundaryMesh::addPatch(), boundaryMesh::changeFaces(), boundaryMesh::deletePatch(), boundaryMesh::patchify(), boundaryMesh::read(), and boundaryMesh::writeTriSurface().

Here is the caller graph for this function:

physicalType() [2/2]

word& physicalType ( )

inline

Modifiable (optional) physical type of the patch.

Definition at line 152 of file patchIdentifier.H.

index() [1/2]

label index ( ) const

inline

The index of this patch in the boundaryMesh.

Definition at line 158 of file patchIdentifier.H.

Referenced by ThermoSurfaceFilm< CloudType >::absorbInteraction(), cyclicAMIPolyPatch::addAMIFaces(), ThermoSurfaceFilm< CloudType >::bounceInteraction(), boundaryPatch::boundaryPatch(), boundaryMesh::changePatchType(), lumpedPointMovement::checkPatchControl(), emptyFaPatch::clone(), symmetryFaPatch::clone(), emptyPolyPatch::clone(), wallPolyPatch::clone(), symmetryPolyPatch::clone(), oversetPolyPatch::clone(), genericPolyPatch::clone(), symmetryPlanePolyPatch::clone(), cyclicSlipPolyPatch::clone(), nonuniformTransformCyclicPolyPatch::clone(), wedgePolyPatch::clone(), cyclicPeriodicAMIPolyPatch::clone(), mappedVariableThicknessWallPolyPatch::clone(), mappedPolyPatch::clone(), mappedWallPolyPatch::clone(), processorCyclicPolyPatch::clone(), faPatch::clone(), processorPolyPatch::clone(), oldCyclicPolyPatch::clone(), polyPatch::clone(), cyclicACMIPolyPatch::clone(), cyclicPolyPatch::clone(), cyclicAMIPolyPatch::clone(), LocalInteraction< CloudType >::correct(), MultiInteraction< CloudType >::correct(), StandardWallInteraction< CloudType >::correct(), RecycleInteraction< CloudType >::correct(), ThermoSurfaceFilm< CloudType >::drySplashInteraction(), FaceCellWave< Type, TrackingData >::handleCyclicPatches(), lumpedPointMovement::hasPatchControl(), facePointPatch::index(), fvPatch::index(), cyclicACMIFvPatch::movePoints(), cyclicFaPatch::neighbPatchID(), cyclicPolyPatch::owner(), KinematicCloud< Cloud< basicKinematicCollidingParcel > >::patchData(), patchInteractionDataList::patchInteractionDataList(), semiPermeableBaffleMassFractionFvPatchScalarField::phiY(), PatchCollisionDensity< CloudType >::postPatch(), ParticleErosion< CloudType >::postPatch(), PatchPostProcessing< CloudType >::postPatch(), PatchInteractionFields< CloudType >::postPatch(), PatchParticleHistogram< CloudType >::postPatch(), lumpedPointMovement::setPatchControl(), ThermoSurfaceFilm< CloudType >::splashInteraction(), ThermoSurfaceFilm< CloudType >::transferParcel(), mappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), ThermoSurfaceFilm< CloudType >::wetSplashInteraction(), and vtkWrite::write().

index() [2/2]

label& index ( )

inline

Modifiable index of this patch in the boundaryMesh.

Definition at line 164 of file patchIdentifier.H.

inGroups() [1/2]

const wordList& inGroups ( ) const

inline

The (optional) groups that the patch belongs to.

Definition at line 170 of file patchIdentifier.H.

Referenced by polyBoundaryMesh::setGroup().

Here is the caller graph for this function:

inGroups() [2/2]

wordList& inGroups ( )

inline

Modifiable (optional) groups that the patch belongs to.

Definition at line 176 of file patchIdentifier.H.

inGroup()

bool inGroup ( const word &  name ) const

inline

True if the patch is in named group.

Definition at line 182 of file patchIdentifier.H.

References patchIdentifier::name().

Referenced by polyBoundaryMesh::setGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

write()

void write

(

Ostream &

os

)

const

Write (physicalType, inGroups) dictionary entries (without surrounding braces)

Definition at line 96 of file patchIdentifier.C.

References token::END_STATEMENT, Foam::nl, Ostream::writeEntry(), and Ostream::writeKeyword().

Referenced by boundaryPatch::write(), genericPolyPatch::write(), faPatch::write(), oldCyclicPolyPatch::write(), and polyPatch::write().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/OpenFOAM/meshes/Identifiers/patch/patchIdentifier.H
• src/OpenFOAM/meshes/Identifiers/patch/patchIdentifier.C