MeshedSurface< Face > Class Template Reference

A surface geometry mesh with zone information, not to be confused with the similarly named surfaceMesh, which actually refers to the cell faces of a volume mesh. More...

Inheritance diagram for MeshedSurface< Face >:
[legend]
Collaboration diagram for MeshedSurface< Face >:
[legend]

Public Types

typedef Face face_type
 The face type (same as the underlying PrimitivePatch) More...
 
typedef point point_type
 The point type (same as the underlying PrimitivePatch) More...
 
- Public Types inherited from PrimitivePatch<::Foam::List< Face >, pointField >
enum  surfaceTopo
 Enumeration defining the surface type. Used in check routines. More...
 
typedef std::remove_reference< ::Foam::List< Face > >::type::value_type face_type
 The face type. More...
 
typedef std::remove_reference< pointField >::type::value_type point_type
 The point type. More...
 
typedef ::Foam::List< Face > FaceListType
 The face list type. More...
 
typedef pointField PointFieldType
 The point field type. More...
 
typedef face_type FaceType
 Deprecated(2020-03) prefer face_type typedef. More...
 
- 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
 The value type the list contains. More...
 
typedef Tpointer
 The pointer type for non-const access to value_type items. More...
 
typedef const Tconst_pointer
 The pointer type for const access to value_type items. More...
 
typedef Treference
 The type used for storing into value_type objects. More...
 
typedef const Tconst_reference
 The type used for reading from constant value_type objects. More...
 
typedef Titerator
 Random access iterator for traversing a UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing a UList. More...
 
typedef label size_type
 The type to represent the size of a UList. More...
 
typedef label difference_type
 The difference between iterator objects. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator (non-const access) More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator (const access) More...
 

Public Member Functions

 ClassName ("MeshedSurface")
 Declare type-name (with debug switch) More...
 
 MeshedSurface ()
 Default construct, an empty surface. More...
 
 MeshedSurface (const MeshedSurface &surf)
 Copy construct. More...
 
 MeshedSurface (const UnsortedMeshedSurface< Face > &surf)
 Copy construct from an UnsortedMeshedSurface. More...
 
 MeshedSurface (MeshedSurface &&surf)
 Move construct. More...
 
 MeshedSurface (UnsortedMeshedSurface< Face > &&surf)
 Move construct from an UnsortedMeshedSurface. More...
 
 MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const UList< surfZone > &zoneLst)
 Copy construct from components (points, faces, zones). More...
 
 MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const UList< surfZone > &zoneLst)
 Move construct from components (points, faces). More...
 
 MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
 Copy construct from components (points, faces). More...
 
 MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
 Move construct from components (points, faces). More...
 
 MeshedSurface (const polyBoundaryMesh &bMesh, const bool globalPoints=false)
 Construct from a boundary mesh with local points/faces. More...
 
 MeshedSurface (const surfMesh &mesh)
 Construct from a surfMesh. More...
 
 MeshedSurface (const fileName &name)
 Construct from file name (uses extension to determine type) More...
 
 MeshedSurface (const fileName &name, const word &fileType)
 Construct from file name and given file type. More...
 
 MeshedSurface (Istream &is)
 Construct from Istream. More...
 
 MeshedSurface (const Time &runTime)
 Construct from database (as surfMesh) with default name. More...
 
 MeshedSurface (const Time &runTime, const word &surfName)
 Construct from database (as surfMesh) with given surface name. More...
 
 MeshedSurface (const IOobject &io, const dictionary &dict, const bool isGlobal=true)
 Read construct using IO to find the file location. 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, IOstreamOption streamOpt, const dictionary &options),(name, surf, streamOpt, options))
 
label size () const
 The surface size is the number of faces. More...
 
const List< Face > & surfFaces () const
 Return const access to the faces. More...
 
const labelListfaceIds () const
 Return const access to faces ids. More...
 
const surfZoneListsurfZones () const
 Const access to the surface zones. More...
 
const vectorFieldSf () const
 Face area vectors (normals) More...
 
const scalarFieldmagSf () const
 Face area magnitudes. More...
 
const vectorFieldCf () const
 Face centres. More...
 
virtual void clear ()
 Clear all storage. 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...
 
bool addZonesToFaces ()
 Propagate zone information on face regions. More...
 
virtual void removeZones ()
 Remove surface zones. More...
 
virtual void movePoints (const pointField &newPoints)
 Move points. More...
 
virtual void scalePoints (const scalar scaleFactor)
 Scale points. A non-positive factor is ignored. More...
 
virtual void cleanup (const bool verbose)
 Remove invalid faces. More...
 
virtual void compactPoints (labelList &pointMap=const_cast< labelList & >(labelList::null()))
 Remove unused points and renumber faces in local visit order. More...
 
virtual bool stitchFaces (const scalar tol=SMALL, const bool verbose=false)
 
virtual bool checkFaces (const bool verbose=false)
 
virtual label nTriangles () const
 Count number of triangles. More...
 
virtual label nTriangles (labelList &faceMap) const
 Count number of triangles, returning a face map of original ids. More...
 
virtual label triangulate ()
 Triangulate in-place, returning the number of triangles added. More...
 
virtual label triangulate (labelList &faceMap)
 Triangulate in-place, returning the number of triangles added. More...
 
template<class BoolListType >
void subsetMeshMap (const BoolListType &include, labelList &pointMap, labelList &faceMap) const
 Create mappings for a sub-surface. More...
 
MeshedSurface subsetMesh (const UList< bool > &include, labelList &pointMap, labelList &faceMap) const
 Return a new surface subsetted on the selected faces. More...
 
MeshedSurface subsetMesh (const bitSet &include, labelList &pointMap, labelList &faceMap) const
 Return a new surface subsetted on the selected faces. More...
 
MeshedSurface subsetMesh (const UList< bool > &include) const
 Return a new surface subsetted on the selected faces. More...
 
MeshedSurface subsetMesh (const bitSet &include) const
 Return a new surface subsetted on the selected faces. More...
 
MeshedSurface subsetMesh (const wordRes &includeNames, const wordRes &excludeNames=wordRes()) const
 Return a new surface subsetted on the selected zone names. More...
 
void swap (MeshedSurface< Face > &surf)
 Swap contents. More...
 
void transfer (pointField &pointLst, List< Face > &faceLst)
 Transfer the components. More...
 
void transfer (MeshedSurface< Face > &surf)
 Transfer the contents of the argument and annul the argument. More...
 
void transfer (UnsortedMeshedSurface< Face > &surf)
 Transfer the contents of the argument and annul the argument. More...
 
autoPtr< MeshedSurface< Face > > releaseGeom ()
 Release (clear) geometry and return for reuse. More...
 
void swapFaces (List< Face > &faces)
 Swap the stored faces. Use with caution. More...
 
void swapPoints (pointField &points)
 Swap the stored points. More...
 
