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...
Public Types | |
typedef Face | FaceType |
Face type used. More... | |
Public Member Functions | |
ClassName ("MeshedSurface") | |
Runtime type information. More... | |
MeshedSurface () | |
Construct null, 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 &ext) | |
Construct from file name (uses extension to determine type) More... | |
MeshedSurface (Istream &is) | |
Construct from Istream. More... | |
MeshedSurface (const Time &runTime, const word &surfName=word::null) | |
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, const dictionary &options),(name, surf, 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 surfZoneList & | surfZones () const |
Const access to the surface zones. More... | |
const vectorField & | Sf () const |
Face area vectors (normals) More... | |
const scalarField & | magSf () const |
Face area magnitudes. More... | |
const vectorField & | Cf () const |
Face centres. More... | |
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 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 (List< label > &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 (List< label > &faceMap) |
Triangulate in-place, returning the number of triangles added. More... | |
template<class BoolListType > | |
MeshedSurface | subsetMesh (const BoolListType &include, labelList &pointMap, labelList &faceMap) const |
Return new surface. More... | |
MeshedSurface | subsetMesh (const bitSet &include) const |
Return new surface. More... | |
MeshedSurface | subsetMesh (const labelHashSet &include) const |
Return new surface. 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. More... | |
void | swapPoints (pointField &points) |
Swap the stored points. More... | |
void | swapZones (surfZoneList &zones) |
Swap the stored zones. More... | |
bool | read (const fileName &name, const word &ext) |
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, const dictionary &options=dictionary::null) const |
Generic write routine. Chooses writer based on extension. More... | |
void | write (const Time &t, 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) | |
template<class BoolListType > | |
Foam::MeshedSurface< Face > | subsetMesh (const BoolListType &include, labelList &pointMap, labelList &faceMap) const |
template<> | |
bool | addZonesToFaces () |
Specialization for labelledTri. More... | |
template<> | |
bool | addZonesToFaces () |
Static Public Member Functions | |
static bool | canRead (const fileName &name, bool verbose=false) |
Can we read this file format? More... | |
static bool | canReadType (const word &ext, bool verbose=false) |
Can we read this file format? More... | |
static bool | canWriteType (const word &ext, bool verbose=false) |
Can we write this file format? More... | |
static wordHashSet | readTypes () |
Known readable file-types. More... | |
static wordHashSet | writeTypes () |
Known writable file-types. More... | |
static autoPtr< MeshedSurface > | New (const fileName &name, const word &ext) |
Select constructed from filename (explicit extension) More... | |
static autoPtr< MeshedSurface > | New (const fileName &name) |
Select constructed from filename (implicit extension) More... | |
static void | write (const fileName &name, const MeshedSurface< Face > &surf, const dictionary &options=dictionary::null) |
Write to file, selecting writer based on its extension. More... | |
static void | write (const fileName &name, const word &ext, const MeshedSurface< Face > &surf, const dictionary &options=dictionary::null) |
Write to file, selecting writer based on the given extension. More... | |
Protected Member Functions | |
void | transcribe (MeshedSurface< face > &surf) |
Transfer points/zones from 'face' to other other shapes. More... | |
void | checkZones () |
Basic sanity check on zones. More... | |
pointField & | storedPoints () |
Non-const access to global points. More... | |
List< Face > & | storedFaces () |
Non-const access to the faces. More... | |
surfZoneList & | storedZones () |
Non-const access to the zones. More... | |
void | sortFacesAndStore (DynamicList< Face > &unsortedFaces, DynamicList< 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... | |
template<> | |
void | transcribe (MeshedSurface< face > &surf) |
template<> | |
void | transcribe (MeshedSurface< face > &surf) |
template<> | |
void | transcribe (MeshedSurface< face > &surf) |
Friends | |
template<class Face2 > | |
class | MeshedSurface |
template<class Face2 > | |
class | UnsortedMeshedSurface |
class | surfMesh |
Istream & | operator>> (Istream &is, MeshedSurface< Face > &surf) |
Read MeshedSurface from Istream. More... | |
Ostream & | operator (Ostream &os, const MeshedSurface< Face > &surf) |
Write MeshedSurface to Ostream. More... | |
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.
Definition at line 80 of file triSurfaceTools.H.
typedef Face FaceType |
Face type used.
Definition at line 185 of file MeshedSurface.H.
MeshedSurface | ( | ) |
Construct null, an empty surface.
Definition at line 165 of file MeshedSurface.C.
MeshedSurface | ( | const MeshedSurface< Face > & | surf | ) |
Copy construct.
MeshedSurface | ( | const UnsortedMeshedSurface< Face > & | surf | ) |
Copy construct from an UnsortedMeshedSurface.
Definition at line 185 of file MeshedSurface.C.
MeshedSurface | ( | MeshedSurface< Face > && | surf | ) |
Move construct.
MeshedSurface | ( | UnsortedMeshedSurface< Face > && | surf | ) |
Move construct from an UnsortedMeshedSurface.
Definition at line 220 of file MeshedSurface.C.
MeshedSurface | ( | const pointField & | pointLst, |
const UList< Face > & | faceLst, | ||
const UList< surfZone > & | zoneLst | ||
) |
Copy construct from components (points, faces, zones).
Definition at line 232 of file MeshedSurface.C.
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 245 of file MeshedSurface.C.
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 258 of file MeshedSurface.C.
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 284 of file MeshedSurface.C.
MeshedSurface | ( | const polyBoundaryMesh & | bMesh, |
const bool | globalPoints = false |
||
) |
Construct from a boundary mesh with local points/faces.
Definition at line 327 of file MeshedSurface.C.
MeshedSurface | ( | const surfMesh & | mesh | ) |
Construct from a surfMesh.
Definition at line 309 of file MeshedSurface.C.
MeshedSurface | ( | const fileName & | name | ) |
Construct from file name (uses extension to determine type)
Definition at line 403 of file MeshedSurface.C.
MeshedSurface | ( | const fileName & | name, |
const word & | ext | ||
) |
Construct from file name (uses extension to determine type)
Definition at line 394 of file MeshedSurface.C.
MeshedSurface | ( | Istream & | is | ) |
Construct from Istream.
Definition at line 412 of file MeshedSurface.C.
MeshedSurface | ( | const Time & | runTime, |
const word & | surfName = word::null |
||
) |
Construct from database.
Definition at line 422 of file MeshedSurface.C.
|
virtual |
Destructor.
Definition at line 456 of file MeshedSurface.C.
MeshedSurface | ( | const MeshedSurface< Face > & | surf | ) |
Definition at line 174 of file MeshedSurface.C.
MeshedSurface | ( | MeshedSurface< Face > && | surf | ) |
Definition at line 208 of file MeshedSurface.C.
|
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.
|
protected |
Basic sanity check on zones.
Definition at line 35 of file MeshedSurfaceZones.C.
|
inlineprotected |
Non-const access to global points.
Definition at line 151 of file MeshedSurface.H.
Referenced by MeshedSurface< Foam::face >::swap(), MeshedSurface< Foam::face >::transcribe(), polySurface::transfer(), surfMesh::transfer(), and MeshedSurface< Foam::face >::transfer().
|
inlineprotected |
Non-const access to the faces.
Definition at line 157 of file MeshedSurface.H.
Referenced by MeshedSurface< Foam::face >::swap(), polySurface::transfer(), surfMesh::transfer(), and MeshedSurface< Foam::face >::transfer().
|
inlineprotected |
Non-const access to the zones.
Definition at line 163 of file MeshedSurface.H.
Referenced by MeshedSurface< Foam::face >::swap(), MeshedSurface< Foam::face >::transcribe(), surfMesh::transfer(), and MeshedSurface< Foam::face >::transfer().
|
protected |
Sort faces by zones and store sorted faces.
Definition at line 70 of file MeshedSurfaceZones.C.
|
protectedvirtual |
Set new zones from faceMap.
Reimplemented in cuttingSurfaceBase.
Definition at line 466 of file MeshedSurface.C.
ClassName | ( | "MeshedSurface< Face >" | ) |
Runtime type information.
Can we read this file format?
Definition at line 95 of file MeshedSurface.C.
Can we read this file format?
Definition at line 61 of file MeshedSurface.C.
Can we write this file format?
Definition at line 78 of file MeshedSurface.C.
|
static |
Known readable file-types.
Definition at line 45 of file MeshedSurface.C.
Referenced by triSurface::readTypes().
|
static |
Known writable file-types.
Definition at line 51 of file MeshedSurface.C.
declareRunTimeSelectionTable | ( | autoPtr | , |
MeshedSurface< Face > | , | ||
fileExtension | , | ||
(const fileName &name) | , | ||
(name) | |||
) |
|
static |
Select constructed from filename (explicit extension)
Definition at line 37 of file MeshedSurfaceNew.C.
|
static |
Select constructed from filename (implicit extension)
Definition at line 75 of file MeshedSurfaceNew.C.
declareMemberFunctionSelectionTable | ( | void | , |
UnsortedMeshedSurface< Face > | , | ||
write | , | ||
fileExtension | , | ||
(const fileName &name, const MeshedSurface< Face > &surf, const dictionary &options) | , | ||
(name, surf, options) | |||
) |
|
static |
Write to file, selecting writer based on its extension.
Definition at line 111 of file MeshedSurface.C.
|
static |
Write to file, selecting writer based on the given extension.
Definition at line 123 of file MeshedSurface.C.
|
inline |
The surface size is the number of faces.
Definition at line 356 of file MeshedSurface.H.
Referenced by polySurface::copySurface(), surfMesh::copySurface(), surfaceNoise::initialise(), UnsortedMeshedSurface< Face >::size(), surfaceNoise::surfaceAverage(), triSurfaceTools::validTri(), GTSsurfaceFormat< Face >::write(), and surfaceNoise::writeSurfaceData().
|
inline |
Return const access to the faces.
Definition at line 362 of file MeshedSurface.H.
Referenced by polySurface::copySurface(), surfMesh::copySurface(), sampledDiscreteSurface::faces(), sampledDistanceSurface::faces(), sampledIsoSurface::faces(), sampledCuttingPlane::faces(), UnsortedMeshedSurface< Face >::operator=(), MeshedSurface< Foam::face >::operator=(), MeshedSurface< Foam::face >::transcribe(), GTSsurfaceFormat< Face >::write(), and surfaceNoise::writeSurfaceData().
|
inline |
Const access to the surface zones.
If zones are defined, they must be contiguous and cover the entire surface
Definition at line 370 of file MeshedSurface.H.
Referenced by polySurface::copySurface(), surfMesh::copySurface(), MeshedSurface< Foam::face >::operator=(), polySurface::transfer(), UnsortedMeshedSurface< Face >::transfer(), triSurface::transfer(), UnsortedMeshedSurface< Face >::UnsortedMeshedSurface(), and GTSsurfaceFormat< Face >::write().
|
inline |
Face area vectors (normals)
Definition at line 376 of file MeshedSurface.H.
Referenced by sampledDiscreteSurface::Sf(), sampledDistanceSurface::Sf(), sampledIsoSurface::Sf(), and sampledCuttingPlane::Sf().
|
inline |
Face area magnitudes.
Definition at line 382 of file MeshedSurface.H.
Referenced by sampledDiscreteSurface::magSf(), sampledDistanceSurface::magSf(), sampledIsoSurface::magSf(), and sampledCuttingPlane::magSf().
|
inline |
Face centres.
Definition at line 388 of file MeshedSurface.H.
Referenced by sampledDiscreteSurface::Cf(), sampledDistanceSurface::Cf(), sampledIsoSurface::Cf(), and sampledCuttingPlane::Cf().
|
virtual |
Clear all storage.
Definition at line 514 of file MeshedSurface.C.
Referenced by MeshedSurface< Foam::face >::transcribe(), triSurface::transfer(), and MeshedSurface< Foam::face >::transfer().
Add surface zones.
Definition at line 107 of file MeshedSurfaceZones.C.
|
virtual |
Add surface zones.
Definition at line 130 of file MeshedSurfaceZones.C.
|
virtual |
Add surface zones.
Definition at line 162 of file MeshedSurfaceZones.C.
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 192 of file MeshedSurfaceZones.C.
|
virtual |
Remove surface zones.
Definition at line 200 of file MeshedSurfaceZones.C.
|
virtual |
Move points.
Definition at line 525 of file MeshedSurface.C.
|
virtual |
Scale points. A non-positive factor is ignored.
Definition at line 538 of file MeshedSurface.C.
|
virtual |
Remove invalid faces.
Definition at line 557 of file MeshedSurface.C.
Definition at line 569 of file MeshedSurface.C.
Definition at line 652 of file MeshedSurface.C.
|
virtual |
Count number of triangles.
Definition at line 804 of file MeshedSurface.C.
|
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 820 of file MeshedSurface.C.
|
virtual |
Triangulate in-place, returning the number of triangles added.
Definition at line 864 of file MeshedSurface.C.
Referenced by MeshedSurface< Foam::face >::transcribe().
|
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 883 of file MeshedSurface.C.
MeshedSurface subsetMesh | ( | const BoolListType & | include, |
labelList & | pointMap, | ||
labelList & | faceMap | ||
) | const |
Return new surface.
[in] | include | the faces to select |
[out] | pointMap | from subsetMeshMap |
[out] | faceMap | from subsetMeshMap |
Foam::MeshedSurface< Face > subsetMesh | ( | const bitSet & | include | ) | const |
Return new surface.
Definition at line 1086 of file MeshedSurface.C.
Foam::MeshedSurface< Face > subsetMesh | ( | const labelHashSet & | include | ) | const |
Return new surface.
Definition at line 1097 of file MeshedSurface.C.
void swap | ( | MeshedSurface< Face > & | surf | ) |
Swap contents.
Definition at line 1108 of file MeshedSurface.C.
Referenced by MeshedSurface< Foam::face >::swap().
void transfer | ( | pointField & | pointLst, |
List< Face > & | faceLst | ||
) |
Transfer the components.
Definition at line 1128 of file MeshedSurface.C.
void transfer | ( | MeshedSurface< Face > & | surf | ) |
Transfer the contents of the argument and annul the argument.
Definition at line 1143 of file MeshedSurface.C.
void transfer | ( | UnsortedMeshedSurface< Face > & | surf | ) |
Transfer the contents of the argument and annul the argument.
Definition at line 1164 of file MeshedSurface.C.
Foam::autoPtr< Foam::MeshedSurface< Face > > releaseGeom | ( | ) |
Release (clear) geometry and return for reuse.
Definition at line 1203 of file MeshedSurface.C.
void swapFaces | ( | List< Face > & | faces | ) |
Swap the stored faces.
Definition at line 1210 of file MeshedSurface.C.
Referenced by triSurface::transfer().
void swapPoints | ( | pointField & | points | ) |
Swap the stored points.
Definition at line 1219 of file MeshedSurface.C.
Referenced by triSurface::transfer().
void swapZones | ( | surfZoneList & | zones | ) |
Swap the stored zones.
Definition at line 1228 of file MeshedSurface.C.
Read from file. Chooses reader based on explicit extension.
Definition at line 1251 of file MeshedSurface.C.
Read from file. Chooses reader based on detected extension.
Reimplemented in STLsurfaceFormat< Face >, VTKsurfaceFormat< Face >, NASsurfaceFormat< Face >, TRIsurfaceFormat< Face >, STARCDsurfaceFormat< Face >, AC3DsurfaceFormat< Face >, OFFsurfaceFormat< Face >, and OBJsurfaceFormat< Face >.
Definition at line 1235 of file MeshedSurface.C.
void writeStats | ( | Ostream & | os | ) | const |
Definition at line 62 of file MeshedSurfaceIO.C.
|
inlinevirtual |
Generic write routine. Chooses writer based on extension.
Reimplemented in STLsurfaceFormat< Face >, FLMAZsurfaceFormat< Face >, VTKsurfaceFormat< Face >, VTPsurfaceFormat< Face >, FLMAsurfaceFormat< Face >, NASsurfaceFormat< Face >, TRIsurfaceFormat< Face >, STARCDsurfaceFormat< Face >, OFFsurfaceFormat< Face >, SMESHsurfaceFormat< Face >, OBJsurfaceFormat< Face >, X3DsurfaceFormat< Face >, and AC3DsurfaceFormat< Face >.
Definition at line 526 of file MeshedSurface.H.
void write | ( | const Time & | t, |
const word & | surfName = word::null |
||
) | const |
Write to database.
Definition at line 1266 of file MeshedSurface.C.
void operator= | ( | const MeshedSurface< Face > & | surf | ) |
Copy assignment.
Definition at line 1278 of file MeshedSurface.C.
void operator= | ( | MeshedSurface< Face > && | surf | ) |
Move assignment.
Definition at line 1289 of file MeshedSurface.C.
operator MeshedSurfaceProxy< Face > | ( | ) | const |
Conversion operator to MeshedSurfaceProxy.
Foam::MeshedSurface<Face> subsetMesh | ( | const BoolListType & | include, |
labelList & | pointMap, | ||
labelList & | faceMap | ||
) | const |
Definition at line 1000 of file MeshedSurface.C.
bool addZonesToFaces | ( | ) |
Specialization for labelledTri.
|
protected |
Definition at line 39 of file MeshedSurfaceCore.C.
|
protected |
Definition at line 51 of file MeshedSurfaceCore.C.
|
protected |
Definition at line 82 of file MeshedSurfaceCore.C.
bool addZonesToFaces | ( | ) |
Definition at line 111 of file MeshedSurfaceCore.C.
|
friend |
Definition at line 97 of file MeshedSurface.H.
|
friend |
Definition at line 98 of file MeshedSurface.H.
|
friend |
Definition at line 101 of file MeshedSurface.H.
|
friend |
Read MeshedSurface from Istream.
Avoid using to read/write file content (fragile).
|
friend |
Write MeshedSurface to Ostream.
Avoid using to read/write file content (fragile).