Public Member Functions | Private Attributes | Friends
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...
 
word & name ()
 Return name for modification. 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...
 
label index () const
 Return the index of this patch in the boundaryMesh. More...
 
label & index ()
 Return the index of this patch in the boundaryMesh 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...
 

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

◆ patchIdentifier() [2/3]

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

Construct from dictionary.

Definition at line 48 of file patchIdentifier.C.

References dict.

◆ patchIdentifier() [3/3]

patchIdentifier ( const patchIdentifier &  p,
const label  index 
)

Construct from geometric patch, resetting the index.

Definition at line 63 of file patchIdentifier.C.

◆ ~patchIdentifier()

~patchIdentifier ( )
virtual

Destructor.

Definition at line 77 of file patchIdentifier.C.

Member Function Documentation

◆ name() [1/2]

const word& name ( ) const
inline

Return name.

Definition at line 109 of file patchIdentifier.H.

References patchIdentifier::name_.

Referenced by polyTopoChange::addMesh(), fvMeshTools::addPatch(), boundaryMesh::addPatch(), fvMeshDistribute::addProcPatches(), singleCellFvMesh::agglomerateMesh(), meshToMesh0::calcAddressing(), symmetryPlanePolyPatch::calcGeometry(), wedgePolyPatch::calcGeometry(), mappedPatchBase::calcMapping(), patchCloudSet::calcSamples(), patchSeedSet::calcSamples(), wallShearStress::calcShearStress(), cyclicPolyPatch::calcTransforms(), cyclicAMIPolyPatch::calcTransforms(), meshToMesh::calculatePatchAMIs(), boundaryMesh::changeFaces(), changeFrontBackPatches(), boundaryMesh::changePatchType(), hexRef8::checkMesh(), Foam::checkTopology(), Foam::checkWedges(), patchToFace::combine(), meshToMesh::constructNoCuttingPatches(), decompositionMethod::decompose(), boundaryMesh::deletePatch(), fvMeshDistribute::deleteProcPatches(), determineCoupledFaces(), autoLayerDriver::doLayers(), dumpCyclicMatch(), extendedCellToCellStencil::extendedCellToCellStencil(), extendedCellToFaceStencil::extendedCellToFaceStencil(), extendedFaceToCellStencil::extendedFaceToCellStencil(), extractSurface(), filterPatches(), coupleGroupIdentifier::findOtherPatchID(), getSelectedPatches(), FaceCellWave< Type, int >::handleCyclicPatches(), FaceCellWave< Type, int >::handleProcPatches(), particle< Type >::hitCyclicAMIPatch(), thermalBaffleModel::init(), regionModel::initialise(), main(), fvPatch::name(), facePointPatch::name(), polyBoundaryMesh::neighbourEdges(), cyclicACMIPolyPatch::nonOverlapPatchID(), boundaryMesh::patchify(), patchInteractionDataList::patchInteractionDataList(), fvMeshDistribute::printMeshInfo(), directions::propagateDirection(), boundaryMesh::read(), globalPoints::receivePatchPoints(), cyclicPeriodicAMIPolyPatch::resetAMI(), regionCoupledBase::resetAMI(), motionSmootherAlgo::scaleMesh(), globalPoints::sendPatchPoints(), cyclicPeriodicAMIPolyPatch::syncTransforms(), processorCyclicPolyPatch::tag(), meshRefinement::testSyncBoundaryFaceList(), PointEdgeWave< Type, TrackingData >::transform(), cyclicPolyPatch::transformGlobalFace(), faceHeatShading::triangulate(), faceShading::triangulate(), triSurfaceTools::triangulate(), triSurfaceTools::triangulateFaceCentre(), medialAxisMeshMover::update(), sampledPatch::update(), domainDecomposition::writeDecomposition(), and boundaryMesh::writeTriSurface().

◆ name() [2/2]

word& name ( )
inline

Return name for modification.

Definition at line 115 of file patchIdentifier.H.

References patchIdentifier::name_.

◆ physicalType() [1/2]

const word& physicalType ( ) const
inline

Return the optional physical type of the patch.

Definition at line 121 of file patchIdentifier.H.

References patchIdentifier::physicalType_.

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

Return the optional physical type of the patch for modification.

Definition at line 127 of file patchIdentifier.H.

