Public Member Functions | Protected Attributes | Friends | List of all members
patchIdentifier Class Reference

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

Inheritance diagram for patchIdentifier:
Inheritance graph
[legend]
Collaboration diagram for patchIdentifier:
Collaboration graph
[legend]

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 &, const label index)
 Construct from dictionary. More...
 
 patchIdentifier (const patchIdentifier &, const label index)
 Construct from geometric patch, resetting the index. More...
 
virtual ~patchIdentifier ()
 Destructor. More...
 
const word & name () const
 Return name. More...
 
label index () const
 Return the index of this patch in the boundaryMesh. More...
 
const word & physicalType () const
 Return the optional physical type of the patch. More...
 
word & physicalType ()
 Return the optional physical type of the patch for modification. More...
 
const wordList & inGroups () const
 Return the optional groups patch belongs to. More...
 
wordList & inGroups ()
 Return the optional groups patch belongs to for modification. More...
 
bool inGroup (const word &) const
 Test if in group. More...
 
void write (Ostream &) const
 Write patchIdentifier as a dictionary. More...
 

Protected Attributes

word name_
 Name of patch. More...
 
label index_
 Index of patch in boundary. More...
 
word physicalType_
 Optional physical type. More...
 
wordList inGroups_
 Optional groups patch belongs to. More...
 

Friends

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

Detailed Description

Identifies 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 32 of file patchIdentifier.C.

◆ patchIdentifier() [2/3]

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

Construct from dictionary.

Definition at line 47 of file patchIdentifier.C.

References dict, patchIdentifier::inGroups_, and patchIdentifier::physicalType_.

◆ patchIdentifier() [3/3]

patchIdentifier ( const patchIdentifier &  p,
const label  index 
)

Construct from geometric patch, resetting the index.

Definition at line 62 of file patchIdentifier.C.

◆ ~patchIdentifier()

~patchIdentifier ( )
virtual

Destructor.

Definition at line 77 of file patchIdentifier.C.

Member Function Documentation

◆ name()

const word& name ( ) const
inline

Return name.

Definition at line 112 of file patchIdentifier.H.

References patchIdentifier::name_.

Referenced by polyTopoChange::addMesh(), repatchMesh::addPatch(), fvMeshTools::addPatch(), symmetryPlanePolyPatch::calcGeometry(), wedgePolyPatch::calcGeometry(), repatchMesh::changePatchType(), hexRef8::checkMesh(), meshRefinement::checkZoneFaces(), particle::correctAfterNonConformalCyclicTransfer(), cyclicPolyPatch::cyclicPolyPatch(), decompositionMethod::decompose(), repatchMesh::deletePatch(), snappyLayerDriver::doLayers(), extendedCellToCellStencil::extendedCellToCellStencil(), extendedCellToFaceStencil::extendedCellToFaceStencil(), extendedFaceToCellStencil::extendedFaceToCellStencil(), coupleGroupIdentifier::findOtherPatchID(), mappedPatchBase::getMap(), FaceCellWave< Type, TrackingData >::handleCyclicPatches(), FaceCellWave< Type, TrackingData >::handleProcPatches(), MomentumParcel< ParcelType >::hitWallPatch(), meshToMesh::meshToMesh(), fvPatch::name(), facePointPatch::name(), polyBoundaryMesh::nbrEdges(), polyPatch::New(), mappedExtrudedPatchBase::patchFaceAreas(), mappedExtrudedPatchBase::patchLocalPoints(), Foam::polyMeshUnMergeCyclics(), fvMeshDistribute::printMeshInfo(), repatchMesh::read(), motionSmootherAlgo::scaleMesh(), processorCyclicPolyPatch::tag(), meshRefinement::testSyncBoundaryFaceList(), triSurfaceTools::triangulate(), triSurfaceTools::triangulateFaceCentre(), patch::update(), patchToPatchStabilisation::update(), and mappedPatchBase::validateMapForField().

Here is the caller graph for this function:

◆ index()

label index ( ) const
inline

Return the index of this patch in the boundaryMesh.

Definition at line 118 of file patchIdentifier.H.

References patchIdentifier::index_.

