PatchTools Class Reference

A collection of tools for searching, sorting PrimitivePatch information. More...

Public Member Functions

template<class FaceList , class PointField >
Foam::labelList edgeOwner (const PrimitivePatch< FaceList, PointField > &p)
 
template<class FaceList , class PointField >
Foam::tmp< Foam::pointFieldpointNormals (const polyMesh &mesh, const PrimitivePatch< FaceList, PointField > &p, const bitSet &pFlip)
 
template<class FaceList , class PointField >
Foam::tmp< Foam::pointFieldedgeNormals (const polyMesh &mesh, const PrimitivePatch< FaceList, PointField > &p, const labelList &patchEdges, const labelList &coupledEdges, const bitSet &pFlip)
 
template<class BoolListType , class FaceList , class PointField >
Foam::label markZones (const PrimitivePatch< FaceList, PointField > &p, const BoolListType &borderEdge, labelList &faceZone)
 
template<class FaceList , class PointField >
Foam::labelListList sortedEdgeFaces (const PrimitivePatch< FaceList, PointField > &p)
 
template<class FaceList , class PointField >
Foam::labelListList sortedPointEdges (const PrimitivePatch< FaceList, PointField > &p)
 

Static Public Member Functions

template<class FaceList , class PointField >
static bool checkOrientation (const PrimitivePatch< FaceList, PointField > &, const bool report=false, labelHashSet *marked=0)
 Check for orientation issues. More...
 
template<class BoolListType , class FaceList , class PointField >
static void markZone (const PrimitivePatch< FaceList, PointField > &, const BoolListType &borderEdge, const label facei, const label currentZone, labelList &faceZone)
 Fill faceZone with currentZone for every face reachable. More...
 
template<class BoolListType , class FaceList , class PointField >
static label markZones (const PrimitivePatch< FaceList, PointField > &, const BoolListType &borderEdge, labelList &faceZone)
 Size and fills faceZone with zone of face. More...
 
template<class BoolListType , class FaceList , class PointField >
static void subsetMap (const PrimitivePatch< FaceList, PointField > &p, const BoolListType &includeFaces, labelList &pointMap, labelList &faceMap)
 Determine the mapping for a sub-patch. More...
 
template<class FaceList , class PointField >
static void calcBounds (const PrimitivePatch< FaceList, PointField > &p, boundBox &bb, label &nPoints)
 
template<class FaceList , class PointField >
static labelListList sortedEdgeFaces (const PrimitivePatch< FaceList, PointField > &)
 Return edge-face addressing sorted by angle around the edge. More...
 
template<class FaceList , class PointField >
static labelListList sortedPointEdges (const PrimitivePatch< FaceList, PointField > &)
 Return point-edge addressing sorted by order around the point. More...
 
template<class FaceList , class PointField >
static labelList edgeOwner (const PrimitivePatch< FaceList, PointField > &)
 If 2 face neighbours: label of face where ordering of edge. More...
 
template<class FaceList1 , class PointField1 , class FaceList2 , class PointField2 >
static void matchPoints (const PrimitivePatch< FaceList1, PointField1 > &p1, const PrimitivePatch< FaceList2, PointField2 > &p2, labelList &p1PointLabels, labelList &p2PointLabels)
 Find corresponding points on patches sharing the same points. More...
 
template<class FaceList1 , class PointField1 , class FaceList2 , class PointField2 >
static void matchEdges (const PrimitivePatch< FaceList1, PointField1 > &p1, const PrimitivePatch< FaceList2, PointField2 > &p2, labelList &p1EdgeLabels, labelList &p2EdgeLabels, bitSet &sameOrientation)
 Find corresponding edges on patches sharing the same points. More...
 
template<class FaceList , class PointField >
static tmp< pointFieldpointNormals (const polyMesh &, const PrimitivePatch< FaceList, PointField > &, const bitSet &flipMap=bitSet::null())
 Return parallel consistent point normals for patches using mesh points. More...
 
template<class FaceList , class PointField >
static tmp< pointFieldedgeNormals (const polyMesh &, const PrimitivePatch< FaceList, PointField > &, const labelList &patchEdges, const labelList &coupledEdges, const bitSet &flipMap=bitSet::null())
 Return parallel consistent edge normals for patches using mesh points. More...
 
