intersectedSurface Class Reference

Given triSurface and intersection creates the intersected (properly triangulated) surface. (note: intersection is the list of points and edges 'shared' by two surfaces) More...

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

Public Member Functions

 ClassName ("intersectedSurface")
 
 intersectedSurface ()
 Construct null. More...
 
 intersectedSurface (const triSurface &surf)
 Construct from surface. More...
 
 intersectedSurface (const triSurface &surf, const bool isFirstSurface, const surfaceIntersection &inter)
 Construct from surface and intersection. isFirstSurface is needed. More...
 
const labelListintersectionEdges () const
 Labels of edges in *this which originate from 'cuts'. More...
 
const labelListfaceMap () const
 New to old. More...
 
label nSurfacePoints () const
 Number of points from original surface. More...
 
bool isSurfacePoint (const label pointi) const
 Is point coming from original surface? More...
 
- 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 geometricSurfacePatchListpatches () const
 
geometricSurfacePatchListpatches ()
 
const List< labelledTri > & surfFaces () const
 Return const access to the faces. More...
 
const labelListListsortedEdgeFaces () const
 Return edge-face addressing sorted (for edges with more than. More...
 
const labelListedgeOwner () const
 If 2 face neighbours: label of face where ordering of edge. More...
 
const vectorFieldSf () const
 Face area vectors (normals) More...
 
const scalarFieldmagSf () const
 Face area magnitudes. More...
 
const vectorFieldCf () const
 Face centres. More...
 
List< surfZonesortedZones (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 edgeListedges () 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 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< labelledTri > & localFaces () const
 Return patch faces addressing into local point list. More...
 
const labelListmeshPoints () 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 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...
 
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< objectHitprojectPoints (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::objectHitprojectPoints (const ToPatch &targetPatch, const Field< point > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
 
List< objectHitprojectFaceCentres (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::objectHitprojectFaceCentres (const ToPatch &targetPatch, const Field< point > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
 
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 > &)
 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)
 
labelledTrinewElmt (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 label UNVISITED = 0
 
static const label STARTTOEND = 1
 
static const label ENDTOSTART = 2
 
static const label BOTH = STARTTOEND | ENDTOSTART
 

Additional Inherited Members

- 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< labelledTriFaceListType
 
typedef pointField PointFieldType
 
- Public Types inherited from List< labelledTri >
typedef SubList< labelledTrisubList
 Declare type of subList. More...
 
- 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 wordHashSetreadTypes ()
 Known readable file-types. More...
 
static const wordHashSetwriteTypes ()
 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
pointFieldstoredPoints ()
 Non-const access to global points. More...
 
List< Face > & storedFaces ()
 Non-const access to the faces. More...
 

Detailed Description

Given triSurface and intersection creates the intersected (properly triangulated) surface. (note: intersection is the list of points and edges 'shared' by two surfaces)

Algorithm:

  • from the intersection get the points created on the edges of the surface
  • split the edges of the surface
  • construct a new edgeList with (in this order) the edges from the intersection ('cuts', i.e. the edges shared with the other surface) and the (split) edges from the original triangles (from 0 .. nSurfaceEdges)
  • construct face-edge addressing for above edges
  • for each face do a right-handed walk to reconstruct faces (splitFace)
  • retriangulate resulting faces (might be non-convex so use faceTriangulation which does proper bisection)

The resulting surface will have the points from the surface first in the point list (0 .. nSurfacePoints-1)

Note: problematic are the cut-edges which are completely inside a face. These will not be visited by a edge-point-edge walk. These are handled by resplitFace which first connects the 'floating' edges to triangle edges with two extra edges and then tries the splitting again. Seems to work (mostly). Will probably fail for boundary edge (edge with only face).

Note: points are compact, i.e. points().size() == localPoints().size() (though points() probably not localPoints())

Source files

Definition at line 83 of file intersectedSurface.H.

Constructor & Destructor Documentation

◆ intersectedSurface() [1/3]

Construct null.

Definition at line 1001 of file intersectedSurface.C.

◆ intersectedSurface() [2/3]

intersectedSurface ( const triSurface surf)

Construct from surface.

Definition at line 1010 of file intersectedSurface.C.

◆ intersectedSurface() [3/3]

intersectedSurface ( const triSurface surf,
const bool  isFirstSurface,
const surfaceIntersection inter 
)

Construct from surface and intersection. isFirstSurface is needed.

to determine which side of face pairs stored in the intersection to address. Should be in the same order as how the intersection was constructed.

Definition at line 1020 of file intersectedSurface.C.

References Foam::abort(), surfaceIntersection::cutEdges(), surfaceIntersection::cutPoints(), Foam::constant::electromagnetic::e, edgeSurface::edges(), Foam::endl(), edgeSurface::faceEdges(), PrimitivePatch< Face, FaceList, PointField, PointType >::faceEdges(), PrimitivePatch< Face, FaceList, PointField, PointType >::faceNormals(), Foam::FatalError, FatalErrorInFunction, forAll, edge::found(), PrimitivePatch< Face, FaceList, PointField, PointType >::localFaces(), n, edgeSurface::nSurfaceEdges(), edgeSurface::nSurfacePoints(), triSurface::operator=(), triSurface::patches(), edgeSurface::points(), List< T >::setSize(), and Foam::Zero.

Here is the call graph for this function:

Member Function Documentation

◆ ClassName()

ClassName ( "intersectedSurface"  )

◆ intersectionEdges()

const labelList& intersectionEdges ( ) const
inline

Labels of edges in *this which originate from 'cuts'.

Definition at line 270 of file intersectedSurface.H.

Referenced by booleanSurface::booleanSurface().

Here is the caller graph for this function:

◆ faceMap()

const labelList& faceMap ( ) const
inline

New to old.

Definition at line 276 of file intersectedSurface.H.

Referenced by booleanSurface::booleanSurface().

Here is the caller graph for this function:

◆ nSurfacePoints()

label nSurfacePoints ( ) const
inline

Number of points from original surface.

Definition at line 282 of file intersectedSurface.H.

Referenced by booleanSurface::booleanSurface().

Here is the caller graph for this function:

◆ isSurfacePoint()

bool isSurfacePoint ( const label  pointi) const
inline

Is point coming from original surface?

Definition at line 288 of file intersectedSurface.H.

Referenced by booleanSurface::booleanSurface().

Here is the caller graph for this function:

Member Data Documentation

◆ UNVISITED

const Foam::label UNVISITED = 0
static

Definition at line 89 of file intersectedSurface.H.

◆ STARTTOEND

const Foam::label STARTTOEND = 1
static

Definition at line 90 of file intersectedSurface.H.

◆ ENDTOSTART

const Foam::label ENDTOSTART = 2
static

Definition at line 91 of file intersectedSurface.H.

◆ BOTH

const Foam::label BOTH = STARTTOEND | ENDTOSTART
static

Definition at line 92 of file intersectedSurface.H.


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