patchIdentifier Class Reference

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

#include <OpenFOAM/patchIdentifier.H>

---

Detailed Description

Identifies patch by name, patch index and physical type.

Source files

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

Definition at line 58 of file patchIdentifier.H.

Inheritance diagram for patchIdentifier:

List of all members.

Public Member Functions
	patchIdentifier (const word &name, const label index, const word &physicalType=word::null)
	Construct from components.
	patchIdentifier (const word &name, const dictionary &, const label index)
	Construct from dictionary.
	patchIdentifier (const patchIdentifier &, const label index)
	Construct from geometric patch, resetting the index.
virtual	~patchIdentifier ()
const word &	name () const
	Return name.
word &	name ()
	Return name for modification.
const word &	physicalType () const
	Return the optional physical type of the patch.
word &	physicalType ()
	Return the optional physical type of the patch for modification.
label	index () const
	Return the index of this patch in the boundaryMesh.
label &	index ()
	Return the index of this patch in the boundaryMesh for modification.
void	write (Ostream &) const
	Write patchIdentifier as a dictionary.

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

---

Constructor & Destructor Documentation

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

Construct from components.

Definition at line 32 of file patchIdentifier.C.

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

Construct from dictionary.

Definition at line 45 of file patchIdentifier.C.

References dictionary::readIfPresent().

patchIdentifier	(	const patchIdentifier &	p,
		const label	index
	)

Construct from geometric patch, resetting the index.

Definition at line 59 of file patchIdentifier.C.

~patchIdentifier ( )

virtual

Definition at line 72 of file patchIdentifier.C.

---

Member Function Documentation

const word& name ( ) const

inline

Return name.

Definition at line 108 of file patchIdentifier.H.

Referenced by polyTopoChange::addMesh(), boundaryMesh::addPatch(), boundaryMesh::changeFaces(), boundaryMesh::changePatchType(), hexRef8::checkMesh(), boundaryMesh::deletePatch(), extendedCellToFaceStencil::extendedCellToFaceStencil(), extendedFaceToCellStencil::extendedFaceToCellStencil(), cellDistFuncs::getPatchIDs(), MeshedSurface< Face >::MeshedSurface(), fvPatch::name(), facePointPatch::name(), polyBoundaryMesh::neighbourEdges(), boundaryMesh::patchify(), fvMeshDistribute::printMeshInfo(), boundaryMesh::read(), motionSmoother::scaleMesh(), perfectInterface::setRefinement(), meshRefinement::testSyncBoundaryFaceList(), triSurfaceTools::triangulate(), triSurfaceTools::triangulateFaceCentre(), and boundaryMesh::writeTriSurface().

word& name ( )

inline

Return name for modification.

Definition at line 114 of file patchIdentifier.H.

const word& physicalType ( ) const

inline

Return the optional physical type of the patch.

Definition at line 120 of file patchIdentifier.H.

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

word& physicalType ( )

inline

Return the optional physical type of the patch for modification.

Definition at line 126 of file patchIdentifier.H.

label index ( ) const

inline

Return the index of this patch in the boundaryMesh.

Definition at line 132 of file patchIdentifier.H.

Referenced by boundaryMesh::changePatchType(), MaxwellianThermal< CloudType >::correct(), MixedDiffuseSpecular< CloudType >::correct(), LocalInteraction< CloudType >::correct(), DsmcParcel< ParcelType >::hitWallPatch(), fvPatch::index(), facePointPatch::index(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), and turbulentTemperatureCoupledBaffleFvPatchScalarField::updateCoeffs().

label& index ( )

inline

Return the index of this patch in the boundaryMesh for modification.

Definition at line 138 of file patchIdentifier.H.

void write

(

Ostream &

os

)

const

Write patchIdentifier as a dictionary.

Reimplemented in cyclicPolyPatch, polyPatch, processorPolyPatch, directMappedWallPolyPatch, directMappedPolyPatch, genericPolyPatch, and boundaryPatch.

Definition at line 78 of file patchIdentifier.C.

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

Referenced by Foam::operator<<(), boundaryPatch::write(), genericPolyPatch::write(), and polyPatch::write().

---

Friends And Related Function Documentation

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

friend

---

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

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