template<class FaceList , class PointField >
static void gatherAndMerge (const scalar mergeDist, const PrimitivePatch< FaceList, PointField > &pp, Field< typename PrimitivePatch< FaceList, PointField >::point_type > &mergedPoints, List< typename PrimitivePatch< FaceList, PointField >::face_type > &mergedFaces, labelList &pointMergeMap, const bool useLocal=false)
 Gather points and faces onto master and merge into single patch. More...
 
template<class FaceList >
static void gatherAndMerge (const polyMesh &mesh, const FaceList &faces, const labelList &meshPoints, const Map< label > &meshPointMap, labelList &pointToGlobal, labelList &uniqueMeshPointLabels, autoPtr< globalIndex > &globalPoints, autoPtr< globalIndex > &globalFaces, List< typename FaceList::value_type > &mergedFaces, pointField &mergedPoints)
 Gather (mesh!) points and faces onto master and merge collocated. More...
 

Detailed Description

A collection of tools for searching, sorting PrimitivePatch information.

The class could also be extended to include more that just static methods.

Source files

Definition at line 68 of file PatchTools.H.

Member Function Documentation

◆ checkOrientation()

bool checkOrientation ( const PrimitivePatch< FaceList, PointField > &  p,
const bool  report = false,
labelHashSet marked = 0 
)
static

Check for orientation issues.

Returns true if problems were found. If a normal flips across an edge, places it in the HashSet

Compute normal from 3 points, use the first as the origin

minor warpage should not be a problem

Definition at line 35 of file PatchToolsCheck.C.

References e, UList< T >::end(), Foam::endl(), f(), forAll, Foam::Info, HashSet< Key, Hash >::insert(), UList< T >::last(), Foam::nl, p, p0, and UList< T >::size().

Referenced by searchableSurfaces::checkNormalOrientation().

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

◆ markZone()

void markZone ( const PrimitivePatch< FaceList, PointField > &  p,
const BoolListType &  borderEdge,
const label  facei,
const label  currentZone,
labelList faceZone 
)
static

Fill faceZone with currentZone for every face reachable.

from facei without crossing edge marked in borderEdge. Note: faceZone has to be sized nFaces before calling.

Definition at line 39 of file PatchToolsSearch.C.

References Foam::abort(), DynamicList< T, SizeMin >::append(), UList< T >::empty(), Foam::FatalError, FatalErrorInFunction, forAll, p, UList< T >::size(), and List< T >::transfer().

Here is the call graph for this function:

◆ markZones() [1/2]

static label markZones ( const PrimitivePatch< FaceList, PointField > &  ,
const BoolListType &  borderEdge,
labelList faceZone 
)
static

Size and fills faceZone with zone of face.

Zone is area reachable by edge crossing without crossing borderEdge. Returns number of zones.

Referenced by searchableSurfaces::checkNormalOrientation().

Here is the caller graph for this function:

◆ subsetMap()

void subsetMap ( const PrimitivePatch< FaceList, PointField > &  p,
const BoolListType &  includeFaces,
labelList pointMap,
labelList faceMap 
)
static

Determine the mapping for a sub-patch.

Only include faces for which bool-list entry is true.

Parameters
[in]ppatch to be searched on
[in]includeFacesfaces to include
[out]pointMapmapping new to old localPoints
[out]faceMapmapping new to old faces

Definition at line 141 of file PatchToolsSearch.C.

References List< T >::clear(), Foam::faceMap(), forAll, p, bitSet::set(), and bitSet::sortedToc().

Referenced by MeshedSurface< Face >::subsetMeshMap(), triSurface::subsetMeshMap(), and UnsortedMeshedSurface< Face >::subsetMeshMap().

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

◆ calcBounds()

void calcBounds ( const PrimitivePatch< FaceList, PointField > &  p,
boundBox bb,
label &  nPoints 
)
static

Definition at line 177 of file PatchToolsSearch.C.

References boundBox::add(), PatchTools::calcBounds(), f(), boundBox::invertedBox, nPoints, p, points, bitSet::set(), and UList< T >::size().

Referenced by PatchTools::calcBounds().

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

◆ sortedEdgeFaces() [1/2]

static labelListList sortedEdgeFaces ( const PrimitivePatch< FaceList, PointField > &  )
static

Return edge-face addressing sorted by angle around the edge.

Orientation is anticlockwise looking from edge.vec(localPoints())

Referenced by PatchTools::sortedEdgeFaces().

Here is the caller graph for this function:

◆ sortedPointEdges() [1/2]

static labelListList sortedPointEdges ( const PrimitivePatch< FaceList, PointField > &  )
static

