Loading...
Searching...
No Matches
patchIdentifier Class Reference

Identifies a patch by name and index, with optional physical type and group information. More...

#include <patchIdentifier.H>

Inheritance diagram for patchIdentifier:

Public Member Functions

 patchIdentifier (const patchIdentifier &)=default
 Copy construct.
 patchIdentifier (patchIdentifier &&)=default
 Move construct.
patchIdentifieroperator= (const patchIdentifier &)=default
 Copy assignment.
patchIdentifieroperator= (patchIdentifier &&)=default
 Move assignment.
virtual ~patchIdentifier ()=default
 Destructor.
 patchIdentifier ()
 Default construct: name="", index=0.
 patchIdentifier (const word &name, const label index)
 Construct from mandatory components.
 patchIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
 Construct from components.
 patchIdentifier (const word &name, const dictionary &dict, const label index)
 Construct from dictionary.
 patchIdentifier (const patchIdentifier &ident, const label newIndex)
 Copy construct, resetting the index (if non-negative).
 patchIdentifier (patchIdentifier &&ident, const label newIndex)
 Move construct, resetting the index (if non-negative).
const wordname () const noexcept
 The patch name.
wordname () noexcept
 Modifiable patch name.
label index () const noexcept
 The index of this patch in the boundaryMesh.
label & index () noexcept
 Modifiable index of this patch in the boundaryMesh.
const wordphysicalType () const noexcept
 The (optional) physical type of the patch.
wordphysicalType () noexcept
 Modifiable (optional) physical type of the patch.
const wordListinGroups () const noexcept
 The (optional) groups that the patch belongs to.
wordListinGroups () noexcept
 Modifiable (optional) groups that the patch belongs to.
bool inGroup (const word &name) const
 True if given name is in a group.
void addGroup (const word &name)
 Add (unique) group for the patch.
void removeGroup (const word &name)
 Remove group for the patch.
void write (Ostream &os) const
 Write (physicalType, inGroups) dictionary entries (without surrounding braces).

Static Public Member Functions

static word defaultName (const label n=-1)
 Default patch name: "patch" or "patchN".

Detailed Description

Identifies a patch by name and index, with optional physical type and group information.

Source files

Definition at line 51 of file patchIdentifier.H.

Constructor & Destructor Documentation

◆ patchIdentifier() [1/8]

◆ patchIdentifier() [2/8]

patchIdentifier ( patchIdentifier && )
default

Move construct.

References patchIdentifier().

Here is the call graph for this function:

◆ ~patchIdentifier()

virtual ~patchIdentifier ( )
virtualdefault

Destructor.

References dict, index(), inGroups(), name(), patchIdentifier(), and physicalType().

Here is the call graph for this function:

◆ patchIdentifier() [3/8]

patchIdentifier ( )

Default construct: name="", index=0.

Definition at line 27 of file patchIdentifier.C.

◆ patchIdentifier() [4/8]

patchIdentifier ( const word & name,
const label index )

Construct from mandatory components.

Definition at line 33 of file patchIdentifier.C.

References index(), and name().

Here is the call graph for this function:

◆ patchIdentifier() [5/8]

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

Construct from components.

Definition at line 44 of file patchIdentifier.C.

References index(), inGroups(), name(), and physicalType().

Here is the call graph for this function:

◆ patchIdentifier() [6/8]

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

Construct from dictionary.

Definition at line 59 of file patchIdentifier.C.

References dict, index(), name(), and patchIdentifier().

Here is the call graph for this function:

◆ patchIdentifier() [7/8]

patchIdentifier ( const patchIdentifier & ident,
const label newIndex )

Copy construct, resetting the index (if non-negative).

Definition at line 73 of file patchIdentifier.C.

References patchIdentifier().

Here is the call graph for this function:

◆ patchIdentifier() [8/8]

patchIdentifier ( patchIdentifier && ident,
const label newIndex )

Move construct, resetting the index (if non-negative).

Definition at line 88 of file patchIdentifier.C.

References patchIdentifier().

Here is the call graph for this function:

Member Function Documentation

◆ defaultName()

word defaultName ( const label n = -1)
inlinestatic

Default patch name: "patch" or "patchN".

Definition at line 82 of file patchIdentifier.H.

References n.

Referenced by voxelMeshSearch::makeMesh().

Here is the caller graph for this function:

◆ operator=() [1/2]

patchIdentifier & operator= ( const patchIdentifier & )
default

Copy assignment.

References patchIdentifier().

Referenced by polyPatch::operator=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=() [2/2]

patchIdentifier & operator= ( patchIdentifier && )
default

Move assignment.

