Surface-surface intersection. Given two surfaces construct combined surface. More...

Inheritance diagram for booleanSurface:

Collaboration diagram for booleanSurface:

Public Types
enum	booleanOpType { UNION, INTERSECTION, DIFFERENCE, ALL }
	Enumeration listing the possible volume operator types. More...

Public Types inherited from triSurface
typedef bool	BoundaryMesh
	Placeholder only, but do not remove - it is needed for GeoMesh. More...

Public Types inherited from PrimitivePatch< labelledTri, ::Foam::List, pointField, point >
enum	surfaceTopo
	Enumeration defining the surface type. Used in check routines. More...

typedef labelledTri	FaceType

typedef ::Foam::List< labelledTri >	FaceListType

typedef pointField	PointFieldType

Public Types inherited from List< labelledTri >
typedef SubList< labelledTri >	subList
	Declare type of subList. More...

Public Member Functions
	ClassName ("booleanSurface")

	booleanSurface ()
	Construct null. More...

	booleanSurface (const triSurface &surf1, const triSurface &surf2, const surfaceIntersection &inter, const label includeFace1, const label includeFace2)
	Construct from surfaces and face labels to keep. More...

	booleanSurface (const triSurface &surf1, const triSurface &surf2, const surfaceIntersection &inter, const label booleanOp)
	Construct from surfaces and operation. Surfaces need to be closed. More...

const labelList &	faceMap () const
	New to old face map. >0: surface 1 face label. <0: surface 2. Negate. More...

bool	from1 (const label facei) const

bool	surf1Face (const label facei) const

bool	surf2Face (const label facei) const

Public Member Functions inherited from triSurface
	ClassName ("triSurface")
	Runtime type information. More...

	triSurface ()
	Construct null. More...

	triSurface (const triSurface &surf)
	Copy construct. More...

	triSurface (triSurface &&surf)
	Move construct. More...

	triSurface (const List< labelledTri > &triangles, const geometricSurfacePatchList &patches, const pointField &pts)
	Construct from triangles, patches, points. More...

	triSurface (List< labelledTri > &triangles, const geometricSurfacePatchList &patches, pointField &pts, const bool reuse)
	Construct from triangles, patches, points. Reuse storage. More...

	triSurface (const List< labelledTri > &triangles, const pointField &pts)

	triSurface (const triFaceList &triangles, const pointField &pts)

	triSurface (const fileName &name, const scalar scaleFactor=-1)
	Construct from file name (uses extension to determine type). More...

	triSurface (const fileName &name, const word &ext, const scalar scaleFactor=-1)
	Construct from file name (uses extension to determine type) More...

	triSurface (Istream &is)
	Construct from Istream. More...

	triSurface (const Time &d)
	Construct from objectRegistry. More...

virtual	~triSurface ()
	Destructor. More...

void	clearOut ()

void	clearTopology ()

void	clearPatchMeshAddr ()

void	swap (triSurface &surf)

const geometricSurfacePatchList &	patches () const

geometricSurfacePatchList &	patches ()

const List< labelledTri > &	surfFaces () const
	Return const access to the faces. More...

