STLsurfaceFormat< Face > Class Template Reference

Provide a means of reading/writing STL files (ASCII and binary). More...

Inheritance diagram for STLsurfaceFormat< Face >:
Collaboration diagram for STLsurfaceFormat< Face >:

Public Member Functions

 STLsurfaceFormat (const fileName &)
 Construct from file name. More...
 
 STLsurfaceFormat (const STLsurfaceFormat< Face > &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~STLsurfaceFormat ()
 Destructor. More...
 
virtual bool read (const fileName &)
 Read from file. More...
 
virtual void write (const fileName &name) const
 Write object. More...
 
void operator= (const STLsurfaceFormat< Face > &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from MeshedSurface< Face >
 ClassName ("MeshedSurface")
 Runtime type information. More...
 
 MeshedSurface ()
 Construct null. More...
 
 MeshedSurface (pointField &&, List< Face > &&, surfZoneList &&)
 Construct by transferring components (points, faces, zones). More...
 
 MeshedSurface (pointField &&, List< Face > &&, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
 Construct by transferring components (points, faces). More...
 
 MeshedSurface (const MeshedSurface &)
 Copy constructor. More...
 
 MeshedSurface (const UnsortedMeshedSurface< Face > &)
 Construct from a UnsortedMeshedSurface. More...
 
 MeshedSurface (const polyBoundaryMesh &, const bool globalPoints=false)
 Construct from a boundary mesh with local points/faces. More...
 
 MeshedSurface (const surfMesh &)
 Construct from a surfMesh. More...
 
 MeshedSurface (UnsortedMeshedSurface< Face > &&)
 Construct by transferring the contents from a UnsortedMeshedSurface. More...
 
 MeshedSurface (MeshedSurface< Face > &&)
 Construct by transferring the contents from a MeshedSurface. More...
 
 MeshedSurface (const fileName &)
 Construct from file name (uses extension to determine type) More...
 
 MeshedSurface (const fileName &, const word &ext)
 Construct from file name (uses extension to determine type) More...
 
 MeshedSurface (const Time &, const word &surfName="")
 Construct from database. More...
 
 declareRunTimeSelectionTable (autoPtr, MeshedSurface, fileExtension,(const fileName &name),(name))
 
virtual ~MeshedSurface ()
 Destructor. More...
 
 declareMemberFunctionSelectionTable (void, UnsortedMeshedSurface, write, fileExtension,(const fileName &name, const MeshedSurface< Face > &surf),(name, surf))
 
label size () const
 The surface size is the number of faces. More...
 
const List< Face > & faces () const
 Return const access to the faces. More...
 
const List< surfZone > & surfZones () const
 Const access to the surface zones. More...
 
virtual void addZones (const UList< surfZone > &, const bool cullEmpty=false)
 Add surface zones. More...
 
virtual void addZones (const labelUList &sizes, const UList< word > &names, const bool cullEmpty=false)
 Add surface zones. More...
 
virtual void addZones (const labelUList &sizes, const bool cullEmpty=false)
 Add surface zones. More...
 
virtual void removeZones ()
 Remove surface zones. More...
 
virtual void clear ()
 Clear all storage. More...
 
virtual void setPoints (const pointField &)
 Reset the points. More...
 
virtual void scalePoints (const scalar)
 Scale points. A non-positive factor is ignored. More...
 
virtual void reset (pointField &&points, List< Face > &&faces, surfZoneList &&zones)
 Reset primitive data (points, faces and zones) More...
 
virtual void reset (List< point > &&points, List< Face > &&faces, surfZoneList &&zones)
 Reset primitive data (points, faces and zones) More...
 
virtual void cleanup (const bool verbose)
 Remove invalid faces. More...
 
virtual bool stitchFaces (const scalar tol=small, const bool verbose=false)
 
virtual bool checkFaces (const bool verbose=false)
 
virtual label triangulate ()
 Triangulate in-place, returning the number of triangles added. More...
 
virtual label triangulate (List< label > &faceMap)
 Triangulate in-place, returning the number of triangles added. More...
 
MeshedSurface subsetMesh (const labelHashSet &include, labelList &pointMap, labelList &faceMap) const
 Return new surface. More...
 
MeshedSurface subsetMesh (const labelHashSet &include) const
 Return new surface. More...
 
void transfer (MeshedSurface< Face > &)
 Transfer the contents of the argument and annul the argument. More...
 
void transfer (UnsortedMeshedSurface< Face > &)
 Transfer the contents of the argument and annul the argument. More...
 
bool read (const fileName &, const word &ext)
 Read from file. Chooses reader based on explicit extension. More...
 
void writeStats (Ostream &os) const
 
void write (const Time &, const word &surfName="") const
 Write to database. More...
 
void operator= (const MeshedSurface< Face > &)
 
 operator MeshedSurfaceProxy< Face > () const
 Conversion operator to MeshedSurfaceProxy. More...
 
template<class Face >
 MeshedSurface (const MeshedSurface< Face > &surf)
 
bool isTri ()
 Specialisation for holding triangulated information. More...
 
label triangulate ()
 Specialisation for holding triangulated information. More...
 
label triangulate (List< label > &faceMap)
 Specialisation for holding triangulated information. More...
 
- Public Member Functions inherited from PrimitivePatch<::Foam::List< Face >, pointField >
 PrimitivePatch (const ::Foam::List< Face > &faces, const Field< PointType > &points)
 Construct from components. More...
 
 PrimitivePatch (::Foam::List< Face > &&faces, Field< PointType > &&points)
 Move constructor from components. More...
 
 PrimitivePatch (::Foam::List< Face > &faces, Field< PointType > &points, const bool reuse)
 Construct from components, reuse storage. More...
 
 PrimitivePatch (const PrimitivePatch< ::Foam::List< Face >, pointField > &)
 Copy constructor. More...
 
 PrimitivePatch (PrimitivePatch< ::Foam::List< Face >, pointField > &&)
 Move constructor. More...
 
autoPtr< PrimitivePatch< ::Foam::List< Face >, pointField > > clone () const
 Construct and return a clone. More...
 
 ~PrimitivePatch ()
 Destructor. More...
 
const Field< PointType > & 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,. 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< FaceType > & localFaces () const
 Return patch faces addressing into local point list. More...
 
const labelListmeshPoints () 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< PointType > & 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
 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< PointType > & faceCentres () const
 Return face centres for patch. More...
 
const Field< PointType > & faceAreas () const
 Return face areas for patch. More...
 
const Field< PointType > & faceNormals () const
 Return face normals for patch. More...
 
const Field< PointType > & pointNormals () const
 Return point normals for patch. More...
 
List< objectHitprojectPoints (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm=intersection::algorithm::fullRay, const intersection::direction=intersection::direction::vector) const
 Project vertices of patch onto another patch. More...
 
Foam::List< Foam::objectHitprojectPoints (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
 
List< objectHitprojectFaceCentres (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm=intersection::algorithm::fullRay, const intersection::direction=intersection::direction::vector) const
 Project vertices of patch onto another patch. More...
 
Foam::List< Foam::objectHitprojectFaceCentres (const ToPatch &targetPatch, const Field< PointType > &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...
 
void clearOut ()
 
void clearGeom ()
 
void clearTopology ()
 
void clearPatchMeshAddr ()
 
void operator= (const PrimitivePatch< ::Foam::List< Face >, pointField > &)
 Assignment operator. More...
 
void operator= (PrimitivePatch< ::Foam::List< Face >, pointField > &&)
 Move assignment operator. More...
 
- Public Member Functions inherited from List< Face >
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const Face &)
 Construct with given size and value for all elements. More...
 
 List (const label, const zero)
 Construct with given size initialising all elements to zero. More...
 
 List (const List< Face > &)
 Copy constructor. More...
 
 List (const UList< T2 > &)
 Copy constructor from list containing another type. More...
 
 List (List< Face > &&)
 Move constructor. More...
 
 List (List< Face > &, bool reuse)
 Construct as copy or reuse as specified. More...
 
 List (const UList< Face > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
 List (const FixedList< Face, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< Face > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< Face > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< Face > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< Face > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (std::initializer_list< Face >)
 Construct from an initialiser list. More...
 
 List (Istream &)
 Construct from Istream. More...
 
label size () const
 Return the number of elements in the UList. More...
 
autoPtr< List< Face > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const Face &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const Face &)
 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 Face &)
 Append an element at the end of the list. More...
 
void append (const UList< Face > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< Face > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< Face > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (DynamicList< Face, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< Face > &)
 Transfer the contents of the argument List into this list. More...
 
Face & newElmt (const label)
 Return subscript-checked element of UList. More...
 
void shallowCopy (const UList< Face > &)=delete
 Disallow implicit shallowCopy. More...
 
void operator= (const UList< Face > &)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< Face > &)
 Assignment operator. Takes linear time. More...
 
void operator= (List< Face > &&)
 Move assignment operator. More...
 
void operator= (const SLList< Face > &)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< Face > &)
 Assignment to UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< Face > &)
 Assignment to BiIndirectList operator. Takes linear time. More...
 
void operator= (std::initializer_list< Face >)
 Assignment to an initialiser list. More...
 
void operator= (const Face &)
 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...
 
 UList (const UList< T > &)=default
 Copy construct. 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 Tcdata () const
 Return a const pointer to the first data element,. More...
 
Tdata ()
 Return a pointer to the first data element,. More...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () 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...
 
Toperator[] (const label)
 Return element of UList. More...
 
const Toperator[] (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...
 
const bool & operator[] (const label i) const
 

Static Public Member Functions

static autoPtr< MeshedSurface< Face > > New (const fileName &name)
 Read file and return surface. More...
 
static void writeAscii (const fileName &, const MeshedSurfaceProxy< Face > &)
 Write surface mesh components by proxy (as ASCII) More...
 
static void writeBinary (const fileName &, const MeshedSurfaceProxy< Face > &)
 Write surface mesh components by proxy (as BINARY) More...
 
static void write (const fileName &, const MeshedSurfaceProxy< Face > &)
 Write surface mesh components by proxy. More...
 
static void writeAscii (const fileName &, const UnsortedMeshedSurface< Face > &)
 Write UnsortedMeshedSurface (as ASCII) sorted by zone. More...
 
static void writeBinary (const fileName &, const UnsortedMeshedSurface< Face > &)
 Write UnsortedMeshedSurface (as BINARY) unsorted by zone. More...
 
static void write (const fileName &, const UnsortedMeshedSurface< Face > &)
 Write UnsortedMeshedSurface. More...
 
- Static Public Member Functions inherited from MeshedSurface< Face >
static bool isTri ()
 Face storage only handles triangulated faces. More...
 
static bool canRead (const fileName &, 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 wordHashSet readTypes ()
 
static wordHashSet writeTypes ()
 
static autoPtr< MeshedSurfaceNew (const fileName &, const word &ext)
 Select constructed from filename (explicit extension) More...
 
static autoPtr< MeshedSurfaceNew (const fileName &)
 Select constructed from filename (implicit extension) More...
 
static void write (const fileName &, const MeshedSurface< Face > &)
 Write to file. More...
 
- Static Public Member Functions inherited from List< Face >
static const List< Face > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< T >
static const UList< T > & null ()
 Return a null UList. More...
 
- Static Public Member Functions inherited from surfaceFormatsCore
static bool checkSupport (const wordHashSet &available, const word &ext, const bool verbose, const word &functionName)
 ... More...
 

Additional Inherited Members

- Public Types inherited from MeshedSurface< Face >
typedef Face FaceType
 Face type used. More...
 
- Public Types inherited from PrimitivePatch<::Foam::List< Face >, pointField >
enum  surfaceTopo
 Enumeration defining the surface type. Used in check routines. More...
 
typedef ::Foam::List< Face > FaceListType
 
typedef std::remove_reference< ::Foam::List< Face > >::type::value_type FaceType
 
typedef pointField PointFieldType
 
typedef std::remove_reference< pointField >::type::value_type PointType
 
- Public Types inherited from List< Face >
typedef SubList< Face > subList
 Declare type of subList. More...
 
- Public Types inherited from UList< T >
typedef T value_type
 Type of values the UList contains. More...
 
typedef Treference
 Type that can be used for storing into. More...
 
typedef const Tconst_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 Titerator
 Random access iterator for traversing UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing UList. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 
- Static Public Attributes inherited from surfaceFormatsCore
static word nativeExt
 The file extension corresponding to 'native' surface format. More...
 
- Protected Member Functions inherited from MeshedSurface< Face >
void transcribe (MeshedSurface< face > &)
 Transfer points/zones and transcribe face -> triFace. More...
 
void checkZones ()
 Basic sanity check on zones. More...
 
pointFieldstoredPoints ()
 Non-const access to global points. More...
 
List< Face > & storedFaces ()
 Non-const access to the faces. More...
 
surfZoneListstoredZones ()
 Non-const access to the zones. More...
 
void sortFacesAndStore (List< Face > &&unsortedFaces, List< label > &&zoneIds, const bool sorted)
 Sort faces by zones and store sorted faces. More...
 
virtual void remapFaces (const labelUList &faceMap)
 Set new zones from faceMap. More...
 
void transcribe (MeshedSurface< face > &surf)
 
void transcribe (MeshedSurface< face > &surf)
 
- Protected Member Functions inherited from List< Face >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 
- Static Protected Member Functions inherited from surfaceFormatsCore
template<class Container >
static List< surfZoneoneZone (const Container &container, const word &name="zone0")
 Return a list with a single entry,. More...
 
static string getLineNoComment (IFstream &)
 Read non-comment line. More...
 

Detailed Description

template<class Face>
class Foam::fileFormats::STLsurfaceFormat< Face >

Provide a means of reading/writing STL files (ASCII and binary).

Note: For efficiency, the zones are sorted before creating the faces. The class is thus derived from MeshedSurface.

Source files

Definition at line 59 of file STLsurfaceFormat.H.

Constructor & Destructor Documentation

◆ STLsurfaceFormat() [1/2]

STLsurfaceFormat ( const fileName filename)

Construct from file name.

Definition at line 112 of file STLsurfaceFormat.C.

References Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ STLsurfaceFormat() [2/2]

STLsurfaceFormat ( const STLsurfaceFormat< Face > &  )
delete

Disallow default bitwise copy construction.

◆ ~STLsurfaceFormat()

virtual ~STLsurfaceFormat ( )
inlinevirtual

Destructor.

Definition at line 107 of file STLsurfaceFormat.H.

Member Function Documentation

◆ New()

static autoPtr<MeshedSurface<Face> > New ( const fileName name)
inlinestatic

Read file and return surface.

Definition at line 97 of file STLsurfaceFormat.H.

References Foam::name().

Here is the call graph for this function:

◆ writeAscii() [1/2]

◆ writeBinary() [1/2]

void writeBinary ( const fileName filename,
const MeshedSurfaceProxy< Face > &  surf 
)
static

◆ write() [1/3]

void write ( const fileName filename,
const MeshedSurfaceProxy< Face > &  surf 
)
static

Write surface mesh components by proxy.

as ASCII or BINARY, depending on the extension

Definition at line 425 of file STLsurfaceFormat.C.

References fileName::ext().

Referenced by STLsurfaceFormat< Face >::write().

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

◆ writeAscii() [2/2]

◆ writeBinary() [2/2]

void writeBinary ( const fileName filename,
const UnsortedMeshedSurface< Face > &  surf 
)
static

◆ write() [2/3]

void write ( const fileName filename,
const UnsortedMeshedSurface< Face > &  surf 
)
static

Write UnsortedMeshedSurface.

as ASCII or BINARY, depending on the extension

Definition at line 446 of file STLsurfaceFormat.C.

References fileName::ext().

Here is the call graph for this function:

◆ read()

◆ write() [3/3]

virtual void write ( const fileName name) const
inlinevirtual

Write object.

Reimplemented from MeshedSurface< Face >.

Definition at line 153 of file STLsurfaceFormat.H.

References Foam::name(), and STLsurfaceFormat< Face >::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const STLsurfaceFormat< Face > &  )
delete

Disallow default bitwise assignment.


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