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 (patchIdentifier &&)=default | |
Move construct. More... | |
patchIdentifier & | operator= (const patchIdentifier &)=default |
Copy assignment. More... | |
patchIdentifier & | operator= (patchIdentifier &&)=default |
Move assignment. More... | |
virtual | ~patchIdentifier ()=default |
Destructor. More... | |
patchIdentifier () | |
Default construct: 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 newIndex) | |
Copy construct, resetting the index (if non-negative) More... | |
patchIdentifier (patchIdentifier &&ident, const label newIndex) | |
Move construct, resetting the index (if non-negative) 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 | addGroup (const word &name) |
Add (unique) group for the patch. More... | |
void | removeGroup (const word &name) |
Remove group for the patch. 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.
|
default |
Move construct.
|
virtualdefault |
Destructor.
patchIdentifier | ( | ) |
Default construct: 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 | newIndex | ||
) |
Copy construct, resetting the index (if non-negative)
Definition at line 75 of file patchIdentifier.C.
patchIdentifier | ( | patchIdentifier && | ident, |
const label | newIndex | ||
) |
Move construct, resetting the index (if non-negative)
Definition at line 90 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 |
|
default |
Move assignment.
|
inlinenoexcept |
The patch name.
Definition at line 178 of file patchIdentifier.H.
Referenced by cyclicAMIPolyPatch::addAMIFaces(), patchIdentifier::addGroup(), boundaryMesh::addPatch(), faPatchData::assign(), symmetryPlanePolyPatch::calcGeometry(), wedgePolyPatch::calcGeometry(), boundaryMesh::changeFaces(), boundaryMesh::changePatchType(), cyclicAMIPolyPatch::cylindricalCS(), boundaryMesh::deletePatch(), extendedCellToCellStencil::extendedCellToCellStencil(), extendedCellToFaceStencil::extendedCellToFaceStencil(), extendedFaceToCellStencil::extendedFaceToCellStencil(), coupleGroupIdentifier::findOtherPatchID(), particle< Type >::hitCyclicAMIPatch(), patchIdentifier::inGroup(), cyclicAMIPolyPatch::interpolate(), facePointPatch::name(), fvPatch::name(), cyclicACMIPolyPatch::nonOverlapPatchID(), boundaryMesh::patchify(), boundaryMesh::read(), cyclicACMIPolyPatch::resetAMI(), cyclicAMIPolyPatch::resetAMI(), cyclicACMIFvPatch::resetPatchAreas(), cyclicAMIPolyPatch::restoreScaledGeometry(), cyclicACMIPolyPatch::scalePatchFaceAreas(), processorCyclicPolyPatch::tag(), cyclicPolyPatch::transformGlobalFace(), cyclicACMIPolyPatch::updateAreas(), boundaryMesh::writeTriSurface(), and AMIWeights::writeWeightField().
|
inlinenoexcept |
Modifiable patch name.
Definition at line 183 of file patchIdentifier.H.
|
inlinenoexcept |
The index of this patch in the boundaryMesh.
Definition at line 188 of file patchIdentifier.H.
Referenced by cyclicAMIPolyPatch::addAMIFaces(), boundaryPatch::boundaryPatch(), boundaryMesh::changePatchType(), wallPolyPatch::clone(), emptyPolyPatch::clone(), ignoreFaPatch::clone(), symmetryPolyPatch::clone(), emptyFaPatch::clone(), symmetryFaPatch::clone(), oversetPolyPatch::clone(), genericPolyPatch::clone(), symmetryPlanePolyPatch::clone(), cyclicSlipPolyPatch::clone(), nonuniformTransformCyclicPolyPatch::clone(), wedgePolyPatch::clone(), mappedVariableThicknessWallPolyPatch::clone(), cyclicPeriodicAMIPolyPatch::clone(), mappedWallPolyPatch::clone(), mappedPolyPatch::clone(), processorCyclicPolyPatch::clone(), processorPolyPatch::clone(), faPatch::clone(), oldCyclicPolyPatch::clone(), polyPatch::clone(), cyclicACMIPolyPatch::clone(), cyclicPolyPatch::clone(), cyclicAMIPolyPatch::clone(), facePointPatch::index(), fvPatch::index(), cyclicACMIFvPatch::movePoints(), cyclicFaPatch::neighbPatchID(), mappedWallPolyPatch::neighbPolyPatchID(), mappedPolyPatch::neighbPolyPatchID(), cyclicAMIPolyPatch::neighbPolyPatchID(), cyclicPolyPatch::owner(), semiPermeableBaffleMassFractionFvPatchScalarField::phiY(), mappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), and humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs().
|
inlinenoexcept |
Modifiable index of this patch in the boundaryMesh.
Definition at line 193 of file patchIdentifier.H.
|
inlinenoexcept |
The (optional) physical type of the patch.
Definition at line 198 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 203 of file patchIdentifier.H.
|
inlinenoexcept |
The (optional) groups that the patch belongs to.
Definition at line 208 of file patchIdentifier.H.
|
inlinenoexcept |
Modifiable (optional) groups that the patch belongs to.
Definition at line 213 of file patchIdentifier.H.
|
inline |
True if given name is in a group.
Definition at line 218 of file patchIdentifier.H.
References UList< T >::contains(), and patchIdentifier::name().
|
inline |
Add (unique) group for the patch.
Definition at line 226 of file patchIdentifier.H.
References UList< T >::contains(), patchIdentifier::name(), and List< T >::push_back().
void removeGroup | ( | const word & | name | ) |
Remove group for the patch.
Definition at line 106 of file patchIdentifier.C.
References Foam::name().
void write | ( | Ostream & | os | ) | const |
Write (physicalType, inGroups) dictionary entries (without surrounding braces)
Definition at line 125 of file patchIdentifier.C.
References Ostream::endEntry(), os(), Ostream::writeEntry(), and Ostream::writeKeyword().
Referenced by Foam::operator<<(), boundaryPatch::write(), genericPolyPatch::write(), oldCyclicPolyPatch::write(), faPatch::write(), and polyPatch::write().