Public Member Functions | Protected Attributes | Friends | List of all members
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...
 
label index () const
 Return the index of this patch in the boundaryMesh. 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...
 
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...
 

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

Referenced by patchIdentifier::patchIdentifier().

Here is the caller graph for this function:

◆ 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 patchIdentifier::patchIdentifier(), and dictionary::readIfPresent().

Here is the call graph for this function:

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

const word& name ( ) const
inline

Return name.

Definition at line 112 of file patchIdentifier.H.

References patchIdentifier::name_.

Referenced by polyTopoChange::addMesh(), fvMeshTools::addPatch(), repatchMesh::addPatch(), repatchMesh::changePatchType(), hexRef8::checkMesh(), meshRefinement::checkZoneFaces(), particle::correctAfterNonConformalCyclicTransfer(), domainDecomposition::decompose(), decompositionMethod::decompose(), repatchMesh::deletePatch(), snappyLayerDriver::doLayers(), extendedCellToCellStencil::extendedCellToCellStencil(), extendedCellToFaceStencil::extendedCellToFaceStencil(), extendedFaceToCellStencil::extendedFaceToCellStencil(), coupleGroupIdentifier::findOtherPatchID(), FaceCellWave< Type, TrackingData >::handleCyclicPatches(), FaceCellWave< Type, TrackingData >::handleProcPatches(), particle::hitCyclicAMIPatch(), MomentumParcel< ParcelType >::hitWallPatch(), meshToMesh::mapAndOpTgtToSrc(), mappedFixedValueFvPatchField< Type >::mapper(), MeshedSurface< Foam::face >::MeshedSurface(), fvPatch::name(), facePointPatch::name(), NamedEnum< compressibleField, 8 >::names(), regionModel::nbrCoupledPatchID(), polyBoundaryMesh::nbrEdges(), nonConformalPolyPatch::origPatchID(), patchInteractionDataList::patchInteractionDataList(), Foam::polyMeshUnMergeCyclics(), fvMeshDistribute::printCoupleInfo(), fvMeshDistribute::printMeshInfo(), thermalBaffleModel::read(), repatchMesh::read(), mappedPatchBase::samplePatch(), mappedPatchBase::sampleRegion(), motionSmootherAlgo::scaleMesh(), processorCyclicPolyPatch::tag(), meshRefinement::testSyncBoundaryFaceList(), cyclicPolyPatch::transform(), triSurfaceTools::triangulate(), triSurfaceTools::triangulateFaceCentre(), and patch::update().

Here is the caller graph for this function:

◆ index()

label index ( ) const
inline

Return the index of this patch in the boundaryMesh.

Definition at line 118 of file patchIdentifier.H.

References patchIdentifier::index_.

Referenced by ThermoSurfaceFilm< CloudType >::absorbInteraction(), ThermoSurfaceFilm< CloudType >::bounceInteraction(), semiPermeableBaffleMassFractionFvPatchScalarField::calcPhiYp(), repatchMesh::changePatchType(), LocalInteraction< CloudType >::correct(), ThermoSurfaceFilm< CloudType >::drySplashInteraction(), radiationCoupledBase::emissivity(), particle::hitNonConformalCyclicPatch(), facePointPatch::index(), fvPatch::index(), meshToMesh::mapAndOpTgtToSrc(), cyclicPolyPatch::owner(), MomentumCloud< Foam::DSMCCloud >::patchData(), patchInteractionDataList::patchInteractionDataList(), PatchPostProcessing< CloudType >::postPatch(), PatchCollisionDensity< CloudType >::postPatch(), ParticleErosion< CloudType >::postPatch(), ThermoSurfaceFilm< CloudType >::splashInteraction(), thermalBaffle1DFvPatchScalarField< solidType >::thermalBaffle1DFvPatchScalarField(), ThermoSurfaceFilm< CloudType >::transferParcel(), mappedFixedInternalValueFvPatchField< Type >::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), and ThermoSurfaceFilm< CloudType >::wetSplashInteraction().

Here is the caller graph for this function:

◆ physicalType() [1/2]

const word& physicalType ( ) const
inline

Return the optional physical type of the patch.

Definition at line 124 of file patchIdentifier.H.

References patchIdentifier::physicalType_.

Referenced by repatchMesh::addPatch(), repatchMesh::deletePatch(), and repatchMesh::read().

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 130 of file patchIdentifier.H.

References patchIdentifier::physicalType_.

◆ inGroups() [1/2]

const wordList& inGroups ( ) const
inline

Return the optional groups patch belongs to.

Definition at line 136 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 142 of file patchIdentifier.H.

References patchIdentifier::inGroup(), patchIdentifier::inGroups_, patchIdentifier::operator<<, and patchIdentifier::write().

Here is the call graph for this function:

◆ inGroup()

bool inGroup ( const word &  name) const

Test if in group.

Definition at line 83 of file patchIdentifier.C.

References Foam::findIndex(), and patchIdentifier::inGroups_.

Referenced by patchIdentifier::inGroups(), and 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 patchIdentifier::inGroups_, patchIdentifier::physicalType_, List< T >::size(), and Foam::writeEntry().

Referenced by patchIdentifier::inGroups(), Foam::operator<<(), repatchPatch::write(), genericPolyPatch::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

Referenced by patchIdentifier::inGroups().

Member Data Documentation

◆ name_

word name_
protected

Name of patch.

Definition at line 64 of file patchIdentifier.H.

Referenced by patchIdentifier::name().

◆ index_

label index_
protected

Index of patch in boundary.

Definition at line 67 of file patchIdentifier.H.

Referenced by patchIdentifier::index().

◆ physicalType_

word physicalType_
protected

Optional physical type.

Definition at line 70 of file patchIdentifier.H.

Referenced by patchIdentifier::physicalType(), and patchIdentifier::write().

◆ inGroups_

wordList inGroups_
protected

Optional groups patch belongs to.

Definition at line 73 of file patchIdentifier.H.

Referenced by patchIdentifier::inGroup(), patchIdentifier::inGroups(), and patchIdentifier::write().

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