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 Types inherited from UList< T >
typedef T	value_type
	Type of values the UList contains. More...

typedef T &	reference
	Type that can be used for storing into. More...

typedef const T &	const_reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

typedef label	size_type
	The type that can represent the size of a UList. More...

typedef T *	iterator
	Random access iterator for traversing UList. More...

typedef const T *	const_iterator
	Random access iterator for traversing UList. More...

typedef T *	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef const T *	const_reverse_iterator
	Reverse iterator for reverse traversal of constant UList. 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 List< labelledTri > &, const geometricSurfacePatchList &, const pointField &)
	Construct from triangles, patches, points. More...

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

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

	triSurface (const List< labelledTri > &, const pointField &)
	Construct from triangles, points. Set patchnames to default. More...

	triSurface (const triFaceList &, const pointField &)
	Construct from triangles, points. Set region to 0 and default. More...

	triSurface (const fileName &)
	Construct from file name (uses extension to determine type) More...

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

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

	triSurface (const triSurface &)
	Construct as copy. More...

	~triSurface ()
	Destructor. More...

void	clearOut ()

void	clearTopology ()

void	clearPatchMeshAddr ()

const geometricSurfacePatchList &	patches () const

geometricSurfacePatchList &	patches ()

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

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

virtual void	scalePoints (const scalar)
	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, including only faces for which More...

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

void	write (Ostream &) 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 &) const
	Write to database. More...

void	writeDX (const scalarField &, Ostream &) const
	Write to Ostream in OpenDX format. More...

void	writeDX (const vectorField &, Ostream &) const

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

void	operator= (const triSurface &)

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 (const Xfer< ::Foam::List< labelledTri >> &faces, const Xfer< List< point >> &points)
	Construct from components. 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 ()

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,. 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. They are constructed. More...

const Map< label > &	meshPointMap () const
	Mesh point map. Given the global point index find its. 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
	Given an edge in local point labels, return its. More...

labelList	meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
	Return labels of patch edges in the global edge list using. More...

labelList	meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
	Return labels of patch edges in the global edge list using. More...

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

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

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

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

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

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=NULL) const
	Check surface formed by patch for manifoldness (see above). More...

bool	checkPointManifold (const bool report=false, labelHashSet *setPtr=NULL) 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 >
label	size () const
	Return the number of elements in the UList. More...

	List ()
	Null constructor. More...

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

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

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

	List (const List< labelledTri > &)
	Copy constructor. More...

	List (const Xfer< List< labelledTri >> &)
	Construct by transferring the parameter contents. More...

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

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

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

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

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

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

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

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

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

	~List ()
	Destructor. More...

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

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

void	setSize (const label)
	Reset size of List. More...

void	setSize (const label, const labelledTri &)
	Reset size of List and value for new elements. More...

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

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

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

void	append (const UIndirectList< labelledTri > &)
	Append a UIndirectList at the end of this list. More...

void	transfer (List< labelledTri > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (DynamicList< labelledTri, SizeInc, SizeMult, SizeDiv > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (SortableList< labelledTri > &)
	Transfer the contents of the argument List into this list. More...

Xfer< List< labelledTri > >	xfer ()
	Transfer contents to the Xfer container. More...

labelledTri &	newElmt (const label)
	Return subscript-checked element of UList. More...

void	shallowCopy (const UList< labelledTri > &)=delete
	Disallow implicit shallowCopy. More...

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

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

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

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

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

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

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

Public Member Functions inherited from UList< T >
	UList ()
	Null constructor. More...

	UList (T *__restrict__ v, label size)
	Construct from components. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

std::streamsize	byteSize () const
	Return the binary size in number of characters of the UList. More...

const T *	cdata () const
	Return a const pointer to the first data element,. More...

T *	data ()
	Return a pointer to the first data element,. More...

T &	first ()
	Return the first element of the list. More...

const T &	first () const
	Return first element of the list. More...

T &	last ()
	Return the last element of the list. More...

const T &	last () const
	Return the last element of the list. More...

void	checkStart (const label start) const
	Check start is within valid range (0 ... size-1) More...

void	checkSize (const label size) const
	Check size is within valid range (0 ... size) More...

void	checkIndex (const label i) const
	Check index i is within valid range (0 ... size-1) More...

void	shallowCopy (const UList< T > &)
	Copy the pointer held by the given UList. More...

void	deepCopy (const UList< T > &)
	Copy elements of the given UList. More...

void	writeEntry (Ostream &) const
	Write the UList as a dictionary entry. More...

void	writeEntry (const word &keyword, Ostream &) const
	Write the UList as a dictionary entry with keyword. More...

T &	operator[] (const label)
	Return element of UList. More...

const T &	operator[] (const label) const
	Return element of constant UList. More...

	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&. More...

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

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

iterator	begin ()
	Return an iterator to begin traversing the UList. More...

iterator	end ()
	Return an iterator to end traversing the UList. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const
	Return const_iterator to end traversing the constant UList. More...

const_iterator	begin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	end () const
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

label	size () const
	Return the number of elements in the UList. More...

label	max_size () const
	Return size of the largest possible UList. More...

bool	empty () const
	Return true if the UList is empty (ie, size() is zero) More...

void	swap (UList< T > &)
	Swap two ULists of the same type in constant time. More...

bool	operator== (const UList< T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< T > &) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< T > &) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< T > &) const
	Return true if !(a < b). Takes linear time. More...

template<>
const bool &	operator[] (const label i) const

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

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

Static Public Member Functions inherited from UList< T >
static const UList< T > &	null ()
	Return a null UList. 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...

Protected Member Functions inherited from List< labelledTri >
void	size (const label)
	Override size to be inconsistent with allocated storage. 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 68 of file booleanSurface.H.

Member Enumeration Documentation

enum booleanOpType

Enumeration listing the possible volume operator types.

Enumerator
UNION
INTERSECTION
DIFFERENCE
ALL

Definition at line 163 of file booleanSurface.H.

Constructor & Destructor Documentation

booleanSurface ( )

Construct null.

Definition at line 372 of file booleanSurface.C.

Referenced by booleanSurface::booleanSurface().

Here is the caller graph for this function:

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