polyPatch Class Reference

A patch is a list of labels that address the faces in the global face list. More...

Inheritance diagram for polyPatch:
[legend]
Collaboration diagram for polyPatch:
[legend]

Public Member Functions

 TypeName ("patch")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, polyPatch, word,(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType),(name, size, start, index, bm, patchType))
 
 declareRunTimeSelectionTable (autoPtr, polyPatch, dictionary,(const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType),(name, dict, index, bm, patchType))
 
 polyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)
 Construct from components. More...
 
 polyPatch (const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &physicalType, const wordList &inGroups)
 Construct from components. More...
 
 polyPatch (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)
 Construct from dictionary. More...
 
 polyPatch (const polyPatch &, const polyBoundaryMesh &)
 Copy construct, resetting the boundary mesh. More...
 
 polyPatch (const polyPatch &pp, const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart)
 
 polyPatch (const polyPatch &pp, const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart)
 Construct given the original patch and a map. More...
 
 polyPatch (const polyPatch &p)
 Copy construct. More...
 
 polyPatch (const polyPatch &p, const labelList &faceCells)
 Copy construct, setting faceCells. More...
 
virtual autoPtr< polyPatchclone (const labelList &faceCells) const
 Construct and return a clone, setting faceCells. More...
 
virtual autoPtr< polyPatchclone (const polyBoundaryMesh &bm) const
 Construct and return a clone, resetting the boundary mesh. More...
 
virtual autoPtr< polyPatchclone (const polyBoundaryMesh &bm, const label index, const label newSize, const label newStart) const
 
virtual autoPtr< polyPatchclone (const polyBoundaryMesh &bm, const label index, const labelUList &mapAddressing, const label newStart) const
 
virtual ~polyPatch ()
 Destructor. More...
 
virtual void newInternalProcFaces (label &, label &) const
 Return number of new internal of this polyPatch faces. More...
 
virtual const labelUListnbrCells () const
 Return nbrCells. More...
 
virtual label neighbPolyPatchID () const
 Return nbr patchID. More...
 
virtual refPtr< labelListListmapCollocatedFaces () const
 Return mapped collocated faces. More...
 
virtual bool masterImplicit () const
 Return implicit master. More...
 
virtual word neighbRegionID () const
 Return neighbour region name. More...
 
label offset () const
 The offset where this patch starts in the boundary face list. More...
 
label start () const
 Return start label of this patch in the polyMesh face list. More...
 
labelRange range () const
 Return start/size range of this patch. More...
 
const polyBoundaryMeshboundaryMesh () const
 Return boundaryMesh reference. More...
 
virtual bool coupled () const
 Return true if this patch is geometrically coupled (i.e. faces and. More...
 
template<class T >
const UIndirectList< TpatchInternalList (const UList< T > &internalValues) const
 Extract face cell data. More...
 
template<class T >
const List< T >::subList patchSlice (const UList< T > &l) const
 Slice list to patch. More...
 
template<class T >
const Field< T >::subField patchSlice (const Field< T > &l) const
 Slice Field to patch. More...
 
virtual void write (Ostream &os) const
 Write the polyPatch data as a dictionary. More...
 
const vectorField::subField faceCentres () const
 Return face centres. More...
 
const vectorField::subField faceAreas () const
 Return face normals. More...
 
tmp< vectorFieldfaceCellCentres () const
 Return face cell centres. More...
 
tmp< scalarFieldareaFraction () const
 
const labelUListfaceCells () const
 Return face-cell addressing. More...
 
const labelListmeshEdges () const
 Return global edge index for local edges. More...
 
virtual void clearAddressing ()
 Clear addressing. More...
 
label whichFace (const label l) const
 Return label of face in patch from global face label. More...
 
virtual void initOrder (PstreamBuffers &, const primitivePatch &) const
 Initialize ordering for primitivePatch. Does not. More...
 
virtual bool order (PstreamBuffers &, const primitivePatch &, labelList &faceMap, labelList &rotation) const
 Return new ordering for primitivePatch. More...
 
virtual bool changeTopology () const
 
virtual bool setTopology (polyTopoChange &)
 Collect topology changes in a polyTopoChange object. More...
 
void operator= (const polyPatch &)
 Assignment. More...
 
- Public Member Functions inherited from patchIdentifier
 patchIdentifier (const patchIdentifier &)=default
 Copy construct. More...
 
patchIdentifieroperator= (const patchIdentifier &)=default
 Copy assignment. More...
 
virtual ~patchIdentifier ()=default
 Destructor. More...
 
 patchIdentifier ()
 Default construct. Uses 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 index)
 Copy construct, resetting the index. More...
 
const wordname () const noexcept
 The patch name. More...
 
wordname () 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 wordphysicalType () const noexcept
 The (optional) physical type of the patch. More...
 
