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::pointField >	pointNormals (const polyMesh &mesh, const PrimitivePatch< FaceList, PointField > &p, const bitSet &pFlip)

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

template<class FaceList , class PointField >
Foam::tmp< Foam::pointField >	pointNormals (const polyMesh &mesh, const PrimitivePatch< FaceList, PointField > &p, const pointField &localPoints, const bitSet &pFlip)

template<class FaceList , class PointField >
Foam::tmp< Foam::pointField >	edgeNormals (const polyMesh &mesh, const PrimitivePatch< FaceList, PointField > &p, const pointField &localPoints, 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< pointField >	pointNormals (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< pointField >	pointNormals (const polyMesh &, const PrimitivePatch< FaceList, PointField > &, const pointField &localPoints, const bitSet &flipMap=bitSet::null())
	Return parallel consistent point normals for patches using mesh points. More...

template<class FaceList , class PointField >
static tmp< pointField >	edgeNormals (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 tmp< pointField >	edgeNormals (const polyMesh &, const PrimitivePatch< FaceList, PointField > &, const pointField &localPoints, 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, globalIndex &pointAddr, globalIndex &faceAddr, labelList &pointMergeMap=const_cast< labelList &>(labelList::null()), const bool useLocal=false)
	Gather points and faces onto master and merge into single patch. 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_cast< labelList &>(labelList::null()), 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 64 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 29 of file PatchToolsCheck.C.

References Foam::constant::electromagnetic::e, Foam::endl(), f(), forAll, foundError, Foam::Info, HashSet< Key, Hash >::insert(), 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 34 of file PatchToolsSearch.C.

References Foam::abort(), List< T >::append(), 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]	p	patch to be searched on
[in]	includeFaces	faces to include
[out]	pointMap	mapping new to old localPoints
[out]	faceMap	mapping new to old faces

Definition at line 136 of file PatchToolsSearch.C.

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

Referenced by UnsortedMeshedSurface< Face >::subsetMeshMap(), triSurface::subsetMeshMap(), and MeshedSurface< Foam::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 172 of file PatchToolsSearch.C.

References boundBox::add(), f(), nPoints, p, points, and boundBox::reset().

Referenced by triSurfaceMesh::edgeTree(), triSurfaceSearch::tree(), triSurfaceRegionSearch::treeByRegion(), and distributedTriSurfaceMesh::writeStats().

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

◆ sortedPointEdges() [1/2]

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

static

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

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

◆ 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 32 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 70 of file PatchToolsMatch.C.

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

Referenced by addPatchCellLayer::calcExtrudeInfo(), createShellMesh::calcPointRegions(), and meshRefinement::countEdgeFaces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pointNormals() [1/4]

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.

Referenced by snappySnapDriver::doSnap().

Here is the caller graph for this function:

◆ pointNormals() [2/4]

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

static

Return parallel consistent point normals for patches using mesh points.

Get all geometry from provided patch local points. (assumed to be consistent across coupled patches)

◆ edgeNormals() [1/4]

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.

◆ edgeNormals() [2/4]

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

static

Return parallel consistent edge normals for patches using mesh points.

Get all geometry from provided patch local points. (assumed to be consistent across coupled patches) Supply with patch matching info from matchEdges.

◆ gatherAndMerge() [1/3]

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,
		globalIndex &	pointAddr,
		globalIndex &	faceAddr,
		labelList &	pointMergeMap = `const_cast<labelList&>(labelList::null())`,
		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]	mergeDist	Geometric merge tolerance for Foam::mergePoints
[in]	pp	The patch to merge
[out]	mergedPoints	merged points (master only, empty elsewhere)
[out]	mergedFaces	merged faces (master only, empty elsewhere)
[out]	pointAddr	Points globalIndex gather addressing (master only, empty elsewhere)
[out]	faceAddr	Faces globalIndex gather addressing (master only, empty elsewhere)
[out]	pointMergeMap	An old-to-new mapping from original point index to the index into merged points.
[in]	useLocal	gather/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 31 of file PatchToolsGatherAndMerge.C.

References f(), globalIndex::gather(), Foam::identity(), Foam::inplaceMergePoints(), Foam::inplaceRenumber(), globalIndex::inplaceToGlobal(), Foam::notNull(), pp(), globalIndex::range(), globalIndex::reset(), 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/3]

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_cast<labelList&>(labelList::null())`,
		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]	mergeDist	Geometric merge tolerance for Foam::mergePoints
[in]	pp	The patch to merge
[out]	mergedPoints	merged points (master only, empty elsewhere)
[out]	mergedFaces	merged faces (master only, empty elsewhere)
[out]	pointMergeMap	An old-to-new mapping from original point index to the index into merged points.
[in]	useLocal	gather/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 152 of file PatchToolsGatherAndMerge.C.

References pp().

Here is the call graph for this function:

◆ gatherAndMerge() [3/3]

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 sub-ranks 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 returns:

mergedFaces : the merged faces
mergedPoints : the merged points

Definition at line 186 of file PatchToolsGatherAndMerge.C.

References f(), Foam::identity(), Foam::inplaceRenumber(), mesh, 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 29 of file PatchToolsEdgeOwner.C.

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

Here is the call graph for this function:

◆ pointNormals() [3/4]

Foam::tmp<Foam::pointField> pointNormals	(	const polyMesh &	mesh,
		const PrimitivePatch< FaceList, PointField > &	p,
		const bitSet &	pFlip
	)

◆ edgeNormals() [3/4]

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 191 of file PatchToolsNormals.C.

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

Here is the call graph for this function:

◆ pointNormals() [4/4]

Foam::tmp<Foam::pointField> pointNormals	(	const polyMesh &	mesh,
		const PrimitivePatch< FaceList, PointField > &	p,
		const pointField &	localPoints,
		const bitSet &	pFlip
	)

◆ edgeNormals() [4/4]

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

Construct with all data in consistent orientation

Definition at line 437 of file PatchToolsNormals.C.

References mapDistributeBase::constructSize(), PackedList< Width >::empty(), forAll, globalMeshData::globalEdgeSlaves(), globalMeshData::globalEdgeSlavesMap(), globalMeshData::globalEdgeTransformedSlaves(), globalMeshData::globalTransforms(), Foam::mag(), mesh, n, Foam::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 104 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 31 of file PatchToolsSortEdges.C.

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

Here is the call graph for this function:

◆ sortedPointEdges() [2/2]

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

Definition at line 29 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(), edge::start(), and WarningInFunction.

Here is the call graph for this function:

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

src/OpenFOAM/meshes/primitiveMesh/PatchTools/PatchTools.H
src/OpenFOAM/meshes/primitiveMesh/PatchTools/PatchToolsCheck.C
src/OpenFOAM/meshes/primitiveMesh/PatchTools/PatchToolsEdgeOwner.C
src/OpenFOAM/meshes/primitiveMesh/PatchTools/PatchToolsGatherAndMerge.C
src/OpenFOAM/meshes/primitiveMesh/PatchTools/PatchToolsMatch.C
src/OpenFOAM/meshes/primitiveMesh/PatchTools/PatchToolsNormals.C
src/OpenFOAM/meshes/primitiveMesh/PatchTools/PatchToolsSearch.C
src/OpenFOAM/meshes/primitiveMesh/PatchTools/PatchToolsSortEdges.C
src/OpenFOAM/meshes/primitiveMesh/PatchTools/PatchToolsSortPoints.C

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ checkOrientation()

◆ markZone()

◆ markZones() [1/2]

◆ subsetMap()

◆ calcBounds()

◆ sortedEdgeFaces() [1/2]

◆ sortedPointEdges() [1/2]

◆ edgeOwner() [1/2]

◆ matchPoints()

◆ matchEdges()

◆ pointNormals() [1/4]

◆ pointNormals() [2/4]

◆ edgeNormals() [1/4]

◆ edgeNormals() [2/4]

◆ gatherAndMerge() [1/3]

◆ gatherAndMerge() [2/3]

◆ gatherAndMerge() [3/3]

◆ edgeOwner() [2/2]

◆ pointNormals() [3/4]

◆ edgeNormals() [3/4]

◆ pointNormals() [4/4]

◆ edgeNormals() [4/4]

◆ markZones() [2/2]

◆ sortedEdgeFaces() [2/2]

◆ sortedPointEdges() [2/2]