Public Member Functions | Static Public Member Functions | List of all members
patchIdentifier Class Reference

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

Inheritance diagram for patchIdentifier:
Inheritance graph
[legend]

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...
 

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 ( const patchIdentifier &  )
default

Copy construct.

◆ patchIdentifier() [2/8]

patchIdentifier ( patchIdentifier &&  )
default

Move construct.

◆ ~patchIdentifier()

virtual ~patchIdentifier ( )
virtualdefault

Destructor.

◆ 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 35 of file patchIdentifier.C.

◆ patchIdentifier() [5/8]

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() [6/8]

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().

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

◆ patchIdentifier() [8/8]

patchIdentifier ( patchIdentifier &&  ident,
const label  newIndex 
)

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

Definition at line 90 of file patchIdentifier.C.

Member Function Documentation

◆ defaultName()

static 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.

Referenced by polyPatch::operator=().

Here is the caller graph for this function:

◆ operator=() [2/2]

patchIdentifier& operator= ( patchIdentifier &&  )
default

Move assignment.

◆ name() [1/2]

const word& name ( ) const
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(), fvPatch::name(), facePointPatch::name(), cyclicACMIPolyPatch::nonOverlapPatchID(), boundaryMesh::patchify(), boundaryMesh::read(), cyclicACMIPolyPatch::resetAMI(), cyclicAMIPolyPatch::resetAMI(), cyclicACMIFvPatch::resetPatchAreas(), cyclicAMIPolyPatch::restoreScaledGeometry(), cyclicACMIPolyPatch::scalePatchFaceAreas(), lumpedPointMovement::setInterpolator(), processorCyclicPolyPatch::tag(), cyclicPolyPatch::transformGlobalFace(), cyclicACMIPolyPatch::updateAreas(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), boundaryMesh::writeTriSurface(), and AMIWeights::writeWeightField().

Here is the caller graph for this function:

◆ name() [2/2]

word& name ( )
inlinenoexcept

Modifiable patch name.

Definition at line 183 of file patchIdentifier.H.

◆ index() [1/2]

label index ( ) const
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(), emptyPolyPatch::clone(), wallPolyPatch::clone(), ignoreFaPatch::clone(), symmetryPolyPatch::clone(), emptyFaPatch::clone(), symmetryFaPatch::clone(), oversetPolyPatch::clone(), genericPolyPatch::clone(), symmetryPlanePolyPatch::clone(), cyclicSlipPolyPatch::clone(), nonuniformTransformCyclicPolyPatch::clone(), wedgePolyPatch::clone(), meshPointPatch::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(), lumpedPointMovement::hasInterpolator(), fvPatch::index(), facePointPatch::index(), cyclicACMIFvPatch::movePoints(), cyclicFaPatch::neighbPatchID(), mappedWallPolyPatch::neighbPolyPatchID(), mappedPolyPatch::neighbPolyPatchID(), cyclicAMIPolyPatch::neighbPolyPatchID(), cyclicPolyPatch::owner(), semiPermeableBaffleMassFractionFvPatchScalarField::phiY(), pointBoundaryMesh::pointBoundaryMesh(), lumpedPointMovement::pointsDisplacement(), lumpedPointMovement::pointsPosition(), lumpedPointMovement::setInterpolator(), mappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), and humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ index() [2/2]

label& index ( )
inlinenoexcept

Modifiable index of this patch in the boundaryMesh.

Definition at line 193 of file patchIdentifier.H.

◆ physicalType() [1/2]

const word& physicalType ( ) const
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().

Here is the caller graph for this function:

◆ physicalType() [2/2]

word& physicalType ( )
inlinenoexcept

Modifiable (optional) physical type of the patch.

Definition at line 203 of file patchIdentifier.H.

◆ inGroups() [1/2]

const wordList& inGroups ( ) const
inlinenoexcept

The (optional) groups that the patch belongs to.

Definition at line 208 of file patchIdentifier.H.

◆ inGroups() [2/2]

wordList& inGroups ( )
inlinenoexcept

Modifiable (optional) groups that the patch belongs to.

Definition at line 213 of file patchIdentifier.H.

◆ 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 UList< T >::contains(), and patchIdentifier::name().

Here is the call graph for this function:

◆ addGroup()

void addGroup ( const word &  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().

Here is the call graph for this function:

◆ removeGroup()

void removeGroup ( const word &  name)

Remove group for the patch.

Definition at line 106 of file patchIdentifier.C.

References Foam::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 125 of file patchIdentifier.C.

References Ostream::endEntry(), os(), Ostream::writeEntry(), and Ostream::writeKeyword().

Referenced by Foam::operator<<(), boundaryPatch::write(), genericPolyPatch::write(), pointPatch::write(), oldCyclicPolyPatch::write(), faPatch::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: