Identifies a patch by name and index, with optional physical type and group information. More...
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. Uses name="", index=0. 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 &ident, const label index) | |
Copy construct, resetting the index. More... | |
const word & | name () const noexcept |
The patch name. More... | |
word & | name () noexcept |
Modifiable patch name. More... | |
label | index () const noexcept |
The index of this patch in the boundaryMesh. More... | |
label & | index () noexcept |
Modifiable index of this patch in the boundaryMesh. More... | |
const word & | physicalType () const noexcept |
The (optional) physical type of the patch. More... | |
word & | physicalType () noexcept |
Modifiable (optional) physical type of the patch. More... | |
const wordList & | inGroups () const noexcept |
The (optional) groups that the patch belongs to. More... | |
wordList & | inGroups () noexcept |
Modifiable (optional) groups that the patch belongs to. More... | |
bool | inGroup (const word &name) const |
True if given name is in a group. More... | |
void | write (Ostream &os) const |
Write (physicalType, inGroups) dictionary entries (without surrounding braces) More... | |
Static Public Member Functions | |
static word | defaultName (const label n=-1) |
Default patch name: "patch" or "patchN". More... | |
Identifies a patch by name and index, with optional physical type and group information.
Definition at line 51 of file patchIdentifier.H.
|
default |
Copy construct.
|
virtualdefault |
Destructor.
patchIdentifier | ( | ) |
Default construct. Uses name="", index=0.
Definition at line 27 of file patchIdentifier.C.
patchIdentifier | ( | const word & | name, |
const label | index | ||
) |
Construct from mandatory components.
Definition at line 35 of file patchIdentifier.C.
patchIdentifier | ( | const word & | name, |
const label | index, | ||
const word & | physicalType, | ||
const wordList & | inGroups = wordList() |
||
) |
Construct from components.
Definition at line 46 of file patchIdentifier.C.
patchIdentifier | ( | const word & | name, |
const dictionary & | dict, | ||
const label | index | ||
) |
Construct from dictionary.
Definition at line 61 of file patchIdentifier.C.
References dict, and dictionary::readIfPresent().
patchIdentifier | ( | const patchIdentifier & | ident, |
const label | index | ||
) |
Copy construct, resetting the index.
Definition at line 75 of file patchIdentifier.C.
|
inlinestatic |
Default patch name: "patch" or "patchN".
Definition at line 82 of file patchIdentifier.H.
References n.
Referenced by voxelMeshSearch::makeMesh().
|
default |
|
inlinenoexcept |
The patch name.
Definition at line 159 of file patchIdentifier.H.
Referenced by cyclicAMIPolyPatch::addAMIFaces(), polyTopoChange::addMesh(), boundaryMesh::addPatch(), faPatchData::assign(), symmetryPlanePolyPatch::calcGeometry(), wedgePolyPatch::calcGeometry(), boundaryMesh::changeFaces(), boundaryMesh::changePatchType(), hexRef8::checkMesh(), lumpedPointMovement::checkPatchControl(), cyclicAMIPolyPatch::cylindricalCS(), boundaryMesh::deletePatch(), snappyLayerDriver::doLayers(), extendedCellToCellStencil::extendedCellToCellStencil(), extendedCellToFaceStencil::extendedCellToFaceStencil(), extendedFaceToCellStencil::extendedFaceToCellStencil(), faMesh::faMesh(), coupleGroupIdentifier::findOtherPatchID(), FaceCellWave< Type, TrackingData >::handleProcPatches(), particle< Type >::hitCyclicAMIPatch(), patchIdentifier::inGroup(), cyclicAMIPolyPatch::interpolate(), trackingInverseDistance::markBoundaries(), facePointPatch::name(), fvPatch::name(), polyBoundaryMesh::neighbourEdges(), cyclicACMIPolyPatch::nonOverlapPatchID(), boundaryMesh::patchify(), fvMeshDistribute::printMeshInfo(), polyMeshAdder::procPatchPairs(), boundaryMesh::read(), AMIWeights::reportPatch(), cyclicACMIPolyPatch::resetAMI(), cyclicACMIFvPatch::resetPatchAreas(), cyclicAMIPolyPatch::restoreScaledGeometry(), motionSmootherAlgo::scaleMesh(), cyclicACMIPolyPatch::scalePatchFaceAreas(), solidAbsorption::solidAbsorption(), processorCyclicPolyPatch::tag(), meshRefinement::testSyncBoundaryFaceList(), cyclicPolyPatch::transformGlobalFace(), dynamicMotionSolverFvMeshAMI::update(), cyclicACMIPolyPatch::updateAreas(), vtkWrite::write(), boundaryMesh::writeTriSurface(), and AMIWeights::writeWeightField().
|
inlinenoexcept |
Modifiable patch name.
Definition at line 167 of file patchIdentifier.H.
|
inlinenoexcept |
The index of this patch in the boundaryMesh.
Definition at line 175 of file patchIdentifier.H.
Referenced by KinematicSurfaceFilm< CloudType >::absorbInteraction(), cyclicAMIPolyPatch::addAMIFaces(), KinematicSurfaceFilm< CloudType >::bounceInteraction(), boundaryPatch::boundaryPatch(), boundaryMesh::changePatchType(), lumpedPointMovement::checkPatchControl(), emptyPolyPatch::clone(), wallPolyPatch::clone(), symmetryPolyPatch::clone(), emptyFaPatch::clone(), symmetryFaPatch::clone(), oversetPolyPatch::clone(), genericPolyPatch::clone(), symmetryPlanePolyPatch::clone(), cyclicSlipPolyPatch::clone(), nonuniformTransformCyclicPolyPatch::clone(), wedgePolyPatch::clone(), cyclicPeriodicAMIPolyPatch::clone(), mappedVariableThicknessWallPolyPatch::clone(), mappedWallPolyPatch::clone(), mappedPolyPatch::clone(), processorCyclicPolyPatch::clone(), processorPolyPatch::clone(), faPatch::clone(), oldCyclicPolyPatch::clone(), polyPatch::clone(), cyclicACMIPolyPatch::clone(), cyclicPolyPatch::clone(), cyclicAMIPolyPatch::clone(), MultiInteraction< CloudType >::correct(), LocalInteraction< CloudType >::correct(), StandardWallInteraction< CloudType >::correct(), RecycleInteraction< CloudType >::correct(), KinematicSurfaceFilm< CloudType >::drySplashInteraction(), lumpedPointMovement::hasPatchControl(), facePointPatch::index(), fvPatch::index(), cyclicACMIFvPatch::movePoints(), cyclicFaPatch::neighbPatchID(), mappedWallPolyPatch::neighbPolyPatchID(), mappedPolyPatch::neighbPolyPatchID(), cyclicAMIPolyPatch::neighbPolyPatchID(), cyclicPolyPatch::owner(), KinematicCloud< Cloud< basicKinematicCollidingParcel > >::patchData(), semiPermeableBaffleMassFractionFvPatchScalarField::phiY(), PatchCollisionDensity< CloudType >::postPatch(), ParticleErosion< CloudType >::postPatch(), PatchPostProcessing< CloudType >::postPatch(), PatchInteractionFields< CloudType >::postPatch(), PatchParticleHistogram< CloudType >::postPatch(), AMIWeights::read(), lumpedPointMovement::setPatchControl(), KinematicSurfaceFilm< CloudType >::splashInteraction(), ThermoSurfaceFilm< CloudType >::transferParcel(), KinematicSurfaceFilm< CloudType >::transferParcel(), mappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), KinematicSurfaceFilm< CloudType >::wetSplashInteraction(), and vtkWrite::write().
|
inlinenoexcept |
Modifiable index of this patch in the boundaryMesh.
Definition at line 183 of file patchIdentifier.H.
|
inlinenoexcept |
The (optional) physical type of the patch.
Definition at line 191 of file patchIdentifier.H.
Referenced by boundaryMesh::addPatch(), boundaryMesh::changeFaces(), boundaryMesh::deletePatch(), boundaryMesh::patchify(), boundaryMesh::read(), and boundaryMesh::writeTriSurface().
|
inlinenoexcept |
Modifiable (optional) physical type of the patch.
Definition at line 199 of file patchIdentifier.H.
|
inlinenoexcept |
The (optional) groups that the patch belongs to.
Definition at line 207 of file patchIdentifier.H.
|
inlinenoexcept |
Modifiable (optional) groups that the patch belongs to.
Definition at line 215 of file patchIdentifier.H.
|
inline |
True if given name is in a group.
Definition at line 223 of file patchIdentifier.H.
References UList< T >::found(), and patchIdentifier::name().
void write | ( | Ostream & | os | ) | const |
Write (physicalType, inGroups) dictionary entries (without surrounding braces)
Definition at line 89 of file patchIdentifier.C.
References token::END_STATEMENT, Foam::nl, os(), Ostream::writeEntry(), and Ostream::writeKeyword().
Referenced by Foam::operator<<(), boundaryPatch::write(), genericPolyPatch::write(), oldCyclicPolyPatch::write(), faPatch::write(), and polyPatch::write().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.