Public Member Functions | 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]

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 wordname () const
 Return name. More...
 
wordname ()
 Return name for modification. More...
 
const wordphysicalType () const
 Return the optional physical type of the patch. More...
 
wordphysicalType ()
 Return the optional physical type of the patch for modification. More...
 
label index () const
 Return the index of this patch in the boundaryMesh. More...
 
labelindex ()
 Return the index of this patch in the boundaryMesh for modification. More...
 
const wordListinGroups () const
 Return the optional groups patch belongs to. More...
 
wordListinGroups ()
 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...
 

Friends

Ostreamoperator<< (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 ( 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 ( 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 ( const patchIdentifier p,
const label  index 
)

Construct from geometric patch, resetting the index.

Definition at line 63 of file patchIdentifier.C.

~patchIdentifier ( )
virtual

Destructor.

Definition at line 77 of file patchIdentifier.C.

Member Function Documentation

const word& name ( ) const
inline

Return name.

Definition at line 109 of file patchIdentifier.H.

Referenced by polyTopoChange::addMesh(), fvMeshTools::addPatch(), boundaryMesh::addPatch(), processorCyclicPolyPatch::calcGeometry(), processorPolyPatch::calcGeometry(), wallShearStress::calcShearStress(), boundaryMesh::changeFaces(), boundaryMesh::changePatchType(), hexRef8::checkMesh(), meshRefinement::checkZoneFaces(), decompositionMethod::decompose(), boundaryMesh::deletePatch(), autoLayerDriver::doLayers(), extendedCellToCellStencil::extendedCellToCellStencil(), extendedCellToFaceStencil::extendedCellToFaceStencil(), extendedFaceToCellStencil::extendedFaceToCellStencil(), coupleGroupIdentifier::findOtherPatchID(), particle< Type >::hitCyclicAMIPatch(), meshToMesh::interpolationMethodAMI(), mappedFixedValueFvPatchField< Type >::mapper(), MeshedSurface< Face >::MeshedSurface(), fvPatch::name(), facePointPatch::name(), NamedEnum< Enum, nEnum >::names(), regionModel::nbrCoupledPatchID(), polyBoundaryMesh::neighbourEdges(), cyclicACMIPolyPatch::nonOverlapPatchID(), combineEqOp< Type, TrackingData >::operator()(), boundaryMesh::patchify(), patchInteractionDataList::patchInteractionDataList(), fvMeshDistribute::printCoupleInfo(), fvMeshDistribute::printMeshInfo(), thermalBaffleModel::read(), boundaryMesh::read(), mappedPatchBase::samplePatch(), mappedPatchBase::sampleRegion(), motionSmootherAlgo::scaleMesh(), FaceCellWave< Type, TrackingData >::setFaceInfo(), processorCyclicPolyPatch::tag(), meshRefinement::testSyncBoundaryFaceList(), cyclicPolyPatch::transformGlobalFace(), triSurfaceTools::triangulate(), triSurfaceTools::triangulateFaceCentre(), sampledPatch::update(), and boundaryMesh::writeTriSurface().

Here is the caller graph for this function:

word& name ( )
inline

Return name for modification.

Definition at line 115 of file patchIdentifier.H.

const word& physicalType ( ) const
inline

Return the optional physical type of the patch.

Definition at line 121 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:

word& physicalType ( )
inline

Return the optional physical type of the patch for modification.

Definition at line 127 of file patchIdentifier.H.

label index ( ) const
inline
label& index ( )
inline

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

Definition at line 139 of file patchIdentifier.H.

const wordList& inGroups ( ) const
inline

Return the optional groups patch belongs to.

Definition at line 145 of file patchIdentifier.H.

Referenced by polyBoundaryMesh::setGroup().

Here is the caller graph for this function:

wordList& inGroups ( )
inline

Return the optional groups patch belongs to for modification.

Definition at line 151 of file patchIdentifier.H.

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

Here is the call graph for this function:

bool inGroup ( const word name) const

Test if in group.

Definition at line 83 of file patchIdentifier.C.

References Foam::findIndex().

Referenced by patchIdentifier::inGroups(), and polyBoundaryMesh::setGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

void write ( Ostream os) const

Write patchIdentifier as a dictionary.

Definition at line 89 of file patchIdentifier.C.

References token::END_STATEMENT, Foam::nl, List< T >::size(), and Ostream::writeKeyword().

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

Ostream& operator<< ( Ostream ,
const patchIdentifier  
)
friend

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