bool read (const fileName &name, const word &fileType)
 Read from file. Chooses reader based on explicit extension. More...
 
virtual bool read (const fileName &name)
 Read from file. Chooses reader based on detected extension. More...
 
void writeStats (Ostream &os) const
 
virtual void write (const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const
 Generic write routine. Chooses writer based on extension. More...
 
virtual void write (const fileName &name, const word &fileType, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const
 Generic write routine for given format type. More...
 
void write (const Time &runTime, const word &surfName=word::null) const
 Write to database. More...
 
void operator= (const MeshedSurface< Face > &surf)
 Copy assignment. More...
 
void operator= (MeshedSurface< Face > &&surf)
 Move assignment. More...
 
 operator MeshedSurfaceProxy< Face > () const
 Conversion operator to MeshedSurfaceProxy. More...
 
template<class Face >
 MeshedSurface (const MeshedSurface< Face > &surf)
 
template<class Face >
 MeshedSurface (MeshedSurface< Face > &&surf)
 
bool addZonesToFaces ()
 Specialization for labelledTri. More...
 
bool addZonesToFaces ()
 
- Public Member Functions inherited from PrimitivePatch<::Foam::List< Face >, pointField >
 PrimitivePatch (const ::Foam::List< Face > &faces, const pointField &points)
 Construct from components. More...
 
 PrimitivePatch (::Foam::List< Face > &&faces, const pointField &points)
 Construct from components, transferring faces. More...
 
 PrimitivePatch (::Foam::List< Face > &faces, pointField &points, const bool reuse)
 Construct from components, reuse storage. More...
 
 PrimitivePatch (const PrimitivePatch< ::Foam::List< Face >, pointField > &pp)
 Copy construct. 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_type > & points () const noexcept
 Return reference to global points. More...
 
label nFaces () const noexcept
 Number of faces in the patch. More...
 
label nPoints () const
 Number of points supporting patch faces. More...
 
label nEdges () const
 Number of edges in patch. More...
 
const edgeListedges () const
 Return list of edges, address into LOCAL point list. More...
 
const edgeList::subList internalEdges () const
 Return sub-list of internal edges, address into LOCAL point list. More...
 
const edgeList::subList boundaryEdges () const
 Return sub-list of boundary edges, address into LOCAL point list. More...
 
label nInternalEdges () const
 Number of internal edges. More...
 
label nBoundaryEdges () const
 Number of boundary edges == (nEdges() - nInternalEdges()) 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< face_type > & localFaces () const
 Return patch faces addressing into local point list. More...
 
labelList boundaryFaces () const
 
labelList uniqBoundaryFaces () const
 
const labelListmeshPoints () const
 Return labelList of mesh points in patch. More...
 
const Map< label > & meshPointMap () const
 Mesh point map. More...
 
const Field< point_type > & 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...
 
edge meshEdge (const label edgei) const
 From patch edge to global edge using meshPoints. More...
 
edge meshEdge (const edge &e) const
 From patch edge to global edge using meshPoints. More...
 
label meshEdge (const label edgei, const edgeList &allEdges, const labelListList &pointEdges) const
 
label findEdge (const edge &e) const
 
labelList meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
 
labelList meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
 
labelList meshEdges (const labelUList &edgeLabels, const edgeList &allEdges, const labelListList &pointEdges) const
 
const Field< point_type > & faceCentres () const
 Return face centres for patch. More...
 
const Field< point_type > & faceAreas () const
 Return face area vectors for patch. More...
 
const Field< scalar > & magFaceAreas () const
 Return face area magnitudes for patch. More...
 
const Field< point_type > & faceNormals () const
 Return face unit normals for patch. More...
 
const Field< point_type > & pointNormals () const
 Return point normals for patch. More...
 
bool hasFaceAreas () const
 
bool hasFaceCentres () const
 
bool hasFaceNormals () const
 
bool hasPointNormals () const
 
bool hasBoundaryPoints () const
 
bool hasEdges () const
 
bool hasFaceFaces () const
 
bool hasEdgeFaces () const
 
bool hasFaceEdges () const
 
bool hasPointEdges () const
 
bool hasPointFaces () const
 
bool hasMeshPointMap () const
 
List< objectHitprojectPoints (const ToPatch &targetPatch, const Field< point_type > &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< typename Foam::PrimitivePatch< ::Foam::List< Face >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
 
List< objectHitprojectFaceCentres (const ToPatch &targetPatch, const Field< point_type > &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< typename Foam::PrimitivePatch< ::Foam::List< Face >, pointField >::point_type > &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_type > &)
 Correct patch after moving points. More...
 
void operator= (const PrimitivePatch< ::Foam::List< Face >, pointField > &rhs)
 Copy assign faces. Leave points alone (could be a reference). More...
 
void operator= (PrimitivePatch< ::Foam::List< Face >, pointField > &&rhs)
 Move assign faces. Leave points alone (could be a reference). More...
 
label whichEdge (const edge &e) const
 Identical to findEdge. More...
 
- Public Member Functions inherited from PrimitivePatchBase
 ClassName ("PrimitivePatch")
 Runtime type information. More...
 
 PrimitivePatchBase ()=default
 Default construct. More...
 
- Public Member Functions inherited from List< Face >
constexpr List () noexcept
 Default construct. More...
 
 List (const label len)
 Construct with given size. More...
 
 List (const label len, const Face &val)
 Construct with given size and value for all elements. More...
 
 List (const label len, const Foam::zero)
 Construct with given size initializing all elements to zero. More...
 
 List (const Foam::one, const Face &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const Foam::one, Face &&val)
 Construct with length=1, moving the value as the only content. More...
 
 List (const Foam::one, const Foam::zero)
 Construct with length=1, initializing content to zero. More...
 
 List (const List< Face > &a)
 Copy construct from list. More...
 
 List (const UList< Face > &a)
 Copy construct contents from list. More...
 
 List (List< Face > &a, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< Face > &list, const labelUList &indices)
 Copy construct subset of list. More...
 
 List (const UList< Face > &list, const FixedList< label, N > &indices)
 Copy construct subset of list. More...
 
 List (const FixedList< Face, N > &list)
 Construct as copy of FixedList<T, N> More...
 
 List (const PtrList< Face > &list)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< Face > &list)
 Construct as copy of SLList<T> More...
 
 List (const IndirectListBase< Face, Addr > &list)
 Construct as copy of IndirectList contents. More...
 
 List (std::initializer_list< Face > list)
 Construct from an initializer list. More...
 
 List (List< Face > &&list)
 Move construct from List. More...
 
 List (DynamicList< Face, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (SLList< Face > &&list)
 Move construct from SLList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
autoPtr< List< Face > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void resize (const label len)
 Adjust allocated size of list. More...
 
void resize (const label len, const Face &val)
 Adjust allocated size of list and set val for new elements. More...
 
void resize (const label newLen)
 
void resize_nocopy (const label len)
 Adjust allocated size of list without necessarily. More...
 
void setSize (const label n)
 Alias for resize() More...
 
void setSize (const label n, const Face &val)
 Alias for resize() More...
 
void append (const Face &val)
 Append an element at the end of the list. More...
 
void append (Face &&val)
 Move append an element at the end of the list. More...
 
void append (const UList< Face > &list)
 Append a List to the end of this list. More...
 
void append (const IndirectListBase< Face, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label appendUniq (const Face &val)
 Append an element if not already in the list. More...
 
void transfer (List< Face > &list)
 
void transfer (DynamicList< Face, SizeMin > &list)
 
Face & newElmt (const label i)
 
void operator= (const UList< Face > &a)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< Face > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< Face > &list)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const IndirectListBase< Face, Addr > &list)
 Assignment from IndirectList. Takes linear time. More...
 
void operator= (const FixedList< Face, N > &list)
 Copy assignment from FixedList. More...
 
void operator= (std::initializer_list< Face > list)
 Assignment to an initializer list. More...
 
void operator= (const Face &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
void operator= (List< Face > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (DynamicList< Face, SizeMin > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SLList< Face > &&list)
 Move assignment. Takes constant time. More...
 
IstreamreadList (Istream &is)
 Read List from Istream, discarding contents of existing List. More...
 
IstreamreadList (Istream &is)
 
IstreamreadList (Istream &is)
 
void shallowCopy (const UList< Face > &)=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...
 
- Public Member Functions inherited from UList< T >
 UList (const UList< T > &)=default
 Copy construct. More...
 
constexpr UList () noexcept
 Default construct, zero-sized and nullptr. More...
 
 UList (T *__restrict__ v, const label len) noexcept
 Construct from components. More...
 
label fcIndex (const label i) const noexcept
 
label rcIndex (const label i) const noexcept
 
const TfcValue (const label i) const
 Return forward circular value (ie, next value in the list) More...
 
TfcValue (const label i)
 Return forward circular value (ie, next value in the list) More...
 
const TrcValue (const label i) const
 Return reverse circular value (ie, previous value in the list) More...
 
TrcValue (const label i)
 Return reverse circular value (ie, previous value in the list) More...
 
const Tcdata () const noexcept
 Return pointer to the underlying array serving as data storage. More...
 
Tdata () noexcept
 Return pointer to the underlying array serving as data storage. More...
 
const char * cdata_bytes () const noexcept
 Return pointer to the underlying array serving as data storage,. More...
 
char * data_bytes () noexcept
 Return pointer to the underlying array serving as data storage,. 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...
 
std::streamsize size_bytes () const noexcept
 Number of contiguous bytes for the List data. More...
 
std::streamsize byteSize () const
 
void checkStart (const label start) const
 Check start is within valid range [0,size) More...
 
void checkSize (const label size) const
 Check size is within valid range [0,size]. More...
 
void checkRange (const label start, const label len) const
 Check that start and length define a valid range. More...
 
void checkIndex (const label i) const
 Check index is within valid range [0,size) More...
 
bool uniform () const
 True if all entries have identical values, and list is non-empty. More...
 
label find (const T &val, label pos=0) const
 Find index of the first occurrence of the value. More...
 
label rfind (const T &val, label pos=-1) const
 Find index of the last occurrence of the value. More...
 
bool found (const T &val, label pos=0) const
 True if the value if found in the list. More...
 
void moveFirst (const label i)
 Move element to the first position. More...
 
void moveLast (const label i)
 Move element to the last position. More...
 
void swapFirst (const label i)
 Swap element with the first element. Fatal on an empty list. More...
 
void swapLast (const label i)
 Swap element with the last element. Fatal on an empty list. More...
 
void shallowCopy (const UList< T > &list)
 Copy the pointer and size held by the given UList. More...
 
void deepCopy (const UList< T > &list)
 Copy elements of the given UList. Sizes must match! More...
 
template<class Addr >
void deepCopy (const IndirectListBase< T, Addr > &list)
 Copy elements of the given indirect list. Sizes must match! More...
 
SubList< Tslice (const label pos, label len=-1)
 Return SubList slice (non-const access) - no range checking. More...
 
const SubList< Tslice (const label pos, label len=-1) const
 Return SubList slice (const access) - no range checking. More...
 
SubList< Tslice (const labelRange &range)
 Return SubList slice (non-const access) - with range checking. More...
 
const SubList< Tslice (const labelRange &range) const
 Return SubList slice (const access) - with range checking. More...
 
Toperator[] (const label i)
 Return element of UList. More...
 
const Toperator[] (const label i) 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 &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
iterator begin () noexcept
 Return an iterator to begin traversing the UList. More...
 
iterator end () noexcept
 Return an iterator to end traversing the UList. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () const noexcept
 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 noexcept
 The number of elements in the UList. More...
 
bool empty () const noexcept
 True if the UList is empty (ie, size() is zero) More...
 
void swap (UList< T > &list)
 Swap content with another UList of the same type in constant time. More...
 
bool operator== (const UList< T > &a) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &a) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &list) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &a) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &a) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &a) const
 Return true if !(a < b). Takes linear time. More...
 
