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

Inheritance diagram for patchIdentifier:

Public Member Functions
	patchIdentifier (const word &name, const label index, const word &physicalType=word::null, 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...

virtual	~patchIdentifier ()=default
	Destructor. More...

const word &	name () const
	Return 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 the 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
	Check if the patch is in named group. More...

void	write (Ostream &os) const
	Write patchIdentifier as a dictionary. More...

Friends
Ostream &	operator<< (Ostream &os, const patchIdentifier &p)

Detailed Description

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

Source files

Definition at line 57 of file patchIdentifier.H.

Constructor & Destructor Documentation

◆ patchIdentifier() [1/3]

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

Construct from components.

Definition at line 35 of file patchIdentifier.C.

◆ patchIdentifier() [2/3]

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

Construct from dictionary.

Definition at line 50 of file patchIdentifier.C.

References dict.

◆ patchIdentifier() [3/3]

patchIdentifier	(	const patchIdentifier &	p,
		const label	index
	)

Copy construct, resetting the index.

Definition at line 65 of file patchIdentifier.C.

◆ ~patchIdentifier()

virtual ~patchIdentifier ( )

virtualdefault

Destructor.

Member Function Documentation

◆ name() [1/2]

const word& name ( ) const

inline

Return the patch name.

Definition at line 109 of file patchIdentifier.H.

Referenced by polyTopoChange::addMesh(), boundaryMesh::addPatch(), boundaryRadiationProperties::boundaryRadiationProperties(), symmetryPlanePolyPatch::calcGeometry(), wedgePolyPatch::calcGeometry(), mappedPatchBase::calcMapping(), boundaryMesh::changeFaces(), boundaryMesh::changePatchType(), hexRef8::checkMesh(), 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(), cyclicACMIPolyPatch::initGeometry(), trackingInverseDistance::markBoundaries(), fvPatch::name(), facePointPatch::name(), polyBoundaryMesh::neighbourEdges(), cyclicACMIPolyPatch::nonOverlapPatchID(), boundaryMesh::patchify(), patchInteractionDataList::patchInteractionDataList(), fvMeshDistribute::printMeshInfo(), boundaryMesh::read(), AMIWeights::reportPatch(), cyclicACMIPolyPatch::resetAMI(), motionSmootherAlgo::scaleMesh(), solidAbsorption::solidAbsorption(), processorCyclicPolyPatch::tag(), meshRefinement::testSyncBoundaryFaceList(), cyclicPolyPatch::transformGlobalFace(), sampledPatch::update(), 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 115 of file patchIdentifier.H.

◆ physicalType() [1/2]

const word& physicalType ( ) const

inline

The optional physical type of the patch.

Definition at line 121 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 127 of file patchIdentifier.H.

◆ index() [1/2]

label index ( ) const

inline

The index of this patch in the boundaryMesh.

Definition at line 133 of file patchIdentifier.H.

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

◆ index() [2/2]

label& index ( )

inline

Modifiable the index of this patch in the boundaryMesh.

Definition at line 139 of file patchIdentifier.H.

◆ inGroups() [1/2]

const wordList& inGroups ( ) const

inline

The optional groups that the patch belongs to.

Definition at line 145 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 151 of file patchIdentifier.H.

◆ inGroup()

bool inGroup ( const word & name ) const

Check if the patch is in named group.

Definition at line 79 of file patchIdentifier.C.

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 patchIdentifier as a dictionary.

Definition at line 85 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:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<<	(	Ostream &	os,
		const patchIdentifier &	p
	)

friend

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

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ patchIdentifier() [1/3]

◆ patchIdentifier() [2/3]

◆ patchIdentifier() [3/3]

◆ ~patchIdentifier()

Member Function Documentation

◆ name() [1/2]

◆ name() [2/2]

◆ physicalType() [1/2]

◆ physicalType() [2/2]

◆ index() [1/2]

◆ index() [2/2]

◆ inGroups() [1/2]

◆ inGroups() [2/2]

◆ inGroup()

◆ write()

Friends And Related Function Documentation

◆ operator<<