References patchIdentifier::physicalType_.

◆ index() [1/2]

label index ( ) const
inline

Return the index of this patch in the boundaryMesh.

Definition at line 133 of file patchIdentifier.H.

References patchIdentifier::index_.

Referenced by ThermoSurfaceFilm< CloudType >::absorbInteraction(), globalPoints::addToSend(), ThermoSurfaceFilm< CloudType >::bounceInteraction(), changeFrontBackPatches(), boundaryMesh::changePatchType(), emptyPolyPatch::clone(), wallPolyPatch::clone(), symmetryPolyPatch::clone(), genericPolyPatch::clone(), symmetryPlanePolyPatch::clone(), cyclicSlipPolyPatch::clone(), nonuniformTransformCyclicPolyPatch::clone(), regionCoupledPolyPatch::clone(), wedgePolyPatch::clone(), regionCoupledWallPolyPatch::clone(), mappedVariableThicknessWallPolyPatch::clone(), cyclicPeriodicAMIPolyPatch::clone(), immersedBoundaryPolyPatch::clone(), mappedPolyPatch::clone(), mappedWallPolyPatch::clone(), processorPolyPatch::clone(), processorCyclicPolyPatch::clone(), cyclicACMIPolyPatch::clone(), oldCyclicPolyPatch::clone(), cyclicAMIPolyPatch::clone(), polyPatch::clone(), cyclicPolyPatch::clone(), meshToMesh::constructFromCuttingPatches(), meshToMesh::constructNoCuttingPatches(), MaxwellianThermal< CloudType >::correct(), MixedDiffuseSpecular< CloudType >::correct(), LocalInteraction< CloudType >::correct(), MultiInteraction< CloudType >::correct(), ThermoSurfaceFilm< CloudType >::drySplashInteraction(), polyDualMesh::dualPatch(), extractSurface(), Foam::findOppositeWedge(), coupleGroupIdentifier::findOtherPatchID(), DSMCParcel::hitWallPatch(), facePointPatch::index(), fvPatch::index(), regionModel::initialise(), main(), boundaryRadiationPropertiesFvPatchField::nbrPatchIndex(), cyclicPolyPatch::owner(), KinematicCloud< CloudType >::patchData(), patchInteractionDataList::patchInteractionDataList(), ParticleErosion< CloudType >::postPatch(), PatchPostProcessing< CloudType >::postPatch(), globalPoints::receivePatchPoints(), ThermoSurfaceFilm< CloudType >::splashInteraction(), polyDualMesh::splitFace(), ThermoSurfaceFilm< CloudType >::transferParcel(), coupledFreestreamFvPatchField< Type >::updateCoeffs(), myMappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), mappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), coupledFixedValueFvPatchField< Type >::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), turbulentBoundaryCoupledFvPatchScalarField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), and ThermoSurfaceFilm< CloudType >::wetSplashInteraction().

◆ index() [2/2]

label& index ( )
inline

Return the index of this patch in the boundaryMesh for modification.

Definition at line 139 of file patchIdentifier.H.

References patchIdentifier::index_.

◆ inGroups() [1/2]

const wordList& inGroups ( ) const
inline

Return the optional groups patch belongs to.

Definition at line 145 of file patchIdentifier.H.

References patchIdentifier::inGroups_.

Referenced by polyBoundaryMesh::setGroup().

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 151 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 token::END_STATEMENT, Foam::nl, and Ostream::writeKeyword().

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

Field Documentation

◆ name_

word name_
private

Name of patch.

Definition at line 62 of file patchIdentifier.H.

Referenced by patchIdentifier::name(), boundaryPatch::operator!=(), boundaryPatch::operator<<(), boundaryPatch::operator=(), and boundaryPatch::operator>>().

◆ index_

label index_
private

Index of patch in boundary.

Definition at line 65 of file patchIdentifier.H.

Referenced by patchIdentifier::index().

◆ physicalType_

word physicalType_
mutableprivate

Optional physical type.

Definition at line 68 of file patchIdentifier.H.

Referenced by patchIdentifier::physicalType().

◆ inGroups_

wordList inGroups_
private

Optional groups patch belongs to.

Definition at line 71 of file patchIdentifier.H.

Referenced by patchIdentifier::inGroups().

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17