IstreamreadList (Istream &is)
 Read List contents from Istream. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the List as a dictionary entry with keyword. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write List, with line-breaks in ASCII when length exceeds shortLen. More...
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type test (const label i) const
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type get (const label i) const
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type unset (const label i)
 
IstreamreadList (Istream &is)
 
OstreamwriteList (Ostream &os, const label) const
 
const booloperator[] (const label i) const
 
Foam::UPstream::commsStructoperator[] (const label procID)
 
const Foam::UPstream::commsStructoperator[] (const label procID) const
 
UPstream::commsStructoperator[] (const label procID)
 
const UPstream::commsStructoperator[] (const label procID) const
 
OstreamwriteList (Ostream &os, const label) const
 
IstreamreadList (Istream &is)
 
- Public Member Functions inherited from surfaceFormatsCore
 surfaceFormatsCore ()=default
 Default construct. More...
 
virtual ~surfaceFormatsCore ()=default
 Destructor. More...
 

Static Public Member Functions

static wordHashSet readTypes ()
 Known readable file-types, without friends or proxies. More...
 
static wordHashSet writeTypes ()
 Known writable file-types, without friends or proxies. More...
 
static bool canReadType (const word &fileType, bool verbose=false)
 Can we read this file format? Also checks friend types. More...
 
static bool canWriteType (const word &fileType, bool verbose=false)
 Can we write this file format? Also checks proxy types. More...
 
static bool canRead (const fileName &name, bool verbose=false)
 Can we read this file format? More...
 
static autoPtr< MeshedSurfaceNew (const fileName &name, const word &fileType, bool mandatory=true)
 Read construct from filename with given file type. More...
 