Referenced by CloudFilmTransfer< CloudType >::absorbInteraction(), CloudFilmTransfer< CloudType >::bounceInteraction(), semiPermeableBaffleMassFractionFvPatchScalarField::calcPhiYp(), repatchMesh::changePatchType(), meshToMesh::consistent(), VoFFilmTransfer::correct(), LocalInteraction< CloudType >::correct(), CloudFilmTransfer< CloudType >::drySplashInteraction(), radiationCoupledBase::emissivity(), particle::hitNonConformalCyclicPatch(), fvPatch::index(), facePointPatch::index(), polyPatch::New(), cyclicPolyPatch::owner(), MomentumCloud< CloudType >::patchData(), ParticleErosion< CloudType >::postPatch(), PatchCollisionDensity< CloudType >::postPatch(), PatchPostProcessing< CloudType >::postPatch(), CloudFilmTransfer< CloudType >::splashInteraction(), CloudFilmTransfer< CloudType >::transferParcel(), filmSurfaceVelocityFvPatchVectorField::updateCoeffs(), mappedFlowRateVelocityFvPatchVectorField::updateCoeffs(), mappedVelocityFluxFvPatchField::updateCoeffs(), coupledTemperatureFvPatchScalarField::updateCoeffs(), and CloudFilmTransfer< CloudType >::wetSplashInteraction().

Here is the caller graph for this function:

◆ physicalType() [1/2]

const word& physicalType ( ) const
inline

Return the optional physical type of the patch.

Definition at line 124 of file patchIdentifier.H.

References patchIdentifier::physicalType_.

Referenced by repatchMesh::addPatch(), repatchMesh::deletePatch(), and repatchMesh::read().

Here is the caller graph for this function:

◆ physicalType() [2/2]

word& physicalType ( )
inline

Return the optional physical type of the patch for modification.

Definition at line 130 of file patchIdentifier.H.

References patchIdentifier::physicalType_.

◆ inGroups() [1/2]

const wordList& inGroups ( ) const
inline

Return the optional groups patch belongs to.

Definition at line 136 of file patchIdentifier.H.

References patchIdentifier::inGroups_.

Referenced by filmSurfacePolyPatch::filmSurfacePolyPatch(), filmWallPolyPatch::filmWallPolyPatch(), mappedExtrudedWallPolyPatch::mappedExtrudedWallPolyPatch(), mappedFilmSurfacePolyPatch::mappedFilmSurfacePolyPatch(), mappedFilmWallPolyPatch::mappedFilmWallPolyPatch(), mappedInternalPolyPatch::mappedInternalPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedWallPolyPatch::mappedWallPolyPatch(), polyPatch::polyPatch(), polyBoundaryMesh::setGroup(), and wallPolyPatch::wallPolyPatch().

Here is the caller graph for this function:

◆ inGroups() [2/2]

wordList& inGroups ( )
inline

Return the optional groups patch belongs to for modification.

Definition at line 142 of file patchIdentifier.H.

References patchIdentifier::inGroups_.

◆ inGroup()

bool inGroup ( const word &  name) const

Test if in group.

Definition at line 83 of file patchIdentifier.C.

References Foam::findIndex(), and Foam::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 89 of file patchIdentifier.C.

References Foam::writeEntry().

Referenced by repatchPatch::write(), genericPolyPatch::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 &  ,
const patchIdentifier &   
)
friend

Member Data Documentation

◆ name_

word name_
protected

Name of patch.

Definition at line 64 of file patchIdentifier.H.

Referenced by patchIdentifier::name().

◆ index_

label index_
protected

Index of patch in boundary.

Definition at line 67 of file patchIdentifier.H.

Referenced by patchIdentifier::index().

◆ physicalType_

word physicalType_
protected

Optional physical type.

Definition at line 70 of file patchIdentifier.H.

Referenced by patchIdentifier::patchIdentifier(), and patchIdentifier::physicalType().

◆ inGroups_

wordList inGroups_
protected

Optional groups patch belongs to.

Definition at line 73 of file patchIdentifier.H.

Referenced by patchIdentifier::inGroups(), and patchIdentifier::patchIdentifier().

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