Return point-edge addressing sorted by order around the point.

Referenced by PatchTools::sortedPointEdges(), and extendedEdgeMesh::sortPointsAndEdges().

Here is the caller graph for this function:

◆ edgeOwner() [1/2]

static labelList edgeOwner ( const PrimitivePatch< FaceList, PointField > &  )
static

If 2 face neighbours: label of face where ordering of edge.

is consistent with righthand walk. If 1 neighbour: label of only face. If >2 neighbours: undetermined.

Referenced by PatchTools::edgeOwner().

Here is the caller graph for this function:

◆ matchPoints()

void matchPoints ( const PrimitivePatch< FaceList1, PointField1 > &  p1,
const PrimitivePatch< FaceList2, PointField2 > &  p2,
labelList p1PointLabels,
labelList p2PointLabels 
)
static

Find corresponding points on patches sharing the same points.

p1PointLabels : points on p1 that were matched p2PointLabels : corresponding points on p2

Definition at line 38 of file PatchToolsMatch.C.

References HashTable< T, Key, Hash >::cfind(), forAll, PrimitivePatch< FaceList, PointField >::meshPointMap(), PrimitivePatch< FaceList, PointField >::meshPoints(), PrimitivePatch< FaceList, PointField >::nPoints(), and List< T >::resize().

Here is the call graph for this function:

◆ matchEdges()

void matchEdges ( const PrimitivePatch< FaceList1, PointField1 > &  p1,
const PrimitivePatch< FaceList2, PointField2 > &  p2,
labelList p1EdgeLabels,
labelList p2EdgeLabels,
bitSet sameOrientation 
)
static

Find corresponding edges on patches sharing the same points.

p1EdgeLabels : edges on p1 that were matched p2EdgeLabels : corresponding edges on p2 sameOrientation : same orientation?

Definition at line 76 of file PatchToolsMatch.C.

References HashTable< T, Key, Hash >::cfind(), PrimitivePatch< FaceList, PointField >::edges(), forAll, HashTable< T, Key, Hash >::insert(), PrimitivePatch< FaceList, PointField >::meshEdge(), PrimitivePatch< FaceList, PointField >::nEdges(), List< T >::resize(), PackedList< Width >::resize(), and bitSet::set().

Referenced by addPatchCellLayer::calcExtrudeInfo(), createShellMesh::calcPointRegions(), meshRefinement::countEdgeFaces(), and PatchEdgeFaceWave< PrimitivePatchType, Type, TrackingData >::PatchEdgeFaceWave().

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

◆ pointNormals() [1/2]

static tmp< pointField > pointNormals ( const polyMesh ,
const PrimitivePatch< FaceList, PointField > &  ,
const bitSet flipMap = bitSet::null() 
)
static

Return parallel consistent point normals for patches using mesh points.

◆ edgeNormals() [1/2]

static tmp< pointField > edgeNormals ( const polyMesh ,
const PrimitivePatch< FaceList, PointField > &  ,
const labelList patchEdges,
const labelList coupledEdges,
const bitSet flipMap = bitSet::null() 
)
static

Return parallel consistent edge normals for patches using mesh points.

Supply with patch matching info from matchEdges.

◆ gatherAndMerge() [1/2]

void gatherAndMerge ( const scalar  mergeDist,
const PrimitivePatch< FaceList, PointField > &  pp,
Field< typename PrimitivePatch< FaceList, PointField >::point_type > &  mergedPoints,
List< typename PrimitivePatch< FaceList, PointField >::face_type > &  mergedFaces,
labelList pointMergeMap,
const bool  useLocal = false 
)
static

Gather points and faces onto master and merge into single patch.

Note: Normally uses faces/points (not localFaces/localPoints)

Parameters
[in]mergeDistGeometric merge tolerance for Foam::mergePoints
[in]ppThe patch to merge
[out]mergedPoints
[out]mergedFaces
[out]pointMergeMap
[in]useLocalgather/merge patch localFaces/localPoints instead of faces/points
Note
  • OpenFOAM-v2112 and earlier: geometric merge on all patch points.
  • OpenFOAM-v2206 and later: geometric merge on patch boundary points.

Definition at line 37 of file PatchToolsGatherAndMerge.C.