wordphysicalType () noexcept
 Modifiable (optional) physical type of the patch. More...
 
const wordListinGroups () const noexcept
 The (optional) groups that the patch belongs to. More...
 
wordListinGroups () 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 write (Ostream &os) const
 
- Public Member Functions inherited from PrimitivePatch< FaceList, PointField >
 PrimitivePatch (const FaceList &faces, const PointField &points)
 Construct from components. More...
 
 PrimitivePatch (FaceList &&faces, const PointField &points)
 Construct from components, transferring faces. More...
 
 PrimitivePatch (FaceList &faces, PointField &points, const bool reuse)
 Construct from components, reuse storage. More...
 
 PrimitivePatch (const PrimitivePatch< FaceList, PointField > &pp)
 Copy construct. More...
 
virtual ~PrimitivePatch ()
 Destructor. More...
 
void clearOut ()
 
void clearGeom ()
 
void clearTopology ()
 
void clearPatchMeshAddr ()
 
void swap (PrimitivePatch &)=delete
 Suppress direct swapping, since storage containers may be const. More...
 
const Field< point_type > & points () const noexcept
 Return reference to global points. More...
 
label nFaces () const noexcept
 Number of faces in the patch. More...
 
label nPoints () const
 Number of points supporting patch faces. More...
 
label nEdges () const
 Number of edges in patch. More...
 
const edgeListedges () const
 Return list of edges, address into LOCAL point list. More...
 
const edgeList::subList internalEdges () const
 Return sub-list of internal edges, address into LOCAL point list. More...
 
const edgeList::subList boundaryEdges () const
 Return sub-list of boundary edges, address into LOCAL point list. More...
 
label nInternalEdges () const
 Number of internal edges. More...
 
label nBoundaryEdges () const
 Number of boundary edges == (nEdges() - nInternalEdges()) More...
 
bool isInternalEdge (const label edgei) const
 Is internal edge? More...
 
const labelListboundaryPoints () const
 Return list of boundary points, address into LOCAL point list. More...
 
const labelListListfaceFaces () const
 Return face-face addressing. More...
 
const labelListListedgeFaces () const
 Return edge-face addressing. More...
 
const labelListListfaceEdges () const
 Return face-edge addressing. More...
 
const labelListListpointEdges () const
 Return point-edge addressing. More...
 
const labelListListpointFaces () const
 Return point-face addressing. More...
 
const List< face_type > & localFaces () const
 Return patch faces addressing into local point list. More...
 
labelList boundaryFaces () const
 
labelList uniqBoundaryFaces () const
 
const labelListmeshPoints () const
 Return labelList of mesh points in patch. More...
 
const Map< label > & meshPointMap () const
 Mesh point map. More...
 
const Field< point_type > & localPoints () const
 Return pointField of points in patch. More...
 
const labelListlocalPointOrder () const
 Return orders the local points for most efficient search. More...
 
label whichPoint (const label gp) const
 Given a global point index, return the local point index. More...
 
edge meshEdge (const label edgei) const
 From patch edge to global edge using meshPoints. More...
 
edge meshEdge (const edge &e) const
 From patch edge to global edge using meshPoints. More...
 
label findEdge (const edge &e) const
 
labelList meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
 
labelList meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
 
label meshEdge (const label edgei, const edgeList &allEdges, const labelListList &pointEdges) const
 
labelList meshEdges (const labelUList &edgeLabels, const edgeList &allEdges, const labelListList &pointEdges) const
 
const Field< point_type > & faceCentres () const
 Return face centres for patch. More...
 
const Field< point_type > & faceAreas () const
 Return face area vectors for patch. More...
 
const Field< scalar > & magFaceAreas () const
 Return face area magnitudes for patch. More...
 
const Field< point_type > & faceNormals () const
 Return face unit normals for patch. More...
 
const Field< point_type > & pointNormals () const
 Return point normals for patch. More...
 
bool hasFaceAreas () const
 
bool hasFaceCentres () const
 
bool hasFaceNormals () const
 
bool hasPointNormals () const
 
bool hasBoundaryPoints () const
 
bool hasFaceFaces () const
 
bool hasEdgeFaces () const
 
bool hasFaceEdges () const
 
bool hasPointEdges () const
 
bool hasPointFaces () const
 
bool hasMeshPointMap () const
 