static autoPtr< MeshedSurfaceNew (const fileName &name)
 Read construct from filename (file type implicit from extension) More...
 
static void write (const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
 Write to file, selecting writer based on its extension. More...
 
static void write (const fileName &name, const word &fileType, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
 Write to file, selecting writer based on the given extension. 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 UList reference to a nullObject. More...
 
static constexpr label max_size () noexcept
 The size of the largest possible UList. More...
 
- Static Public Member Functions inherited from surfaceFormatsCore
static bool checkSupport (const wordHashSet &available, const word &fileType, const bool verbose=false, const char *functionName=nullptr)
 Verbose checking of fileType in the list of available types. More...
 
static fileName findFile (const IOobject &io, const bool isGlobal=true)
 
static fileName findFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true)
 

Protected Member Functions

void transcribe (MeshedSurface< face > &surf)
 Transfer points/zones from 'face' to other other shapes. More...
 
void checkZones (const bool verbose=true)
 Sanity check/resizing on zones. More...
 
pointFieldstoredPoints ()
 Non-const access to global points. More...
 
List< Face > & storedFaces ()
 Non-const access to the faces. More...
 
labelListstoredFaceIds ()
 Non-const access to face ids. More...
 
surfZoneListstoredZones ()
 Non-const access to the zones. More...
 
void sortFacesAndStore (DynamicList< Face > &unsortedFaces, DynamicList< label > &zoneIds, DynamicList< label > &elemIds, bool sorted)
 Sort faces by zones and store sorted faces. More...
 
virtual void remapFaces (const labelUList &faceMapNewToOld)
 Set new zones from faceMap. More...
 
void transcribe (MeshedSurface< face > &surf)
 
void transcribe (MeshedSurface< face > &surf)
 
void transcribe (MeshedSurface< face > &surf)
 
- Protected Member Functions inherited from UList< T >
void setAddressableSize (const label n) noexcept
 Set addressed size to be inconsistent with allocated storage. More...
 
void size (const label n)
 Older name for setAddressableSize. More...
 
void writeEntry (Ostream &os) const
 Write the UList with its compound type. More...
 
labelRange validateRange (const labelRange &requestedRange) const
 
UList< T > & operator= (const UList< T > &)=delete
 No copy assignment (default: shallow copy) More...
 
void writeEntry (Ostream &os) const
 
void writeEntry (Ostream &os) const
 

Friends

template<class Face2 >
class MeshedSurface
 
template<class Face2 >
class UnsortedMeshedSurface
 
class surfMesh
 
Istreamoperator>> (Istream &is, MeshedSurface< Face > &surf)
 Read MeshedSurface from Istream. More...
 
Ostreamoperator (Ostream &os, const MeshedSurface< Face > &surf)
 Write MeshedSurface to Ostream. More...
 

Additional Inherited Members

- Static Public Attributes inherited from surfaceFormatsCore
static word nativeExt
 The file extension corresponding to 'native' surface format. More...
 
- Static Protected Member Functions inherited from surfaceFormatsCore
static string getLineNoComment (ISstream &is, const char comment='#')
 Read non-empty and non-comment line. More...
 
template<class Container >
static List< surfZoneoneZone (const Container &container, const word &name="zone0")
 
static labelList getSelectedPatches (const surfZoneList &patches, const wordRes &allow, const wordRes &deny=wordRes())
 Return ids for zone/patch that match by name. More...
 
static fileName relativeFilePath (const IOobject &io, const fileName &f, const bool isGlobal=true)
 Return fileName. More...
 
static fileName checkFile (const IOobject &io, const bool isGlobal=true)
 Return fileName to load IOobject from. More...
 
static fileName checkFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true)
 Return fileName to load IOobject from. More...
 

Detailed Description

template<class Face>
class Foam::MeshedSurface< Face >

A surface geometry mesh with zone information, not to be confused with the similarly named surfaceMesh, which actually refers to the cell faces of a volume mesh.

A MeshedSurface can have zero or more surface zones (roughly equivalent to faceZones for a polyMesh). If surface zones are defined, they must be contiguous and cover all of the faces.

The MeshedSurface is intended for surfaces from a variety of sources.

  • A set of points and faces without any surface zone information.
  • A set of points and faces with randomly ordered zone information. This could arise, for example, from reading external file formats such as STL, etc.
Source files

Definition at line 95 of file MeshedSurface.H.

Member Typedef Documentation

◆ face_type

typedef Face face_type

The face type (same as the underlying PrimitivePatch)

Definition at line 208 of file MeshedSurface.H.

◆ point_type

typedef point point_type

The point type (same as the underlying PrimitivePatch)

Definition at line 211 of file MeshedSurface.H.

Constructor & Destructor Documentation

◆ MeshedSurface() [1/19]

Default construct, an empty surface.

Definition at line 183 of file MeshedSurface.C.

◆ MeshedSurface() [2/19]

MeshedSurface ( const MeshedSurface< Face > &  surf)

Copy construct.

◆ MeshedSurface() [3/19]

MeshedSurface ( const UnsortedMeshedSurface< Face > &  surf)

Copy construct from an UnsortedMeshedSurface.

Definition at line 204 of file MeshedSurface.C.

References Foam::faceMap(), UList< T >::size(), UnsortedMeshedSurface< Face >::sortedZones(), and MeshedSurface< Face >::storedZones().

Here is the call graph for this function:

◆ MeshedSurface() [4/19]

MeshedSurface ( MeshedSurface< Face > &&  surf)

Move construct.

◆ MeshedSurface() [5/19]

MeshedSurface ( UnsortedMeshedSurface< Face > &&  surf)

Move construct from an UnsortedMeshedSurface.

Definition at line 259 of file MeshedSurface.C.

◆ MeshedSurface() [6/19]

MeshedSurface ( const pointField pointLst,
const UList< Face > &  faceLst,
const UList< surfZone > &  zoneLst 
)

Copy construct from components (points, faces, zones).

Definition at line 271 of file MeshedSurface.C.

◆ MeshedSurface() [7/19]

MeshedSurface ( pointField &&  pointLst,
List< Face > &&  faceLst,
const UList< surfZone > &  zoneLst 
)

Move construct from components (points, faces).

Zone information is fairly lightweight and is copied.

Definition at line 287 of file MeshedSurface.C.

◆ MeshedSurface() [8/19]

MeshedSurface ( const pointField pointLst,
const UList< Face > &  faceLst,
const labelUList zoneSizes = labelUList(),
const UList< word > &  zoneNames = UList<word>() 
)

Copy construct from components (points, faces).

Use zone information if available

Definition at line 303 of file MeshedSurface.C.

◆ MeshedSurface() [9/19]

MeshedSurface ( pointField &&  pointLst,
List< Face > &&  faceLst,
const labelUList zoneSizes = labelUList(),
const UList< word > &  zoneNames = UList<word>() 
)