References PrimitivePatch< FaceList, PointField >::boundaryPoints(), f(), globalIndex::gather(), Foam::identity(), Foam::inplaceMergePoints(), Foam::inplaceRenumber(), globalIndex::inplaceToGlobal(), PrimitivePatch< FaceList, PointField >::localFaces(), PrimitivePatch< FaceList, PointField >::localPoints(), splitCell::master(), Foam::notNull(), UPstream::parRun(), PrimitivePatch< FaceList, PointField >::points(), globalIndex::range(), UList< T >::size(), globalIndex::subProcs(), and List< T >::transfer().

Referenced by mergedSurf::merge(), shortestPathSet::shortestPathSet(), and AMIWeights::writeWeightField().

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

◆ gatherAndMerge() [2/2]

void gatherAndMerge ( const polyMesh mesh,
const FaceList &  faces,
const labelList meshPoints,
const Map< label > &  meshPointMap,
labelList pointToGlobal,
labelList uniqueMeshPointLabels,
autoPtr< globalIndex > &  globalPoints,
autoPtr< globalIndex > &  globalFaces,
List< typename FaceList::value_type > &  mergedFaces,
pointField mergedPoints 
)
static

Gather (mesh!) points and faces onto master and merge collocated.

points into a single patch. Uses coupled point mesh structure so does not need tolerances. On master and slave returns:

  • pointToGlobal : for every local point index the global point index
  • uniqueMeshPointLabels : my local mesh points
  • globalPoints : global numbering for the global points
  • globalFaces : global numbering for the faces On master only:
  • mergedFaces : the merged faces
  • mergedPoints : the merged points

Definition at line 156 of file PatchToolsGatherAndMerge.C.

References f(), polyMesh::globalData(), Foam::identity(), Foam::inplaceRenumber(), globalMeshData::mergePoints(), mesh, UPstream::parRun(), polyMesh::points(), autoPtr< T >::reset(), and UList< T >::size().

Here is the call graph for this function:

◆ edgeOwner() [2/2]

Foam::labelList edgeOwner ( const PrimitivePatch< FaceList, PointField > &  p)

Definition at line 35 of file PatchToolsEdgeOwner.C.

References Foam::abort(), PatchTools::edgeOwner(), f(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::nl, p, and UList< T >::size().

Here is the call graph for this function:

◆ pointNormals() [2/2]

◆ edgeNormals() [2/2]

Foam::tmp< Foam::pointField > edgeNormals ( const polyMesh mesh,
const PrimitivePatch< FaceList, PointField > &  p,
const labelList patchEdges,
const labelList coupledEdges,
const bitSet pFlip 
)

Construct with all data in consistent orientation

Definition at line 197 of file PatchToolsNormals.C.

References mapDistributeBase::constructSize(), PackedList< Width >::empty(), faceNormals(), forAll, polyMesh::globalData(), globalMeshData::globalEdgeSlaves(), globalMeshData::globalEdgeSlavesMap(), globalMeshData::globalEdgeTransformedSlaves(), globalMeshData::globalTransforms(), Foam::mag(), mesh, n, Time::New(), p, globalMeshData::syncData(), and Foam::Zero.

Here is the call graph for this function:

◆ markZones() [2/2]

Foam::label markZones ( const PrimitivePatch< FaceList, PointField > &  p,
const BoolListType &  borderEdge,
labelList faceZone 
)

Definition at line 109 of file PatchToolsSearch.C.

References p, List< T >::setSize(), and UList< T >::size().

Here is the call graph for this function:

◆ sortedEdgeFaces() [2/2]

Foam::labelListList sortedEdgeFaces ( const PrimitivePatch< FaceList, PointField > &  p)

Definition at line 37 of file PatchToolsSortEdges.C.

References e, f(), forAll, SortableList< T >::indices(), Foam::mag(), pTraits< complex >::max, Foam::normalised(), p, Foam::pseudoAngle(), UList< T >::size(), SortableList< T >::sort(), and PatchTools::sortedEdgeFaces().

Here is the call graph for this function:

◆ sortedPointEdges() [2/2]

Foam::labelListList sortedPointEdges ( const PrimitivePatch< FaceList, PointField > &  p)

Definition at line 35 of file PatchToolsSortPoints.C.

References DynamicList< T, SizeMin >::append(), DynamicList< T, SizeMin >::clear(), edge::end(), Foam::endl(), forAll, UList< T >::found(), Foam::nl, p, DynamicList< T, SizeMin >::setCapacity(), UList< T >::size(), PatchTools::sortedPointEdges(), edge::start(), and WarningInFunction.

Here is the call graph for this function:

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