const labelListList &	sortedEdgeFaces () const
	Return edge-face addressing sorted (for edges with more than. More...

const labelList &	edgeOwner () const
	If 2 face neighbours: label of face where ordering of edge. More...

const vectorField &	Sf () const
	Face area vectors (normals) More...

const scalarField &	magSf () const
	Face area magnitudes. More...

const vectorField &	Cf () const
	Face centres. More...

List< surfZone >	sortedZones (labelList &faceMap) const
	Sort faces according to zoneIds. More...

void	triFaceFaces (List< face > &plainFaceList) const
	Create a list of faces from the triFaces. More...

virtual void	movePoints (const pointField &pts)
	Move points. More...

virtual void	swapPoints (pointField &pts)
	Swap points. Similar to movePoints, but returns the old points. More...

virtual void	scalePoints (const scalar scaleFactor)
	Scale points. A non-positive factor is ignored. More...

void	checkTriangles (const bool verbose)
	Check/remove duplicate/degenerate triangles. More...

void	checkEdges (const bool verbose)
	Check triply (or more) connected edges. More...

void	cleanup (const bool verbose)
	Remove non-valid triangles. More...

void	markZone (const boolList &borderEdge, const label facei, const label currentZone, labelList &faceZone) const
	Fill faceZone with currentZone for every face reachable. More...

label	markZones (const boolList &borderEdge, labelList &faceZone) const
	(size and) fills faceZone with zone of face. Zone is area More...

void	subsetMeshMap (const boolList &include, labelList &pointMap, labelList &faceMap) const
	'Create' sub mesh More...

triSurface	subsetMesh (const boolList &include, labelList &pointMap, labelList &faceMap) const
	Return new surface. More...

triSurface	subsetMesh (const boolList &include) const
	Return new surface. More...

void	swapFaces (List< labelledTri > &faceLst)
	Swap the list of faces being addressed. More...

void	transfer (triSurface &surf)
	Alter contents by transferring (triangles, points) components. More...

void	transfer (MeshedSurface< labelledTri > &surf)
	Alter contents by transferring (triangles, points) components. More...

void	write (Ostream &os) const
	Write to Ostream in simple FOAM format. More...

void	write (const fileName &, const bool sortByRegion=false) const
	Generic write routine. Chooses writer based on extension. More...

void	write (const Time &d) const
	Write to database. More...

void	writeStats (Ostream &os) const
	Write some statistics. More...

void	operator= (const triSurface &surf)
	Copy assignment. More...

void	operator= (triSurface &&surf)
	Move assignment. More...

void	operator= (MeshedSurface< labelledTri > &&surf)
	Move assignment. More...

Public Member Functions inherited from PrimitivePatch< labelledTri, ::Foam::List, pointField, point >
	PrimitivePatch (const ::Foam::List< labelledTri > &faces, const Field< point > &points)
	Construct from components. More...

	PrimitivePatch (::Foam::List< labelledTri > &&faces, const Field< point > &points)
	Construct from components, transferring faces. More...

	PrimitivePatch (::Foam::List< labelledTri > &faces, Field< point > &points, const bool reuse)
	Construct from components, reuse storage. More...

	PrimitivePatch (const PrimitivePatch< labelledTri, ::Foam::List, pointField, point > &)
	Construct as copy. 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 > &	points () const
	Return reference to global points. More...

label	nPoints () const
	Return number of points supporting patch faces. More...

label	nEdges () const
	Return number of edges in patch. More...

const edgeList &	edges () const
	Return list of edges, address into LOCAL point list. More...

label	nInternalEdges () const
	Number of internal edges. More...

bool	isInternalEdge (const label edgei) const
	Is internal edge? More...

const labelList &	boundaryPoints () const
	Return list of boundary points, address into LOCAL point list. More...

const labelListList &	faceFaces () const
	Return face-face addressing. More...

const labelListList &	edgeFaces () const
	Return edge-face addressing. More...

const labelListList &	faceEdges () const
	Return face-edge addressing. More...

const labelListList &	pointEdges () const
	Return point-edge addressing. More...

const labelListList &	pointFaces () const
	Return point-face addressing. More...

const List< labelledTri > &	localFaces () const
	Return patch faces addressing into local point list. More...

const labelList &	meshPoints () const
	Return labelList of mesh points in patch. More...

const Map< label > &	meshPointMap () const
	Mesh point map. More...

const Field< point > &	localPoints () const
	Return pointField of points in patch. More...

const labelList &	localPointOrder () 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...

label	whichEdge (const edge &) const

labelList	meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const

labelList	meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const

const Field< point > &	faceCentres () const
	Return face centres for patch. More...

const Field< point > &	faceAreas () const
	Return face area vectors for patch. More...

const Field< scalar > &	magFaceAreas () const
	Return face area magnitudes for patch. More...

const Field< point > &	faceNormals () const
	Return face unit normals for patch. More...

const Field< point > &	pointNormals () const
	Return point normals for patch. More...

bool	hasFaceAreas () const

bool	hasFaceCentres () const

bool	hasFaceNormals () const

bool	hasPointNormals () const

List< objectHit >	projectPoints (const ToPatch &targetPatch, const Field< point > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
	Project vertices of patch onto another patch. More...

Foam::List< Foam::objectHit >	projectPoints (const ToPatch &targetPatch, const Field< point > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

List< objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< point > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
	Project vertices of patch onto another patch. More...

Foam::List< Foam::objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< point > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

const labelListList &	edgeLoops () 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 > &)
	Correct patch after moving points. More...

void	operator= (const PrimitivePatch< labelledTri, ::Foam::List, pointField, point > &)
	Assignment. More...

Public Member Functions inherited from List< labelledTri >
constexpr	List () noexcept
	Null constructor. More...

	List (const label len)
	Construct with given size. More...

	List (const label len, const labelledTri &val)
	Construct with given size and value for all elements. More...

	List (const label len, const zero)
	Construct with given size initializing all elements to zero. More...

	List (const one, const labelledTri &val)
	Construct with length=1, copying the value as the only content. More...

	List (const one, labelledTri &&val)
	Construct with length=1, moving the value as the only content. More...

	List (const one, const zero)
	Construct with length=1, initializing content to zero. More...

	List (const List< labelledTri > &a)
	Copy construct from list. More...

	List (const UList< labelledTri > &a)
	Copy construct contents from list. More...

	List (List< labelledTri > &a, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< labelledTri > &list, const labelUList &mapAddressing)
	Construct as subset. More...

	List (InputIterator begIter, InputIterator endIter)
	Construct given begin/end iterators. More...

	List (const FixedList< labelledTri, N > &list)
	Construct as copy of FixedList<T, N> More...

	List (const PtrList< labelledTri > &list)
	Construct as copy of PtrList<T> More...

	List (const SLList< labelledTri > &list)
	Construct as copy of SLList<T> More...

	List (const IndirectListBase< labelledTri, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< labelledTri > list)
	Construct from an initializer list. More...

	List (List< labelledTri > &&list)
	Move construct from List. More...

	List (DynamicList< labelledTri, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (SortableList< labelledTri > &&list)
	Move construct from SortableList. More...

	List (SLList< labelledTri > &&list)
	Move construct from SLList. More...

	List (Istream &is)
	Construct from Istream. More...

autoPtr< List< labelledTri > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	resize (const label newSize)
	Adjust allocated size of list. More...

void	resize (const label newSize, const labelledTri &val)
	Adjust allocated size of list and set val for new elements. More...

void	resize (const label newSize)

void	setSize (const label newSize)
	Alias for resize(const label) More...

void	setSize (const label newSize, const labelledTri &val)
	Alias for resize(const label, const T&) More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	append (const labelledTri &val)
	Append an element at the end of the list. More...

void	append (labelledTri &&val)
	Move append an element at the end of the list. More...

void	append (const UList< labelledTri > &list)
	Append a List to the end of this list. More...

void	append (const IndirectListBase< labelledTri, Addr > &list)
	Append IndirectList contents at the end of this list. More...

void	transfer (List< labelledTri > &list)

void	transfer (DynamicList< labelledTri, SizeMin > &list)

void	transfer (SortableList< labelledTri > &list)

labelledTri &	newElmt (const label i)

void	operator= (const UList< labelledTri > &a)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< labelledTri > &list)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< labelledTri > &list)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const IndirectListBase< labelledTri, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

void	operator= (std::initializer_list< labelledTri > list)
	Assignment to an initializer list. More...

void	operator= (const labelledTri &val)
	Assignment of all entries to the given value. More...

void	operator= (const zero)
	Assignment of all entries to zero. More...

void	operator= (List< labelledTri > &&list)
	Move assignment. Takes constant time. More...

void	operator= (DynamicList< labelledTri, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SortableList< labelledTri > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< labelledTri > &&list)
	Move assignment. Takes constant time. More...

void	shallowCopy (const UList< labelledTri > &)=delete
	No shallowCopy permitted. More...

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool. More...

Static Public Attributes
static const Enum< booleanOpType >	booleanOpTypeNames

Additional Inherited Members
Static Public Member Functions inherited from triSurface
static fileName	triSurfInstance (const Time &)
	Name of triSurface directory to use. More...

static bool	canRead (const fileName &name, const bool verbose=false)
	Can we read this file format? More...

static bool	canReadType (const word &ext, const bool verbose=false)
	Can we read this file format? More...

static bool	canWriteType (const word &ext, const bool verbose=false)
	Can we write this file format? More...

static const wordHashSet &	readTypes ()
	Known readable file-types. More...

static const wordHashSet &	writeTypes ()
	Known writable file-types. More...

Static Public Member Functions inherited from List< labelledTri >
static const List< labelledTri > &	null ()
	Return a null List. More...

Protected Member Functions inherited from triSurface
pointField &	storedPoints ()
	Non-const access to global points. More...

List< Face > &	storedFaces ()
	Non-const access to the faces. More...

Detailed Description

Surface-surface intersection. Given two surfaces construct combined surface.

Called 'boolean' since the volume of resulting surface will encompass the volumes of the original surface according to some boolean operation:

all which is in surface1 AND in surface2 (intersection)
all which is in surface1 AND NOT in surface2 (surface1 minus surface2)
all which is in surface1 OR in surface2 (union)

Algorithm:

find edge-surface intersection. Class 'surfaceIntersection'.
combine intersection with both surfaces. Class 'intersectedSurface'.
subset surfaces upto intersection. The 'side' of the surface to include is based on the faces that can be reached from a user-supplied face index.
merge surfaces. Only the points on the intersection are shared.

Source files

Definition at line 71 of file booleanSurface.H.

Member Enumeration Documentation

◆ booleanOpType

enum booleanOpType

Enumeration listing the possible volume operator types.

Enumerator
UNION
INTERSECTION
DIFFERENCE
ALL

Definition at line 166 of file booleanSurface.H.

Constructor & Destructor Documentation

◆ booleanSurface() [1/3]

booleanSurface ( )

Construct null.

Definition at line 387 of file booleanSurface.C.

◆ booleanSurface() [2/3]

booleanSurface	(	const triSurface &	surf1,
		const triSurface &	surf2,
		const surfaceIntersection &	inter,
		const label	includeFace1,
		const label	includeFace2
	)

Construct from surfaces and face labels to keep.

Walks from provided seed faces without crossing intersection line to determine faces to keep.

Definition at line 395 of file booleanSurface.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::exit(), f(), intersectedSurface::faceMap(), Foam::FatalError, FatalErrorInFunction, forAll, intersectedSurface::intersectionEdges(), intersectedSurface::isSurfacePoint(), triSurface::markZones(), PrimitivePatch< Face, FaceList, PointField, PointType >::nEdges(), PrimitivePatch< Face, FaceList, PointField, PointType >::nPoints(), intersectedSurface::nSurfacePoints(), Foam::Pout, List< T >::setSize(), triSurface::subsetMesh(), triSurface::write(), and triSurface::writeStats().

Here is the call graph for this function:

◆ booleanSurface() [3/3]

booleanSurface	(	const triSurface &	surf1,
		const triSurface &	surf2,
		const surfaceIntersection &	inter,
		const label	booleanOp
	)

Construct from surfaces and operation. Surfaces need to be closed.

for this to make any sense since uses inside/outside to determine which part of combined surface to include.

Definition at line 706 of file booleanSurface.C.

References booleanSurface::ALL, Foam::expressions::patchExpr::debug, PointHit< Point >::distance(), PrimitivePatch< Face, FaceList, PointField, PointType >::edgeFaces(), PrimitivePatch< Face, FaceList, PointField, PointType >::edges(), Foam::endl(), Foam::exit(), intersectedSurface::faceMap(), Foam::FatalError, FatalErrorInFunction, forAll, booleanSurface::INTERSECTION, intersectedSurface::isSurfacePoint(), PrimitivePatch< Face, FaceList, PointField, PointType >::localPoints(), Foam::nl, PrimitivePatch< Face, FaceList, PointField, PointType >::nPoints(), intersectedSurface::nSurfacePoints(), triSurface::operator=(), PrimitivePatch< Face, FaceList, PointField, PointType >::points(), Foam::Pout, PointHit< Point >::rawPoint(), labelledTri::region(), List< T >::setSize(), triSurface::subsetMesh(), booleanSurface::UNION, WarningInFunction, triSurface::write(), triSurface::writeStats(), and Foam::Zero.

Here is the call graph for this function:

Member Function Documentation

◆ ClassName()

ClassName ( "booleanSurface" )

◆ faceMap()

const labelList& faceMap ( ) const

inline

New to old face map. >0: surface 1 face label. <0: surface 2. Negate.

and subtract 1 to get face label on surface 2.

Definition at line 214 of file booleanSurface.H.

◆ from1()

bool from1 ( const label facei ) const

inline

Definition at line 219 of file booleanSurface.H.

Referenced by booleanSurface::surf1Face(), and booleanSurface::surf2Face().

Here is the caller graph for this function:

◆ surf1Face()

bool surf1Face ( const label facei ) const

inline

Definition at line 224 of file booleanSurface.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and booleanSurface::from1().

Here is the call graph for this function:

◆ surf2Face()

bool surf2Face ( const label facei ) const

inline

Definition at line 235 of file booleanSurface.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and booleanSurface::from1().

Here is the call graph for this function:

Member Data Documentation

◆ booleanOpTypeNames

const Foam::Enum< Foam::booleanSurface::booleanOpType > booleanOpTypeNames

static

Definition at line 177 of file booleanSurface.H.

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

src/meshTools/triSurface/booleanOps/booleanSurface/booleanSurface.H
src/meshTools/triSurface/booleanOps/booleanSurface/booleanSurface.C

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ booleanOpType

Constructor & Destructor Documentation

◆ booleanSurface() [1/3]

◆ booleanSurface() [2/3]

◆ booleanSurface() [3/3]

Member Function Documentation

◆ ClassName()

◆ faceMap()

◆ from1()

◆ surf1Face()

◆ surf2Face()

Member Data Documentation

◆ booleanOpTypeNames