Move construct from components (points, faces).

Use zone information if available

Definition at line 330 of file MeshedSurface.C.

References MeshedSurface< Face >::addZones(), and UList< T >::size().

Here is the call graph for this function:

◆ MeshedSurface() [10/19]

MeshedSurface ( const polyBoundaryMesh bMesh,
const bool  globalPoints = false 
)

Construct from a boundary mesh with local points/faces.

Definition at line 374 of file MeshedSurface.C.

References mesh.

◆ MeshedSurface() [11/19]

MeshedSurface ( const surfMesh mesh)
explicit

Construct from a surfMesh.

Definition at line 357 of file MeshedSurface.C.

◆ MeshedSurface() [12/19]

MeshedSurface ( const fileName name)
explicit

Construct from file name (uses extension to determine type)

Definition at line 455 of file MeshedSurface.C.

◆ MeshedSurface() [13/19]

MeshedSurface ( const fileName name,
const word fileType 
)
explicit

Construct from file name and given file type.

If the format type is "", uses the file extension.

Definition at line 442 of file MeshedSurface.C.

References Foam::name().

Here is the call graph for this function:

◆ MeshedSurface() [14/19]

MeshedSurface ( Istream is)
explicit

Construct from Istream.

Definition at line 464 of file MeshedSurface.C.

◆ MeshedSurface() [15/19]

MeshedSurface ( const Time runTime)
explicit

Construct from database (as surfMesh) with default name.

Definition at line 473 of file MeshedSurface.C.

◆ MeshedSurface() [16/19]

MeshedSurface ( const Time runTime,
const word surfName 
)

Construct from database (as surfMesh) with given surface name.

Definition at line 483 of file MeshedSurface.C.

References mesh.

◆ MeshedSurface() [17/19]

MeshedSurface ( const IOobject io,
const dictionary dict,
const bool  isGlobal = true 
)

Read construct using IO to find the file location.

Dictionary may contain the following entries:

  • file = alternative file name (default is dictionary name)
  • fileType = file format (default is from file extension)
  • scale (eg, 0.001: mm to m)
Parameters
isGlobalresolve as a global file

Definition at line 516 of file MeshedSurface.C.

◆ ~MeshedSurface()

~MeshedSurface
virtual

Destructor.

Definition at line 539 of file MeshedSurface.C.

References clear().

Here is the call graph for this function:

◆ MeshedSurface() [18/19]

MeshedSurface ( const MeshedSurface< Face > &  surf)

Definition at line 192 of file MeshedSurface.C.

◆ MeshedSurface() [19/19]

MeshedSurface ( MeshedSurface< Face > &&  surf)

Definition at line 247 of file MeshedSurface.C.

Member Function Documentation

◆ transcribe() [1/4]

void transcribe ( MeshedSurface< face > &  surf)
protected

Transfer points/zones from 'face' to other other shapes.

Eg, transcribe face to triFace, or face -> labelledTri, including any addZonesToFaces adjustment. No general form, only specializations.

◆ checkZones()

void checkZones ( const bool  verbose = true)
protected

Sanity check/resizing on zones.

Adjust zones so that they cover the number of faces The last zone will be extended as needed

Definition at line 35 of file MeshedSurfaceZones.C.

References Foam::nl, surfZone::size(), surfZone::start(), and WarningInFunction.

Here is the call graph for this function:

◆ storedPoints()

pointField & storedPoints ( )
inlineprotected

Non-const access to global points.

Definition at line 167 of file MeshedSurface.H.

References PrimitivePatch<::Foam::List< Face >, pointField >::points().

Referenced by MeshedSurface< Face >::swap(), UnsortedMeshedSurface< Face >::swap(), MeshedSurface< Face >::transcribe(), MeshedSurface< Face >::transfer(), polySurface::transfer(), surfMesh::transfer(), and UnsortedMeshedSurface< Face >::transfer().

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

◆ storedFaces()

List< Face > & storedFaces ( )
inlineprotected

Non-const access to the faces.

Definition at line 173 of file MeshedSurface.H.

Referenced by MeshedSurface< Face >::swap(), UnsortedMeshedSurface< Face >::swap(), MeshedSurface< Face >::transfer(), polySurface::transfer(), surfMesh::transfer(), and UnsortedMeshedSurface< Face >::transfer().

Here is the caller graph for this function:

◆ storedFaceIds()

labelList & storedFaceIds ( )
inlineprotected

Non-const access to face ids.

Definition at line 179 of file MeshedSurface.H.

Referenced by MeshedSurface< Face >::swap(), and MeshedSurface< Face >::transfer().

Here is the caller graph for this function:

◆ storedZones()

surfZoneList & storedZones ( )
inlineprotected

Non-const access to the zones.

Definition at line 185 of file MeshedSurface.H.

Referenced by MeshedSurface< Face >::MeshedSurface(), MeshedSurface< Face >::swap(), UnsortedMeshedSurface< Face >::swap(), MeshedSurface< Face >::transcribe(), MeshedSurface< Face >::transfer(), and surfMesh::transfer().

Here is the caller graph for this function:

◆ sortFacesAndStore()

void sortFacesAndStore ( DynamicList< Face > &  unsortedFaces,
DynamicList< label > &  zoneIds,
DynamicList< label > &  elemIds,
bool  sorted 
)
protected

Sort faces by zones and store sorted faces.

Definition at line 90 of file MeshedSurfaceZones.C.

References DynamicList< T, SizeMin >::clear(), Foam::faceMap(), forAll, UList< T >::size(), and Foam::sortedOrder().

Here is the call graph for this function:

◆ remapFaces()

void remapFaces ( const labelUList faceMapNewToOld)
protectedvirtual

Set new zones from faceMap.

Reimplemented in cuttingSurfaceBase, and UnsortedMeshedSurface< Face >.

Definition at line 548 of file MeshedSurface.C.

References UList< T >::empty().

Here is the call graph for this function:

◆ ClassName()

ClassName ( "MeshedSurface< Face >"  )

Declare type-name (with debug switch)

◆ readTypes()

Foam::wordHashSet readTypes
static

Known readable file-types, without friends or proxies.

Definition at line 45 of file MeshedSurface.C.

◆ writeTypes()

Foam::wordHashSet writeTypes
static

Known writable file-types, without friends or proxies.

Definition at line 52 of file MeshedSurface.C.

◆ canReadType()

bool canReadType ( const word fileType,
bool  verbose = false 
)
static

Can we read this file format? Also checks friend types.

Definition at line 59 of file MeshedSurface.C.

◆ canWriteType()

bool canWriteType ( const word fileType,
bool  verbose = false 
)
static

Can we write this file format? Also checks proxy types.

Definition at line 76 of file MeshedSurface.C.

◆ canRead()

bool canRead ( const fileName name,
bool  verbose = false 
)
static

Can we read this file format?