References patchIdentifier().

Here is the call graph for this function:

◆ name() [1/2]

const word & name ( ) const
inlinenoexcept

The patch name.

Definition at line 178 of file patchIdentifier.H.

References Foam::noexcept.

Referenced by cyclicAMIPolyPatch::addAMIFaces(), addGroup(), boundaryMesh::addPatch(), faPatchData::assign(), boundaryPatch::boundaryPatch(), boundaryPatch::boundaryPatch(), symmetryPlanePolyPatch::calcGeometry(), wedgePolyPatch::calcGeometry(), boundaryMesh::changeFaces(), boundaryMesh::changePatchType(), pointPatch::clone(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicPolyPatch::cyclicPolyPatch(), cyclicAMIPolyPatch::cylindricalCS(), faPatch::declareRunTimeSelectionTable(), pointPatch::declareRunTimeSelectionTable(), polyPatch::declareRunTimeSelectionTable(), polyPatch::declareRunTimeSelectionTable(), boundaryMesh::deletePatch(), extendedCellToCellStencil::extendedCellToCellStencil(), extendedCellToFaceStencil::extendedCellToFaceStencil(), extendedFaceToCellStencil::extendedFaceToCellStencil(), faPatch::faPatch(), faPatch::faPatch(), coupleGroupIdentifier::findOtherPatchID(), genericFaePatchField< Type >::genericFaePatchField(), genericFaePatchField< Type >::genericFaePatchField(), genericFaPatchField< Type >::genericFaPatchField(), genericFaPatchField< Type >::genericFaPatchField(), genericPointPatchField< Type >::genericPointPatchField(), genericPointPatchField< Type >::genericPointPatchField(), zoneDistribute::getCyclicPatches(), particle< Type >::hitCyclicAMIPatch(), inGroup(), cyclicAMIPolyPatch::interpolate(), faPatch::New(), faPatch::New(), pointPatch::New(), polyPatch::New(), polyPatch::New(), polyPatch::New(), cyclicACMIPolyPatch::nonOverlapPatchID(), patchIdentifier(), patchIdentifier(), patchIdentifier(), boundaryMesh::patchify(), pointPatch::pointPatch(), pointPatch::pointPatch(), pointPatch::pointPatch(), polyPatch::polyPatch(), polyPatch::polyPatch(), polyPatch::polyPatch(), boundaryMesh::read(), removeGroup(), cyclicAMIPolyPatch::resetAMI(), cyclicACMIFvPatch::resetPatchAreas(), cyclicAMIPolyPatch::restoreScaledGeometry(), cyclicACMIPolyPatch::scalePatchFaceAreas(), cyclicACMIPolyPatch::scalePatchFaceAreas(), symmetryFaPatch::symmetryFaPatch(), processorCyclicPolyPatch::tag(), cyclicPolyPatch::transformGlobalFace(), uniformMixedFaPatchField< Type >::uniformMixedFaPatchField(), cyclicACMIPolyPatch::updateAreas(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), wedgeFaPatch::wedgeFaPatch(), boundaryMesh::writeTriSurface(), AMIWeights::writeWeightField(), and ~patchIdentifier().

◆ name() [2/2]

word & name ( )
inlinenoexcept

Modifiable patch name.

Definition at line 183 of file patchIdentifier.H.

References Foam::noexcept.

◆ index() [1/2]

label index ( ) const
inlinenoexcept

The index of this patch in the boundaryMesh.

Definition at line 188 of file patchIdentifier.H.

References Foam::noexcept.

Referenced by cyclicAMIPolyPatch::addAMIFaces(), boundaryPatch::boundaryPatch(), boundaryPatch::boundaryPatch(), boundaryPatch::boundaryPatch(), faPatch::cfindPatchField(), boundaryMesh::changePatchType(), cyclicACMIPolyPatch::clone(), cyclicACMIPolyPatch::clone(), cyclicAMIPolyPatch::clone(), cyclicAMIPolyPatch::clone(), cyclicPeriodicAMIPolyPatch::clone(), cyclicPeriodicAMIPolyPatch::clone(), cyclicPolyPatch::clone(), cyclicPolyPatch::clone(), cyclicSlipPolyPatch::clone(), cyclicSlipPolyPatch::clone(), emptyFaPatch::clone(), emptyPolyPatch::clone(), emptyPolyPatch::clone(), faPatch::clone(), genericPolyPatch::clone(), genericPolyPatch::clone(), ignoreFaPatch::clone(), mappedPolyPatch::clone(), mappedPolyPatch::clone(), mappedVariableThicknessWallPolyPatch::clone(), mappedVariableThicknessWallPolyPatch::clone(), mappedWallPolyPatch::clone(), mappedWallPolyPatch::clone(), meshPointPatch::clone(), nonuniformTransformCyclicPolyPatch::clone(), nonuniformTransformCyclicPolyPatch::clone(), oldCyclicPolyPatch::clone(), oversetPolyPatch::clone(), oversetPolyPatch::clone(), pointPatch::clone(), polyPatch::clone(), polyPatch::clone(), processorCyclicPolyPatch::clone(), processorCyclicPolyPatch::clone(), processorCyclicPolyPatch::clone(), processorPolyPatch::clone(), processorPolyPatch::clone(), symmetryFaPatch::clone(), symmetryPlanePolyPatch::clone(), symmetryPlanePolyPatch::clone(), symmetryPolyPatch::clone(), symmetryPolyPatch::clone(), wallPolyPatch::clone(), wallPolyPatch::clone(), wedgePolyPatch::clone(), wedgePolyPatch::clone(), coupledFaPatch::coupledFaPatch(), coupledFaPatch::coupledFaPatch(), coupledPolyPatch::coupledPolyPatch(), coupledPolyPatch::coupledPolyPatch(), coupledPolyPatch::coupledPolyPatch(), coupledPolyPatch::coupledPolyPatch(), cyclicACMIPointPatchField< Type >::cyclicACMIPointPatchField(), cyclicACMIPointPatchField< Type >::cyclicACMIPointPatchField(), cyclicACMIPolyPatch::cyclicACMIPolyPatch(), cyclicACMIPolyPatch::cyclicACMIPolyPatch(), cyclicACMIPolyPatch::cyclicACMIPolyPatch(), cyclicACMIPolyPatch::cyclicACMIPolyPatch(), cyclicAMIPointPatchField< Type >::cyclicAMIPointPatchField(), cyclicAMIPointPatchField< Type >::cyclicAMIPointPatchField(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicFaePatchField< Type >::cyclicFaePatchField(), cyclicFaePatchField< Type >::cyclicFaePatchField(), cyclicFaPatch::cyclicFaPatch(), cyclicPeriodicAMIPolyPatch::cyclicPeriodicAMIPolyPatch(), cyclicPeriodicAMIPolyPatch::cyclicPeriodicAMIPolyPatch(), cyclicPeriodicAMIPolyPatch::cyclicPeriodicAMIPolyPatch(), cyclicPeriodicAMIPolyPatch::cyclicPeriodicAMIPolyPatch(), cyclicPointPatchField< Type >::cyclicPointPatchField(), cyclicPointPatchField< Type >::cyclicPointPatchField(), cyclicPolyPatch::cyclicPolyPatch(), cyclicPolyPatch::cyclicPolyPatch(), cyclicPolyPatch::cyclicPolyPatch(), cyclicPolyPatch::cyclicPolyPatch(), cyclicPolyPatch::cyclicPolyPatch(), cyclicSlipPolyPatch::cyclicSlipPolyPatch(), cyclicSlipPolyPatch::cyclicSlipPolyPatch(), cyclicSlipPolyPatch::cyclicSlipPolyPatch(), cyclicSlipPolyPatch::cyclicSlipPolyPatch(), faPatch::declareRunTimeSelectionTable(), pointPatch::declareRunTimeSelectionTable(), polyPatch::declareRunTimeSelectionTable(), polyPatch::declareRunTimeSelectionTable(), faPatch::deltaCoeffs(), faPatch::edgeCentres(), faPatch::edgeLengths(), emptyFaePatchField< Type >::emptyFaePatchField(), emptyFaePatchField< Type >::emptyFaePatchField(), emptyFaPatch::emptyFaPatch(), emptyFaPatch::emptyFaPatch(), emptyFaPatch::emptyFaPatch(), emptyFaPatch::emptyFaPatch(), emptyPointPatchField< Type >::emptyPointPatchField(), emptyPointPatchField< Type >::emptyPointPatchField(), emptyPolyPatch::emptyPolyPatch(), emptyPolyPatch::emptyPolyPatch(), emptyPolyPatch::emptyPolyPatch(), emptyPolyPatch::emptyPolyPatch(), faPatch::faPatch(), faPatch::faPatch(), faPatch::faPatch(), faPatch::faPatch(), genericPolyPatch::genericPolyPatch(), genericPolyPatch::genericPolyPatch(), genericPolyPatch::genericPolyPatch(), genericPolyPatch::genericPolyPatch(), ignoreFaPatch::ignoreFaPatch(), ignoreFaPatch::ignoreFaPatch(), ignoreFaPatch::ignoreFaPatch(), ignoreFaPatch::ignoreFaPatch(), cyclicAMIPolyPatch::initInterpolateUntransformed(), cyclicAMIPolyPatch::interpolate(), faPatch::lookupPatchField(), faPatch::lPN(), faPatch::magEdgeLengths(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedPolyPatch::mappedPolyPatch(), mappedVariableThicknessWallPolyPatch::mappedVariableThicknessWallPolyPatch(), mappedVariableThicknessWallPolyPatch::mappedVariableThicknessWallPolyPatch(), mappedVariableThicknessWallPolyPatch::mappedVariableThicknessWallPolyPatch(), mappedVariableThicknessWallPolyPatch::mappedVariableThicknessWallPolyPatch(), mappedVariableThicknessWallPolyPatch::mappedVariableThicknessWallPolyPatch(), mappedVariableThicknessWallPolyPatch::mappedVariableThicknessWallPolyPatch(), mappedWallPolyPatch::mappedWallPolyPatch(), mappedWallPolyPatch::mappedWallPolyPatch(), mappedWallPolyPatch::mappedWallPolyPatch(), mappedWallPolyPatch::mappedWallPolyPatch(), mappedWallPolyPatch::mappedWallPolyPatch(), mappedWallPolyPatch::mappedWallPolyPatch(), oversetPolyPatch::master(), meshPointPatch::meshPointPatch(), meshPointPatch::meshPointPatch(), meshPointPatch::meshPointPatch(), meshPointPatch::meshPointPatch(), cyclicACMIFvPatch::movePoints(), cyclicFaPatch::neighbPatchID(), cyclicAMIPolyPatch::neighbPolyPatchID(), mappedPolyPatch::neighbPolyPatchID(), mappedWallPolyPatch::neighbPolyPatchID(), faPatch::New(), faPatch::New(), pointPatch::New(), polyPatch::New(), polyPatch::New(), polyPatch::New(), faPatch::ngbPolyPatchFaceNormals(), faPatch::ngbPolyPatchPointNormals(), cyclicACMIPolyPatch::nonOverlapPatchID(), nonuniformTransformCyclicPolyPatch::nonuniformTransformCyclicPolyPatch(), nonuniformTransformCyclicPolyPatch::nonuniformTransformCyclicPolyPatch(), nonuniformTransformCyclicPolyPatch::nonuniformTransformCyclicPolyPatch(), nonuniformTransformCyclicPolyPatch::nonuniformTransformCyclicPolyPatch(), faPatch::offset(), oldCyclicPolyPatch::oldCyclicPolyPatch(), oldCyclicPolyPatch::oldCyclicPolyPatch(), oldCyclicPolyPatch::oldCyclicPolyPatch(), oversetPolyPatch::oversetPolyPatch(), oversetPolyPatch::oversetPolyPatch(), oversetPolyPatch::oversetPolyPatch(), oversetPolyPatch::oversetPolyPatch(), cyclicAMIPolyPatch::owner(), cyclicPolyPatch::owner(), faPatch::patchField(), patchIdentifier(), patchIdentifier(), patchIdentifier(), pointPatch::pointPatch(), pointPatch::pointPatch(), pointPatch::pointPatch(), polyPatch::polyPatch(), polyPatch::polyPatch(), polyPatch::polyPatch(), polyPatch::polyPatch(), polyPatch::polyPatch(), processorCyclicPolyPatch::processorCyclicPolyPatch(), processorCyclicPolyPatch::processorCyclicPolyPatch(), processorCyclicPolyPatch::processorCyclicPolyPatch(), processorCyclicPolyPatch::processorCyclicPolyPatch(), processorCyclicPolyPatch::processorCyclicPolyPatch(), processorFaePatchField< Type >::processorFaePatchField(), processorFaePatchField< Type >::processorFaePatchField(), processorFaPatch::processorFaPatch(), processorFaPatch::processorFaPatch(), processorFaPatch::processorFaPatch(), processorPolyPatch::processorPolyPatch(), processorPolyPatch::processorPolyPatch(), processorPolyPatch::processorPolyPatch(), processorPolyPatch::processorPolyPatch(), processorPolyPatch::processorPolyPatch(), faPatch::skewCorrectionVectors(), faPatch::start(), symmetryFaePatchField< Type >::symmetryFaePatchField(), symmetryFaePatchField< Type >::symmetryFaePatchField(), symmetryFaPatch::symmetryFaPatch(), symmetryFaPatch::symmetryFaPatch(), symmetryFaPatch::symmetryFaPatch(), symmetryPlanePointPatchField< Type >::symmetryPlanePointPatchField(), symmetryPlanePointPatchField< Type >::symmetryPlanePointPatchField(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPlanePolyPatch::symmetryPlanePolyPatch(), symmetryPointPatchField< Type >::symmetryPointPatchField(), symmetryPointPatchField< Type >::symmetryPointPatchField(), symmetryPolyPatch::symmetryPolyPatch(), symmetryPolyPatch::symmetryPolyPatch(), symmetryPolyPatch::symmetryPolyPatch(), symmetryPolyPatch::symmetryPolyPatch(), coupledPolyPatch::TypeName(), cyclicACMIPolyPatch::TypeName(), cyclicAMIPolyPatch::TypeName(), cyclicFaPatch::TypeName(), cyclicPeriodicAMIPolyPatch::TypeName(), cyclicPolyPatch::TypeName(), emptyFaPatch::TypeName(), emptyPolyPatch::TypeName(), genericPolyPatch::TypeName(), ignoreFaPatch::TypeName(), mappedPolyPatch::TypeName(), mappedVariableThicknessWallPolyPatch::TypeName(), mappedWallPolyPatch::TypeName(), meshPointPatch::TypeName(), oldCyclicPolyPatch::TypeName(), oversetPolyPatch::TypeName(), processorCyclicPolyPatch::TypeName(), processorFaPatch::TypeName(), processorPolyPatch::TypeName(), symmetryFaPatch::TypeName(), symmetryPlanePolyPatch::TypeName(), symmetryPolyPatch::TypeName(), wallPolyPatch::TypeName(), wedgeFaPatch::TypeName(), wedgePolyPatch::TypeName(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), mappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), processorFaPatch::updateMesh(), processorPolyPatch::updateMesh(), LookupField< Type >::value(), wallPolyPatch::wallPolyPatch(), wallPolyPatch::wallPolyPatch(), wallPolyPatch::wallPolyPatch(), wallPolyPatch::wallPolyPatch(), wedgeFaePatchField< Type >::wedgeFaePatchField(), wedgeFaePatchField< Type >::wedgeFaePatchField(), wedgeFaPatch::wedgeFaPatch(), wedgeFaPatchField< Type >::wedgeFaPatchField(), wedgeFaPatchField< Type >::wedgeFaPatchField(), wedgePointPatchField< Type >::wedgePointPatchField(), wedgePointPatchField< Type >::wedgePointPatchField(), wedgePolyPatch::wedgePolyPatch(), wedgePolyPatch::wedgePolyPatch(), wedgePolyPatch::wedgePolyPatch(), wedgePolyPatch::wedgePolyPatch(), faPatch::weights(), and ~patchIdentifier().

◆ index() [2/2]

label & index ( )
inlinenoexcept

Modifiable index of this patch in the boundaryMesh.

Definition at line 193 of file patchIdentifier.H.

References Foam::noexcept.

◆ physicalType() [1/2]

◆ physicalType() [2/2]

word & physicalType ( )
inlinenoexcept

Modifiable (optional) physical type of the patch.

Definition at line 203 of file patchIdentifier.H.

References Foam::noexcept.

◆ inGroups() [1/2]

const wordList & inGroups ( ) const
inlinenoexcept

The (optional) groups that the patch belongs to.

Definition at line 208 of file patchIdentifier.H.

References Foam::noexcept.

Referenced by polyPatch::declareRunTimeSelectionTable(), facePointPatch::facePointPatch(), facePointPatch::facePointPatch(), patchIdentifier(), pointPatch::pointPatch(), pointPatch::pointPatch(), polyPatch::polyPatch(), and ~patchIdentifier().

Here is the caller graph for this function:

◆ inGroups() [2/2]

wordList & inGroups ( )
inlinenoexcept

Modifiable (optional) groups that the patch belongs to.

Definition at line 213 of file patchIdentifier.H.

References Foam::noexcept.

◆ inGroup()

bool inGroup ( const word & name) const
inline

True if given name is in a group.

Definition at line 218 of file patchIdentifier.H.

References name().

Here is the call graph for this function:

◆ addGroup()

◆ removeGroup()

void removeGroup ( const word & name)

Remove group for the patch.

Definition at line 105 of file patchIdentifier.C.

References name().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os) const

Write (physicalType, inGroups) dictionary entries (without surrounding braces).

Definition at line 124 of file patchIdentifier.C.

References os().

Referenced by Foam::operator<<(), boundaryPatch::write(), faPatch::write(), genericPolyPatch::write(), mappedWallPolyPatch::write(), oldCyclicPolyPatch::write(), pointPatch::write(), and polyPatch::write().

Here is the call graph for this function:
Here is the caller graph for this function:

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