template<class ToPatch >
List< objectHitprojectPoints (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
 Project vertices of patch onto another patch. More...
 
template<class ToPatch >
List< objectHitprojectFaceCentres (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
 Project vertices of patch onto another patch. More...
 
const labelListListedgeLoops () const
 Return list of closed loops of boundary vertices. More...
 
surfaceTopo surfaceType () const
 Calculate surface type formed by patch. More...
 
bool checkTopology (const bool report=false, labelHashSet *setPtr=nullptr) const
 Check surface formed by patch for manifoldness (see above). More...
 
bool checkPointManifold (const bool report=false, labelHashSet *setPtr=nullptr) const
 Checks primitivePatch for faces sharing point but not edge. More...
 
virtual void movePoints (const Field< point_type > &)
 Correct patch after moving points. More...
 
void operator= (const PrimitivePatch< FaceList, PointField > &rhs)
 Copy assign faces. Leave points alone (could be a reference). More...
 
void operator= (PrimitivePatch< FaceList, PointField > &&rhs)
 Move assign faces. Leave points alone (could be a reference). More...
 
label whichEdge (const edge &e) const
 Identical to findEdge. More...
 
template<class ToPatch >
Foam::List< Foam::objectHitprojectPoints (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< FaceList, PointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
 
template<class ToPatch >
Foam::List< Foam::objectHitprojectFaceCentres (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< FaceList, PointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
 
- Public Member Functions inherited from PrimitivePatchBase
 ClassName ("PrimitivePatch")
 Runtime type information. More...
 
 PrimitivePatchBase ()=default
 Default construct. More...
 

Static Public Member Functions

static autoPtr< polyPatchNew (const word &patchType, const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm)
 Return pointer to a new patch created on freestore from components. More...
 
static autoPtr< polyPatchNew (const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm)
 Return pointer to a new patch created on freestore from dictionary. More...
 
static autoPtr< polyPatchNew (const word &patchType, const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm)
 Return pointer to a new patch created on freestore from dictionary. More...
 
static bool constraintType (const word &pt)
 Return true if the given type is a constraint type. More...
 
static wordList constraintTypes ()
 Return a list of all the constraint patch types. More...
 
- Static Public Member Functions inherited from patchIdentifier
static word defaultName (const label n=-1)
 Default patch name: "patch" or "patchN". More...
 

Static Public Attributes

static int disallowGenericPolyPatch
 Debug switch to disallow the use of genericPolyPatch. More...
 

Protected Member Functions

virtual void initGeometry (PstreamBuffers &)
 Initialise the calculation of the patch geometry. More...
 
virtual void calcGeometry (PstreamBuffers &)
 Calculate the patch geometry. More...
 
virtual void initMovePoints (PstreamBuffers &, const pointField &)
 Initialise the patches for moving points. More...
 
virtual void movePoints (PstreamBuffers &, const pointField &p)
 Correct patches after moving points. More...
 
virtual void initUpdateMesh (PstreamBuffers &)
 Initialise the update of the patch topology. More...
 
virtual void updateMesh (PstreamBuffers &)
 Update of the patch topology. More...
 
virtual void clearGeom ()
 Clear geometry. More...
 
virtual void movePoints (const Field< point_type > &)
 Inherit movePoints from primitivePatch. More...
 

Friends

class polyBoundaryMesh
 
Ostreamoperator<< (Ostream &, const polyPatch &)
 

Additional Inherited Members

- Public Types inherited from PrimitivePatch< FaceList, PointField >
enum  surfaceTopo { MANIFOLD, OPEN, ILLEGAL }
 Enumeration defining the surface type. Used in check routines. More...
 
typedef std::remove_reference< FaceList >::type::value_type face_type
 The face type. More...
 
typedef std::remove_reference< PointField >::type::value_type point_type
 The point type. More...
 
typedef FaceList FaceListType
 The face list type. More...
 
typedef PointField PointFieldType
 The point field type. More...
 
typedef face_type FaceType
 Deprecated(2020-03) prefer face_type typedef. More...
 

Detailed Description

A patch is a list of labels that address the faces in the global face list.

The patch can calculate its own edges based on the global faces. Patch also contains all addressing between the faces.

Source files

Definition at line 68 of file polyPatch.H.

Constructor & Destructor Documentation

◆ polyPatch() [1/8]

polyPatch ( const word name,
const label  size,
const label  start,
const label  index,
const polyBoundaryMesh bm,
const word patchType 
)

Construct from components.

Definition at line 83 of file polyPatch.C.

◆ polyPatch() [2/8]

polyPatch ( const word name,
const label  size,
const label  start,
const label  index,
const polyBoundaryMesh bm,
const word physicalType,
const wordList inGroups 
)

Construct from components.

Definition at line 111 of file polyPatch.C.

◆ polyPatch() [3/8]

polyPatch ( const word name,
const dictionary dict,
const label  index,
const polyBoundaryMesh bm,
const word patchType 
)

Construct from dictionary.

Definition at line 135 of file polyPatch.C.

References List< T >::appendUniq().

Here is the call graph for this function:

◆ polyPatch() [4/8]

polyPatch ( const polyPatch pp,
const polyBoundaryMesh bm 
)

Copy construct, resetting the boundary mesh.

Definition at line 167 of file polyPatch.C.

◆ polyPatch() [5/8]

polyPatch ( const polyPatch pp,
const polyBoundaryMesh bm,
const label  index,
const label  newSize,
const label  newStart 
)

Construct given the original patch and resetting the face list and boundary mesh information

Definition at line 191 of file polyPatch.C.

◆ polyPatch() [6/8]

polyPatch ( const polyPatch pp,
const polyBoundaryMesh bm,
const label  index,
const labelUList mapAddressing,
const label  newStart 
)

Construct given the original patch and a map.

Definition at line 218 of file polyPatch.C.

◆ polyPatch() [7/8]

polyPatch ( const polyPatch p)

Copy construct.

Definition at line 244 of file polyPatch.C.

◆ polyPatch() [8/8]

polyPatch ( const polyPatch p,
const labelList faceCells 
)

Copy construct, setting faceCells.

Note
The faceCells are held by the caller

Definition at line 256 of file polyPatch.C.

◆ ~polyPatch()

~polyPatch ( )
virtual

Destructor.

Definition at line 269 of file polyPatch.C.

Member Function Documentation

◆ initGeometry()

virtual void initGeometry ( PstreamBuffers )
inlineprotectedvirtual

Initialise the calculation of the patch geometry.

Reimplemented in coupledPolyPatch, cyclicAMIPolyPatch, cyclicACMIPolyPatch, oldCyclicPolyPatch, cyclicPolyPatch, processorPolyPatch, processorCyclicPolyPatch, mappedPolyPatch, and mappedWallPolyPatch.

Definition at line 99 of file polyPatch.H.

Referenced by mappedPolyPatch::initGeometry(), mappedWallPolyPatch::initGeometry(), cyclicPolyPatch::initGeometry(), oldCyclicPolyPatch::initGeometry(), and cyclicAMIPolyPatch::initGeometry().

Here is the caller graph for this function:

◆ calcGeometry()

virtual void calcGeometry ( PstreamBuffers )
inlineprotectedvirtual

Calculate the patch geometry.

Reimplemented in coupledPolyPatch, cyclicAMIPolyPatch, cyclicACMIPolyPatch, cyclicPolyPatch, oldCyclicPolyPatch, processorPolyPatch, wedgePolyPatch, processorCyclicPolyPatch, mappedPolyPatch, mappedWallPolyPatch, and symmetryPlanePolyPatch.

Definition at line 103 of file polyPatch.H.

Referenced by mappedPolyPatch::calcGeometry(), and mappedWallPolyPatch::calcGeometry().

Here is the caller graph for this function:

◆ initMovePoints()

virtual void initMovePoints ( PstreamBuffers ,
const pointField  
)
inlineprotectedvirtual

Initialise the patches for moving points.

Reimplemented in cyclicAMIPolyPatch, cyclicACMIPolyPatch, coupledPolyPatch, cyclicPolyPatch, oldCyclicPolyPatch, processorPolyPatch, processorCyclicPolyPatch, mappedPolyPatch, and mappedWallPolyPatch.

Definition at line 107 of file polyPatch.H.

Referenced by mappedPolyPatch::initMovePoints(), mappedWallPolyPatch::initMovePoints(), oldCyclicPolyPatch::initMovePoints(), and cyclicPolyPatch::initMovePoints().

Here is the caller graph for this function:

◆ movePoints() [1/2]

void movePoints ( PstreamBuffers ,
const pointField p 
)
protectedvirtual

Correct patches after moving points.

Reimplemented in cyclicAMIPolyPatch, cyclicACMIPolyPatch, coupledPolyPatch, cyclicPolyPatch, oldCyclicPolyPatch, processorPolyPatch, processorCyclicPolyPatch, mappedPolyPatch, and mappedWallPolyPatch.

Definition at line 61 of file polyPatch.C.

References PrimitivePatch< FaceList, PointField >::movePoints(), and p.

Referenced by processorPolyPatch::initMovePoints(), mappedWallPolyPatch::movePoints(), mappedPolyPatch::movePoints(), oldCyclicPolyPatch::movePoints(), and cyclicPolyPatch::movePoints().

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

◆ initUpdateMesh()

virtual void initUpdateMesh ( PstreamBuffers )
inlineprotectedvirtual

Initialise the update of the patch topology.

Reimplemented in coupledPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, cyclicACMIPolyPatch, oldCyclicPolyPatch, processorPolyPatch, processorCyclicPolyPatch, mappedPolyPatch, and mappedWallPolyPatch.

Definition at line 114 of file polyPatch.H.

Referenced by mappedPolyPatch::initUpdateMesh(), mappedWallPolyPatch::initUpdateMesh(), processorPolyPatch::initUpdateMesh(), oldCyclicPolyPatch::initUpdateMesh(), cyclicPolyPatch::initUpdateMesh(), and cyclicAMIPolyPatch::initUpdateMesh().

Here is the caller graph for this function:

◆ updateMesh()

void updateMesh ( PstreamBuffers )
protectedvirtual

Update of the patch topology.

Reimplemented in coupledPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, cyclicACMIPolyPatch, oldCyclicPolyPatch, processorPolyPatch, processorCyclicPolyPatch, mappedPolyPatch, and mappedWallPolyPatch.

Definition at line 67 of file polyPatch.C.

References PrimitivePatch< FaceList, PointField >::clearGeom().

Referenced by mappedPolyPatch::updateMesh(), mappedWallPolyPatch::updateMesh(), processorPolyPatch::updateMesh(), oldCyclicPolyPatch::updateMesh(), cyclicPolyPatch::updateMesh(), and cyclicAMIPolyPatch::updateMesh().

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

◆ clearGeom()

void clearGeom ( )
protectedvirtual

Clear geometry.

Reimplemented in cyclicAMIPolyPatch, and cyclicACMIPolyPatch.

Definition at line 74 of file polyPatch.C.

References PrimitivePatch< FaceList, PointField >::clearGeom().

Referenced by cyclicAMIPolyPatch::clearGeom().

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

◆ TypeName()

TypeName ( "patch"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable ( autoPtr  ,
polyPatch  ,
word  ,
(const word &name, const label size, const label start, const label index, const polyBoundaryMesh &bm, const word &patchType)  ,
(name, size, start, index, bm, patchType)   
)

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable ( autoPtr  ,
polyPatch  ,
dictionary  ,
(const word &name, const dictionary &dict, const label index, const polyBoundaryMesh &bm, const word &patchType)  ,
(name, dict, index, bm, patchType)   
)

◆ clone() [1/4]

virtual autoPtr<polyPatch> clone ( const labelList faceCells) const
inlinevirtual

Construct and return a clone, setting faceCells.

Note
The faceCells are held by the caller

Definition at line 235 of file polyPatch.H.

Referenced by boundaryMesh::patchify().

Here is the caller graph for this function:

◆ clone() [2/4]

virtual autoPtr<polyPatch> clone ( const polyBoundaryMesh bm) const
inlinevirtual

Construct and return a clone, resetting the boundary mesh.

Reimplemented in cyclicAMIPolyPatch, cyclicPolyPatch, cyclicACMIPolyPatch, oldCyclicPolyPatch, processorPolyPatch, processorCyclicPolyPatch, mappedPolyPatch, mappedWallPolyPatch, mappedVariableThicknessWallPolyPatch, cyclicPeriodicAMIPolyPatch, wedgePolyPatch, cyclicSlipPolyPatch, nonuniformTransformCyclicPolyPatch, symmetryPlanePolyPatch, genericPolyPatch, oversetPolyPatch, symmetryPolyPatch, emptyPolyPatch, and wallPolyPatch.

Definition at line 241 of file polyPatch.H.

References autoPtr< T >::New().

Here is the call graph for this function:

◆ clone() [3/4]

virtual autoPtr<polyPatch> clone ( const polyBoundaryMesh bm,
const label  index,
const label  newSize,
const label  newStart 
) const
inlinevirtual

Construct and return a clone, resetting the face list and boundary mesh

Reimplemented in cyclicAMIPolyPatch, cyclicPolyPatch, cyclicACMIPolyPatch, oldCyclicPolyPatch, processorPolyPatch, processorCyclicPolyPatch, mappedPolyPatch, mappedWallPolyPatch, mappedVariableThicknessWallPolyPatch, cyclicPeriodicAMIPolyPatch, wedgePolyPatch, nonuniformTransformCyclicPolyPatch, cyclicSlipPolyPatch, symmetryPlanePolyPatch, genericPolyPatch, oversetPolyPatch, symmetryPolyPatch, emptyPolyPatch, and wallPolyPatch.

Definition at line 249 of file polyPatch.H.

References patchIdentifier::index(), and autoPtr< T >::New().

Here is the call graph for this function:

◆ clone() [4/4]

virtual autoPtr<polyPatch> clone ( const polyBoundaryMesh bm,
const label  index,
const labelUList mapAddressing,
const label  newStart 
) const
inlinevirtual

Construct and return a clone, resetting the face list and boundary mesh

Reimplemented in cyclicAMIPolyPatch, cyclicPolyPatch, cyclicACMIPolyPatch, processorCyclicPolyPatch, processorPolyPatch, mappedWallPolyPatch, mappedPolyPatch, mappedVariableThicknessWallPolyPatch, cyclicPeriodicAMIPolyPatch, nonuniformTransformCyclicPolyPatch, cyclicSlipPolyPatch, wedgePolyPatch, symmetryPlanePolyPatch, genericPolyPatch, oversetPolyPatch, symmetryPolyPatch, emptyPolyPatch, and wallPolyPatch.

Definition at line 262 of file polyPatch.H.

References patchIdentifier::index(), and autoPtr< T >::New().

Here is the call graph for this function:

◆ New() [1/3]

Foam::autoPtr< Foam::polyPatch > New ( const word patchType,
const word name,
const label  size,
const label  start,
const label  index,
const polyBoundaryMesh bm 
)
static

Return pointer to a new patch created on freestore from components.

Definition at line 35 of file polyPatchNew.C.

References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, and Foam::name().

Referenced by columnFvMeshInfo::addLocalPatches(), meshRefinement::appendPatch(), extrudePatchMesh::extrudePatchMesh(), PDRblock::innerMesh(), fvMeshTools::newMesh(), boundaryMesh::patchify(), polyBoundaryMesh::polyBoundaryMesh(), and polyMesh::polyMesh().

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

◆ New() [2/3]

Foam::autoPtr< Foam::polyPatch > New ( const word name,
const dictionary dict,
const label  index,
const polyBoundaryMesh bm 
)
static

Return pointer to a new patch created on freestore from dictionary.

Definition at line 74 of file polyPatchNew.C.

References DebugInFunction, dict, Foam::endl(), Foam::name(), and Foam::New().

Here is the call graph for this function:

◆ New() [3/3]

Foam::autoPtr< Foam::polyPatch > New ( const word patchType,
const word name,
const dictionary dict,
const label  index,
const polyBoundaryMesh bm 
)
static

Return pointer to a new patch created on freestore from dictionary.

Definition at line 91 of file polyPatchNew.C.

References DebugInFunction, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::name().

Here is the call graph for this function:

◆ newInternalProcFaces()

virtual void newInternalProcFaces ( label &  ,
label &   
) const
inlinevirtual

Return number of new internal of this polyPatch faces.

Reimplemented in cyclicPolyPatch, mappedWallPolyPatch, mappedPolyPatch, cyclicAMIPolyPatch, and cyclicACMIPolyPatch.

Definition at line 316 of file polyPatch.H.

References NotImplemented.

Referenced by lduPrimitiveMeshAssembly::update().

Here is the caller graph for this function:

◆ nbrCells()

virtual const labelUList& nbrCells ( ) const
inlinevirtual

Return nbrCells.

Reimplemented in cyclicAMIPolyPatch, cyclicPolyPatch, mappedWallPolyPatch, and mappedPolyPatch.

Definition at line 322 of file polyPatch.H.

References NotImplemented, and UList< T >::null().

Referenced by lduPrimitiveMeshAssembly::update().

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

◆ neighbPolyPatchID()

virtual label neighbPolyPatchID ( ) const
inlinevirtual

Return nbr patchID.

Reimplemented in cyclicAMIPolyPatch, cyclicPolyPatch, mappedWallPolyPatch, and mappedPolyPatch.

Definition at line 329 of file polyPatch.H.

References NotImplemented.

Referenced by fvMatrix< Type >::mapContributions(), and lduPrimitiveMeshAssembly::update().

Here is the caller graph for this function:

◆ mapCollocatedFaces()

virtual refPtr<labelListList> mapCollocatedFaces ( ) const
inlinevirtual

Return mapped collocated faces.

Reimplemented in cyclicAMIPolyPatch, cyclicPolyPatch, cyclicACMIPolyPatch, mappedWallPolyPatch, and mappedPolyPatch.

Definition at line 336 of file polyPatch.H.

References NotImplemented.

Referenced by lduPrimitiveMeshAssembly::update().

Here is the caller graph for this function:

◆ masterImplicit()

virtual bool masterImplicit ( ) const
inlinevirtual

Return implicit master.

Reimplemented in cyclicAMIPolyPatch, cyclicPolyPatch, mappedWallPolyPatch, and mappedPolyPatch.

Definition at line 343 of file polyPatch.H.

References NotImplemented.

Referenced by assemblyFaceAreaPairGAMGAgglomeration::assemblyFaceAreaPairGAMGAgglomeration(), fvMatrix< Type >::mapContributions(), and lduPrimitiveMeshAssembly::update().

Here is the caller graph for this function:

◆ neighbRegionID()

virtual word neighbRegionID ( ) const
inlinevirtual

Return neighbour region name.

Reimplemented in mappedWallPolyPatch, and mappedPolyPatch.

Definition at line 350 of file polyPatch.H.

Referenced by lduPrimitiveMeshAssembly::findNbrMeshId().

Here is the caller graph for this function:

◆ offset()

Foam::label offset ( ) const

The offset where this patch starts in the boundary face list.

The value is the same as patch.start() - mesh.nInternalFaces()

Definition at line 309 of file polyPatch.C.

Referenced by preservePatches::apply(), cyclicPolyPatch::transformGlobalFace(), and Foam::ensightOutput::writeVolField().

Here is the caller graph for this function:

◆ start()

label start ( ) const
inline

Return start label of this patch in the polyMesh face list.

Definition at line 361 of file polyPatch.H.

Referenced by preservePatches::add(), polyMeshAdder::add(), cyclicAMIPolyPatch::addAMIFaces(), polyTopoChange::addMesh(), fvMeshTools::addPatch(), meshRefinement::addPatch(), cellToFaceStencil::allCoupledFacesPatch(), cellToFaceStencil::calcFaceStencil(), polyDualMesh::calcFeatures(), FaceCellWave< Type, TrackingData >::checkCyclic(), hexRef8::checkMesh(), particle< Type >::correctAfterParallelTransfer(), globalMeshData::coupledPatch(), meshRefinement::createBaffles(), structuredDecomp::decompose(), Bezier::dndbBasedSensitivities(), NURBS3DVolume::dndbBasedSensitivities(), faceCoupleInfo::faceLabels(), polyMeshTools::faceOrthogonality(), mappedPatchBase::facePoints(), polyMeshTools::faceSkewness(), polyMeshTools::faceWeights(), patchProbes::findElements(), externalDisplacementMeshMover::getPatch(), particle< Type >::hitCyclicACMIPatch(), particle< Type >::hitCyclicAMIPatch(), fluxSummary::initialiseCellZoneAndDirection(), isoSurfacePoint::isoSurfacePoint(), meshRefinement::makePatch(), combine< Type, TrackingData >::operator()(), polyMeshAdder::patchFacePairs(), boundaryMesh::patchify(), PatchCollisionDensity< CloudType >::postPatch(), fvMeshDistribute::printMeshInfo(), boundaryMesh::read(), cyclicAMIPolyPatch::removeAMIFaces(), structuredRenumber::renumber(), snappySnapDriver::repatchToSurface(), sampledPatchInternalField::sampleOnPoints(), sampledPatch::sampleOnPoints(), sampledFaceZone::sampleOnPoints(), fvMeshSubset::setCellSubset(), rotorDiskSource::setFaceArea(), lumpedPointMovement::setPatchControl(), removeFaces::setRefinement(), fvPatch::start(), syncTools::syncBoundaryFaceList(), syncTools::syncFaceList(), meshRefinement::testSyncBoundaryFaceList(), cyclicPolyPatch::transformGlobalFace(), sampledPatch::update(), cellToFaceStencil::validBoundaryFaces(), polyMeshTools::volRatio(), wallLayerCells::wallLayerCells(), regionSizeDistribution::write(), and meshRefinement::zonify().

◆ range()

labelRange range ( ) const
inline

Return start/size range of this patch.

Definition at line 367 of file polyPatch.H.

Referenced by mappedPatchBase::findLocalSamples(), labelRangeOp< polyPatch >::operator()(), and perfectInterface::setRefinement().

Here is the caller graph for this function:

◆ boundaryMesh()

◆ coupled()

◆ constraintType()

bool constraintType ( const word pt)
static

Return true if the given type is a constraint type.

Definition at line 277 of file polyPatch.C.

References found.

Referenced by Foam::evaluateConstraintTypes(), surfaceDistance::execute(), KinematicParcel< ParcelType >::hitPatch(), meshRefinement::meshedPatches(), and Foam::reusable().

Here is the caller graph for this function:

◆ constraintTypes()

Foam::wordList constraintTypes ( )
static

Return a list of all the constraint patch types.

Definition at line 287 of file polyPatch.C.

References forAllConstIters().

Here is the call graph for this function:

◆ patchInternalList()

const UIndirectList<T> patchInternalList ( const UList< T > &  internalValues) const
inline

Extract face cell data.

Definition at line 391 of file polyPatch.H.

References polyPatch::faceCells().

Here is the call graph for this function:

◆ patchSlice() [1/2]

const List<T>::subList patchSlice ( const UList< T > &  l) const
inline

Slice list to patch.

Definition at line 400 of file polyPatch.H.

Referenced by isoSurfacePoint::isoSurfacePoint().

Here is the caller graph for this function:

◆ patchSlice() [2/2]

const Field<T>::subField patchSlice ( const Field< T > &  l) const
inline

Slice Field to patch.

Definition at line 407 of file polyPatch.H.

◆ write()

void write ( Ostream os) const
virtual

Write the polyPatch data as a dictionary.

Reimplemented in coupledPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, processorCyclicPolyPatch, processorPolyPatch, cyclicACMIPolyPatch, oldCyclicPolyPatch, mappedWallPolyPatch, mappedPolyPatch, mappedVariableThicknessWallPolyPatch, cyclicPeriodicAMIPolyPatch, and genericPolyPatch.

Definition at line 413 of file polyPatch.C.

References os(), Foam::type(), patchIdentifier::write(), and Ostream::writeEntry().

Referenced by mappedPolyPatch::write(), mappedWallPolyPatch::write(), and coupledPolyPatch::write().

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

◆ faceCentres()

const Foam::vectorField::subField faceCentres ( ) const

◆ faceAreas()

const Foam::vectorField::subField faceAreas ( ) const

Return face normals.

Definition at line 327 of file polyPatch.C.

References mesh.

Referenced by DSMCParcel< ParcelType >::hitWallPatch(), regionModel1D::moveMesh(), cyclicAMIFvPatch::movePoints(), cyclicACMIPolyPatch::nonOverlapPatchID(), cyclicACMIFvPatch::resetPatchAreas(), cyclicAMIPolyPatch::restoreScaledGeometry(), cyclicACMIPolyPatch::scalePatchFaceAreas(), cyclicAMIPolyPatch::setAMIFaces(), and dynamicMotionSolverFvMeshAMI::update().

Here is the caller graph for this function:

◆ faceCellCentres()

Foam::tmp< Foam::vectorField > faceCellCentres ( ) const

Return face cell centres.

Definition at line 333 of file polyPatch.C.

References forAll, and tmp< T >::ref().

Here is the call graph for this function:

◆ areaFraction()

Foam::tmp< Foam::scalarField > areaFraction ( ) const

Return the area fraction as the ratio of the stored face area and the area given by the face points

Definition at line 352 of file polyPatch.C.

References forAll, face::mag(), Foam::mag(), points, and tmp< T >::ref().

Here is the call graph for this function:

◆ faceCells()

◆ meshEdges()

const Foam::labelList & meshEdges ( ) const

Return global edge index for local edges.

Definition at line 385 of file polyPatch.C.

References mesh, and PrimitivePatch< FaceList, PointField >::meshEdges().

Here is the call graph for this function:

◆ clearAddressing()

void clearAddressing ( )
virtual

Clear addressing.

Definition at line 404 of file polyPatch.C.

References PrimitivePatch< FaceList, PointField >::clearPatchMeshAddr(), PrimitivePatch< FaceList, PointField >::clearTopology(), and Foam::deleteDemandDrivenData().

Here is the call graph for this function:

◆ whichFace()

◆ initOrder()

void initOrder ( PstreamBuffers ,
const primitivePatch  
) const
virtual

Initialize ordering for primitivePatch. Does not.

refer to *this (except for name() and type() etc.)

Reimplemented in coupledPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, processorCyclicPolyPatch, cyclicACMIPolyPatch, processorPolyPatch, and oldCyclicPolyPatch.

Definition at line 422 of file polyPatch.C.

◆ order()

bool order ( PstreamBuffers ,
const primitivePatch ,
labelList faceMap,
labelList rotation 
) const
virtual

Return new ordering for primitivePatch.

Ordering is -faceMap: for every face index of the new face -rotation:for every new face the clockwise shift of the original face. Return false if nothing changes (faceMap is identity, rotation is 0), true otherwise.

Reimplemented in coupledPolyPatch, cyclicAMIPolyPatch, cyclicPolyPatch, processorCyclicPolyPatch, processorPolyPatch, cyclicACMIPolyPatch, and oldCyclicPolyPatch.

Definition at line 427 of file polyPatch.C.

◆ changeTopology()

virtual bool changeTopology ( ) const
inlinevirtual

For dynamic mesh cases - return true if this patch will change the topology

Reimplemented in cyclicAMIPolyPatch.

Definition at line 473 of file polyPatch.H.

Referenced by dynamicMotionSolverFvMeshAMI::update().

Here is the caller graph for this function:

◆ setTopology()

virtual bool setTopology ( polyTopoChange )
inlinevirtual

Collect topology changes in a polyTopoChange object.

Reimplemented in cyclicAMIPolyPatch.

Definition at line 479 of file polyPatch.H.

◆ operator=()

void operator= ( const polyPatch p)

Assignment.

Definition at line 441 of file polyPatch.C.

References patchIdentifier::operator=(), PrimitivePatch< FaceList, PointField >::operator=(), and p.

Here is the call graph for this function:

◆ movePoints() [2/2]

void movePoints
protected

Inherit movePoints from primitivePatch.

Definition at line 171 of file PrimitivePatch.C.

Friends And Related Function Documentation

◆ polyBoundaryMesh

friend class polyBoundaryMesh
friend

Definition at line 96 of file polyPatch.H.

◆ operator<<

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

Member Data Documentation

◆ disallowGenericPolyPatch

int disallowGenericPolyPatch
static

Debug switch to disallow the use of genericPolyPatch.

Definition at line 130 of file polyPatch.H.


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