Definition at line 93 of file MeshedSurface.C.

References word::ext(), word::lessExt(), and Foam::name().

Here is the call graph for this function:

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
MeshedSurface< Face >  ,
fileExtension  ,
(const fileName &name ,
(name  
)

◆ New() [1/2]

Foam::autoPtr< Foam::MeshedSurface< Face > > New ( const fileName name,
const word fileType,
bool  mandatory = true 
)
static

Read construct from filename with given file type.

Note
Use mandatory=false if support for the file type is optional (the file still needs to exist!).

Definition at line 37 of file MeshedSurfaceNew.C.

References DebugInFunction, Foam::exit(), fileName::ext(), word::ext(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), HashTable< T, Key, Hash >::found(), word::lessExt(), Foam::name(), Foam::New(), and Foam::nl.

Here is the call graph for this function:

◆ New() [2/2]

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

Read construct from filename (file type implicit from extension)

Definition at line 118 of file MeshedSurfaceNew.C.

References fileName::ext(), word::ext(), word::lessExt(), Foam::name(), and Foam::New().

Here is the call graph for this function:

◆ declareMemberFunctionSelectionTable()

declareMemberFunctionSelectionTable ( void  ,
UnsortedMeshedSurface< Face >  ,
write  ,
fileExtension  ,
(const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt, const dictionary &options)  ,
(name, surf, streamOpt, options)   
)

◆ write() [1/5]

void write ( const fileName name,
const MeshedSurface< Face > &  surf,
IOstreamOption  streamOpt = IOstreamOption(),
const dictionary options = dictionary::null 
)
static

Write to file, selecting writer based on its extension.

Definition at line 109 of file MeshedSurface.C.

References word::ext(), Foam::name(), and write().

Here is the call graph for this function:

◆ write() [2/5]

void write ( const fileName name,
const word fileType,
const MeshedSurface< Face > &  surf,
IOstreamOption  streamOpt = IOstreamOption(),
const dictionary options = dictionary::null 
)
static

Write to file, selecting writer based on the given extension.

Definition at line 122 of file MeshedSurface.C.

References DebugInFunction, Foam::exit(), word::ext(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), HashTable< T, Key, Hash >::found(), Foam::name(), Foam::nl, write(), and MeshedSurfaceProxy< Face >::write().

Here is the call graph for this function:

◆ size()

label size ( ) const
inline

The surface size is the number of faces.

Definition at line 407 of file MeshedSurface.H.

References interfaceDefinitions::size().

Referenced by surfaceNoise::initialise(), isoSurfaceTopo::isoSurfaceTopo(), sampledMeshedSurface::sampledMeshedSurface(), UnsortedMeshedSurface< Face >::size(), surfaceNoise::surfaceAverage(), GTSsurfaceFormat< Face >::write(), and surfaceNoise::writeSurfaceData().

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

◆ surfFaces()

◆ faceIds()

const labelList & faceIds ( ) const
inline

Return const access to faces ids.

If these exist, they are typically arise from reading a mesh format from another CAE software (eg, NASTRAN, STARCD, ...)

Definition at line 421 of file MeshedSurface.H.

Referenced by MeshedSurface< Face >::operator=().

Here is the caller graph for this function:

◆ surfZones()

const surfZoneList & surfZones ( ) const
inline

Const access to the surface zones.

If zones are defined, they must be contiguous and cover the entire surface

Definition at line 429 of file MeshedSurface.H.

Referenced by polySurface::copySurface(), surfMesh::copySurface(), MeshedSurface< Face >::operator=(), sampledMeshedSurface::sampledMeshedSurface(), UnsortedMeshedSurface< Face >::transfer(), polySurface::transfer(), triSurface::transfer(), UnsortedMeshedSurface< Face >::UnsortedMeshedSurface(), and GTSsurfaceFormat< Face >::write().

Here is the caller graph for this function:

◆ Sf()

const vectorField & Sf ( ) const
inline

Face area vectors (normals)

Definition at line 435 of file MeshedSurface.H.

References PrimitivePatch<::Foam::List< Face >, pointField >::faceAreas().

Referenced by sampledDistanceSurface::Sf(), sampledIsoSurface::Sf(), sampledCuttingPlane::Sf(), and sampledInterface::Sf().

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

◆ magSf()

const scalarField & magSf ( ) const
inline

Face area magnitudes.

Definition at line 441 of file MeshedSurface.H.

References PrimitivePatch<::Foam::List< Face >, pointField >::magFaceAreas().

Referenced by sampledDistanceSurface::magSf(), sampledIsoSurface::magSf(), sampledCuttingPlane::magSf(), sampledInterface::magSf(), surfaceNoise::surfaceAverage(), and surfaceNoise::writeSurfaceData().

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

◆ Cf()

const vectorField & Cf ( ) const
inline

Face centres.

Definition at line 447 of file MeshedSurface.H.

References PrimitivePatch<::Foam::List< Face >, pointField >::faceCentres().

Referenced by sampledDistanceSurface::Cf(), sampledIsoSurface::Cf(), sampledCuttingPlane::Cf(), and sampledInterface::Cf().

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

◆ clear()

void clear
virtual

Clear all storage.

Reimplemented in UnsortedMeshedSurface< Face >.

Definition at line 598 of file MeshedSurface.C.

Referenced by MeshedSurface< Face >::transcribe(), MeshedSurface< Face >::transfer(), and triSurface::transfer().

Here is the caller graph for this function:

◆ addZones() [1/3]

void addZones ( const UList< surfZone > &  srfZones,
const bool  cullEmpty = false 
)
virtual

Add surface zones.

Definition at line 151 of file MeshedSurfaceZones.C.

References forAll.

Referenced by MeshedSurface< Face >::MeshedSurface().

Here is the caller graph for this function:

◆ addZones() [2/3]

void addZones ( const labelUList sizes,
const UList< word > &  names,
const bool  cullEmpty = false 
)
virtual

Add surface zones.

Definition at line 176 of file MeshedSurfaceZones.C.

References forAll, and UList< T >::size().

Here is the call graph for this function:

◆ addZones() [3/3]

void addZones ( const labelUList sizes,
const bool  cullEmpty = false 
)
virtual

Add surface zones.

Definition at line 210 of file MeshedSurfaceZones.C.

References forAll, and UList< T >::size().

Here is the call graph for this function:

◆ addZonesToFaces() [1/3]

bool addZonesToFaces

Propagate zone information on face regions.

Normally a no-op, only used by the labelledTri specialization. Specializations return true, others return false.

Definition at line 243 of file MeshedSurfaceZones.C.

◆ removeZones()

void removeZones
virtual

Remove surface zones.

Definition at line 251 of file MeshedSurfaceZones.C.

◆ movePoints()

void movePoints ( const pointField newPoints)
virtual

Move points.

Definition at line 610 of file MeshedSurface.C.

◆ scalePoints()

void scalePoints ( const scalar  scaleFactor)
virtual

Scale points. A non-positive factor is ignored.

Definition at line 623 of file MeshedSurface.C.

Referenced by UnsortedMeshedSurface< Face >::UnsortedMeshedSurface().

Here is the caller graph for this function:

◆ cleanup()

void cleanup ( const bool  verbose)
virtual

Remove invalid faces.

Definition at line 641 of file MeshedSurface.C.

References Foam::checkTopology().

Here is the call graph for this function:

◆ compactPoints()

void compactPoints ( labelList pointMap = const_cast<labelList&>(labelList::null()))
virtual

Remove unused points and renumber faces in local visit order.

Parameters
[out]pointMapfrom new to old points (optional)

Definition at line 652 of file MeshedSurface.C.

◆ stitchFaces()

bool stitchFaces ( const scalar  tol = SMALL,
const bool  verbose = false 
)
virtual

Definition at line 692 of file MeshedSurface.C.

References List< T >::clear(), Foam::endl(), f(), Foam::faceMap(), forAll, InfoInFunction, Foam::inplaceMergePoints(), Foam::Pout, List< T >::resize(), and UList< T >::size().

Here is the call graph for this function:

◆ checkFaces()

bool checkFaces ( const bool  verbose = false)
virtual

Definition at line 782 of file MeshedSurface.C.

References Foam::endl(), Foam::exit(), f(), Foam::faceMap(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::nl, points, List< T >::resize(), UList< T >::size(), and WarningInFunction.

Here is the call graph for this function:

◆ nTriangles() [1/2]

Foam::label nTriangles
virtual

Count number of triangles.

Definition at line 950 of file MeshedSurface.C.

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

Here is the caller graph for this function:

◆ nTriangles() [2/2]

Foam::label nTriangles ( labelList faceMap) const
virtual

Count number of triangles, returning a face map of original ids.

The faceMap is zero-sized when no triangulation would be needed.

Definition at line 965 of file MeshedSurface.C.

References f(), Foam::faceMap(), forAll, n, Foam::notNull(), and UList< T >::size().

Here is the call graph for this function:

◆ triangulate() [1/2]

Foam::label triangulate
virtual

Triangulate in-place, returning the number of triangles added.

Definition at line 1010 of file MeshedSurface.C.

Referenced by powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), and MeshedSurface< Face >::transcribe().

Here is the caller graph for this function:

◆ triangulate() [2/2]

Foam::label triangulate ( labelList faceMap)
virtual

Triangulate in-place, returning the number of triangles added.

and setting a map of original face Ids. The faceMap is zero-sized when no triangulation was done.

Definition at line 1028 of file MeshedSurface.C.

References f(), Foam::faceMap(), UList< T >::fcIndex(), forAll, n, Foam::notNull(), points, UList< T >::size(), and List< T >::transfer().

Here is the call graph for this function:

◆ subsetMeshMap()

void subsetMeshMap ( const BoolListType &  include,
labelList pointMap,
labelList faceMap 
) const
inline

Create mappings for a sub-surface.

Parameters
[in]includethe faces to select
[out]pointMapfrom new to old localPoints
[out]faceMapfrom new to old localFaces

Definition at line 540 of file MeshedSurface.H.

References Foam::faceMap(), and PatchTools::subsetMap().

Here is the call graph for this function:

◆ subsetMesh() [1/5]

Foam::MeshedSurface< Face > subsetMesh ( const UList< bool > &  include,
labelList pointMap,
labelList faceMap 
) const

Return a new surface subsetted on the selected faces.

Parameters
[in]includethe faces to select
[out]pointMapfrom new to old localPoints
[out]faceMapfrom new to old localFaces

Definition at line 1219 of file MeshedSurface.C.

References Foam::faceMap().

Referenced by sampledMeshedSurface::sampledMeshedSurface().

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

◆ subsetMesh() [2/5]

Foam::MeshedSurface< Face > subsetMesh ( const bitSet include,
labelList pointMap,
labelList faceMap 
) const

Return a new surface subsetted on the selected faces.

Parameters
[in]includethe faces to select
[out]pointMapfrom new to old localPoints
[out]faceMapfrom new to old localFaces

Definition at line 1233 of file MeshedSurface.C.

References Foam::faceMap().

Here is the call graph for this function:

◆ subsetMesh() [3/5]

Foam::MeshedSurface< Face > subsetMesh ( const UList< bool > &  include) const

Return a new surface subsetted on the selected faces.

Parameters
[in]includethe faces to select

Definition at line 1247 of file MeshedSurface.C.

References Foam::faceMap().

Here is the call graph for this function:

◆ subsetMesh() [4/5]

Foam::MeshedSurface< Face > subsetMesh ( const bitSet include) const

Return a new surface subsetted on the selected faces.

Parameters
[in]includethe faces to select

Definition at line 1259 of file MeshedSurface.C.

References Foam::faceMap().

Here is the call graph for this function:

◆ subsetMesh() [5/5]

Foam::MeshedSurface< Face > subsetMesh ( const wordRes includeNames,
const wordRes excludeNames = wordRes() 
) const

Return a new surface subsetted on the selected zone names.

Parameters
[in]includeNamessurface zone names to include
[in]excludeNamessurface zone names to exclude
See also
Foam::stringListOps::findMatching for details about matching

Definition at line 1270 of file MeshedSurface.C.

References surfaceFormatsCore::getSelectedPatches(), range, and bitSet::set().

Here is the call graph for this function:

◆ swap()

void swap ( MeshedSurface< Face > &  surf)

Swap contents.

Definition at line 1297 of file MeshedSurface.C.

References PrimitivePatch< FaceList, PointField >::clearOut(), MeshedSurface< Face >::storedFaceIds(), MeshedSurface< Face >::storedFaces(), MeshedSurface< Face >::storedPoints(), and MeshedSurface< Face >::storedZones().

Here is the call graph for this function:

◆ transfer() [1/3]

void transfer ( pointField pointLst,
List< Face > &  faceLst 
)

Transfer the components.

Definition at line 1318 of file MeshedSurface.C.

Referenced by sampledMeshedSurface::sampledMeshedSurface().

Here is the caller graph for this function:

◆ transfer() [2/3]

void transfer ( MeshedSurface< Face > &  surf)

Transfer the contents of the argument and annul the argument.

Definition at line 1334 of file MeshedSurface.C.

References MeshedSurface< Face >::clear(), MeshedSurface< Face >::storedFaceIds(), MeshedSurface< Face >::storedFaces(), MeshedSurface< Face >::storedPoints(), and MeshedSurface< Face >::storedZones().

Here is the call graph for this function:

◆ transfer() [3/3]

void transfer ( UnsortedMeshedSurface< Face > &  surf)

Transfer the contents of the argument and annul the argument.

Definition at line 1356 of file MeshedSurface.C.

References clear(), UnsortedMeshedSurface< Face >::clear(), Foam::faceMap(), forAll, UList< T >::size(), UnsortedMeshedSurface< Face >::sortedZones(), MeshedSurface< Face >::storedFaces(), MeshedSurface< Face >::storedPoints(), UList< T >::swap(), and List< T >::transfer().

Here is the call graph for this function:

◆ releaseGeom()

Foam::autoPtr< Foam::MeshedSurface< Face > > releaseGeom

Release (clear) geometry and return for reuse.

Definition at line 1397 of file MeshedSurface.C.

References Foam::New().

Here is the call graph for this function:

◆ swapFaces()

void swapFaces ( List< Face > &  faces)

Swap the stored faces. Use with caution.

Definition at line 1404 of file MeshedSurface.C.

Referenced by triSurface::transfer().

Here is the caller graph for this function:

◆ swapPoints()

void swapPoints ( pointField points)

Swap the stored points.

Definition at line 1417 of file MeshedSurface.C.

References points.

Referenced by triSurface::transfer().

Here is the caller graph for this function:

◆ read() [1/2]

bool read ( const fileName name,
const word fileType 
)

Read from file. Chooses reader based on explicit extension.

Definition at line 1436 of file MeshedSurface.C.

References clear(), Foam::name(), and Foam::New().

Here is the call graph for this function:

◆ read() [2/2]

bool read ( const fileName name)
virtual

Read from file. Chooses reader based on detected extension.

Reimplemented in ABAQUSsurfaceFormat< Face >, AC3DsurfaceFormat< Face >, GTSsurfaceFormat< Face >, NASsurfaceFormat< Face >, OBJsurfaceFormat< Face >, OFFsurfaceFormat< Face >, STARCDsurfaceFormat< Face >, STLsurfaceFormat< Face >, TRIsurfaceFormat< Face >, VTKsurfaceFormat< Face >, and UnsortedMeshedSurface< Face >.

Definition at line 1427 of file MeshedSurface.C.

References clear(), Foam::name(), and Foam::New().

Here is the call graph for this function:

◆ writeStats()

void writeStats ( Ostream os) const

Definition at line 62 of file MeshedSurfaceIO.C.

References Foam::endl(), f(), n, Foam::nl, os(), and points.

Here is the call graph for this function:

◆ write() [3/5]

virtual void write ( const fileName name,
IOstreamOption  streamOpt = IOstreamOption(),
const dictionary options = dictionary::null 
) const
inlinevirtual

Generic write routine. Chooses writer based on extension.

Reimplemented in ABAQUSsurfaceFormat< Face >, AC3DsurfaceFormat< Face >, FLMAsurfaceFormat< Face >, FLMAZsurfaceFormat< Face >, GTSsurfaceFormat< Face >, NASsurfaceFormat< Face >, OBJsurfaceFormat< Face >, OFFsurfaceFormat< Face >, SMESHsurfaceFormat< Face >, STARCDsurfaceFormat< Face >, STLsurfaceFormat< Face >, TRIsurfaceFormat< Face >, VTKsurfaceFormat< Face >, VTPsurfaceFormat< Face >, X3DsurfaceFormat< Face >, and UnsortedMeshedSurface< Face >.

Definition at line 632 of file MeshedSurface.H.

References Foam::name(), and write().

Here is the call graph for this function:

◆ write() [4/5]

virtual void write ( const fileName name,
const word fileType,
IOstreamOption  streamOpt = IOstreamOption(),
const dictionary options = dictionary::null 
) const
inlinevirtual

Generic write routine for given format type.

If the format type is "", uses the file extension.

Reimplemented in UnsortedMeshedSurface< Face >.

Definition at line 644 of file MeshedSurface.H.

◆ write() [5/5]

void write ( const Time runTime,
const word surfName = word::null 
) const

Write to database.

Definition at line 1449 of file MeshedSurface.C.

References MeshedSurfaceProxy< Face >::write().

Here is the call graph for this function:

◆ operator=() [1/2]

void operator= ( const MeshedSurface< Face > &  surf)

Copy assignment.

Definition at line 1462 of file MeshedSurface.C.

References clear(), MeshedSurface< Face >::faceIds(), PrimitivePatch< FaceList, PointField >::points(), MeshedSurface< Face >::surfFaces(), and MeshedSurface< Face >::surfZones().

Here is the call graph for this function:

◆ operator=() [2/2]

void operator= ( MeshedSurface< Face > &&  surf)

Move assignment.

Definition at line 1480 of file MeshedSurface.C.

◆ operator MeshedSurfaceProxy< Face >()

operator MeshedSurfaceProxy< Face > ( ) const

Conversion operator to MeshedSurfaceProxy.

◆ addZonesToFaces() [2/3]

bool addZonesToFaces ( )

Specialization for labelledTri.

◆ transcribe() [2/4]

void transcribe ( MeshedSurface< face > &  surf)
protected

Definition at line 38 of file MeshedSurfaceCore.C.

◆ transcribe() [3/4]

void transcribe ( MeshedSurface< face > &  surf)
protected

Definition at line 50 of file MeshedSurfaceCore.C.

References MeshedSurface< Face >::clear(), forAll, UList< T >::size(), MeshedSurface< Face >::storedPoints(), MeshedSurface< Face >::storedZones(), MeshedSurface< Face >::surfFaces(), and MeshedSurface< Face >::triangulate().

Here is the call graph for this function:

◆ transcribe() [4/4]

void transcribe ( MeshedSurface< face > &  surf)
protected

Definition at line 83 of file MeshedSurfaceCore.C.

References MeshedSurface< Face >::clear(), forAll, UList< T >::size(), MeshedSurface< Face >::storedPoints(), MeshedSurface< Face >::storedZones(), MeshedSurface< Face >::surfFaces(), and MeshedSurface< Face >::triangulate().

Here is the call graph for this function:

◆ addZonesToFaces() [3/3]

bool addZonesToFaces ( )

Definition at line 115 of file MeshedSurfaceCore.C.

References forAll.

Friends And Related Function Documentation

◆ MeshedSurface

friend class MeshedSurface
friend

Definition at line 101 of file MeshedSurface.H.

◆ UnsortedMeshedSurface

friend class UnsortedMeshedSurface
friend

Definition at line 102 of file MeshedSurface.H.

◆ surfMesh

friend class surfMesh
friend

Definition at line 105 of file MeshedSurface.H.

◆ operator>>

Istream & operator>> ( Istream is,
MeshedSurface< Face > &  surf 
)
friend

Read MeshedSurface from Istream.

Avoid using to read/write file content (fragile).

◆ operator

Ostream & operator ( Ostream os,
const MeshedSurface< Face > &  surf 
)
friend

Write MeshedSurface to Ostream.

Avoid using to read/write file content (fragile).


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