Public Member Functions | List of all members
isoSurfaceCell Class Reference

A surface formed by the iso value. After "Polygonising A Scalar Field Using Tetrahedrons", Paul Bourke (http://paulbourke.net/geometry/polygonise) and "Regularised Marching Tetrahedra: improved iso-surface extraction", G.M. Treece, R.W. Prager and A.H. Gee. More...

Inheritance diagram for isoSurfaceCell:
Inheritance graph
[legend]
Collaboration diagram for isoSurfaceCell:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("isoSurfaceCell")
 Runtime type information. More...
 
 isoSurfaceCell (const polyMesh &mesh, const scalarField &cellValues, const scalarField &pointValues, const scalar iso, const isoSurfaceParams &params=isoSurfaceParams(), const bitSet &ignoreCells=bitSet())
 Construct from cell and point values. More...
 
virtual ~isoSurfaceCell ()=default
 Destructor. More...
 
virtual tmp< Field< scalar > > interpolate (const VolumeField< scalar > &cellValues, const Field< scalar > &pointValues) const
 interpolate scalar cellValues, pointValues on iso-surface More...
 
virtual tmp< Field< vector > > interpolate (const VolumeField< vector > &cellValues, const Field< vector > &pointValues) const
 interpolate vector cellValues, pointValues on iso-surface More...
 
virtual tmp< Field< sphericalTensor > > interpolate (const VolumeField< sphericalTensor > &cellValues, const Field< sphericalTensor > &pointValues) const
 interpolate sphericalTensor cellValues, pointValues on iso-surface More...
 
virtual tmp< Field< symmTensor > > interpolate (const VolumeField< symmTensor > &cellValues, const Field< symmTensor > &pointValues) const
 interpolate symmTensor cellValues, pointValues on iso-surface More...
 
virtual tmp< Field< tensor > > interpolate (const VolumeField< tensor > &cellValues, const Field< tensor > &pointValues) const
 interpolate tensor cellValues, pointValues on iso-surface More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > interpolateTemplate (const Field< Type > &cCoords, const Field< Type > &pCoords) const
 
- Public Member Functions inherited from isoSurfaceBase
 isoSurfaceBase (const polyMesh &mesh, const scalarField &cellValues, const scalarField &pointValues, const scalar iso, const isoSurfaceParams &params=isoSurfaceParams())
 Construct with mesh, cell/point values and iso-value. More...
 
const polyMeshmesh () const noexcept
 The mesh for which the iso-surface is associated. More...
 
const scalarFieldcellValues () const noexcept
 The mesh cell values used for creating the iso-surface. More...
 
const scalarFieldpointValues () const noexcept
 The mesh point values used for creating the iso-surface. More...
 
scalar isoValue () const noexcept
 The iso-value associated with the surface. More...
 
const labelListmeshCells () const noexcept
 For each face, the original cell in mesh. More...
 
labelListmeshCells () noexcept
 For each face, the original cell in mesh. More...
 
label blockCells (UList< cutType > &cuts, const bitSet &ignoreCells) const
 Mark ignoreCells as BLOCKED. More...
 
label blockCells (UList< cutType > &cuts, const boundBox &bb, const volumeType::type volType) const
 Mark cells inside/outside a (valid) bound box as BLOCKED. More...
 
void ignoreCyclics ()
 Set ignoreBoundaryFaces to ignore cyclics (cyclicACMI) More...
 
label calcCellCuts (List< cutType > &cuts) const
 Populate a list of candidate cell cuts using getCellCutType() More...
 
cutType getFaceCutType (const label facei) const
 Determine face cut for an individual face. More...
 
cutType getCellCutType (const label celli) const
 Cell cut for an individual cell, with special handling for TETCUT and SPHERE cuts. More...
 
- Public Member Functions inherited from MeshedSurface< Face >
 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)
 
template<>
bool addZonesToFaces ()
 Specialization for labelledTri. More...
 
template<>
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
 Extract list of local faces corresponding to the boundary edges. More...
 
labelList uniqBoundaryFaces () const
 Extract sorted list of unique local faces associated with the boundary edges. More...
 
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
 Return label of the local patch edge into the global edge list using basic edge addressing. More...
 
label findEdge (const edge &e) const
 Search for edge (local point labels) and return its index in the edge list or -1 if not found. More...
 
labelList meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
 Return labels of patch edges in the global edge list using cell addressing. More...
 
labelList meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
 Return labels of patch edges into the global edge list using basic edge addressing. More...
 
labelList meshEdges (const labelUList &edgeLabels, const edgeList &allEdges, const labelListList &pointEdges) const
 Return labels of specified patch edges into the global edge list using basic edge addressing. More...
 
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...
 
Pair< point_typebox () const
 The enclosing (bounding) box for the patch points. More...
 
scalar sphere (const label facei) const
 The enclosing (bounding) sphere radius^2 for specified face. 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 hasMeshPoints () 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 (labelHashSet *badEdgesPtr=nullptr) const
 Calculate surface type formed by patch, optionally recording the indices of illegal edges. More...
 
bool checkTopology (const bool report=false, labelHashSet *pointSetPtr=nullptr) const
 Check surface formed by patch for manifoldness (see above). More...
 
bool checkPointManifold (const bool report=false, labelHashSet *pointSetPtr=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 transfer (List< Face > &list)
 Transfer the contents of the argument List into this list and annul the argument list. More...
 
void transfer (DynamicList< Face, SizeMin > &list)
 Transfer the contents of the argument List into this list and annul the argument list. More...
 
Face & newElmt (const label i)
 Return subscript-checked element of UList and resizing the list if required. More...
 
Face & emplace_back (Args &&... args)
 Construct an element at the end of the list, return reference to the new list element. More...
 
void push_back (const Face &val)
 Append an element at the end of the list. More...
 
void push_back (Face &&val)
 Move append an element at the end of the list. More...
 
void push_back (const UList< Face > &list)
 Append a List to the end of this list. More...
 
void push_back (const IndirectListBase< Face, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label push_uniq (const Face &val)
 Append an element if not already in the list. More...
 
void pop_back (label n=1)
 Reduce size by 1 or more elements. Can be called on an empty list. More...
 
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)
 Specialized list reading for character lists which always uses binary format. More...
 
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...
 
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...
 
- Public Member Functions inherited from UList< Face >
label size () const noexcept
 The number of elements in the List. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the List as a dictionary entry with keyword. 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...
 
 UList (const UList< Face > &)=default
 Copy construct. More...
 
constexpr UList () noexcept
 Default construct, zero-sized and nullptr. More...
 
 UList (Face *__restrict__ v, const label len) noexcept
 Construct from components. More...
 
label fcIndex (const label i) const noexcept
 The forward circular index. The next index in the list which returns to the first at the end of the list. More...
 
label rcIndex (const label i) const noexcept
 The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More...
 
const Face & fcValue (const label i) const
 Return forward circular value (ie, next value in the list) More...
 
Face & fcValue (const label i)
 Return forward circular value (ie, next value in the list) More...
 
const Face & rcValue (const label i) const
 Return reverse circular value (ie, previous value in the list) More...
 
Face & rcValue (const label i)
 Return reverse circular value (ie, previous value in the list) More...
 
const Face * cdata () const noexcept
 Return pointer to the underlying array serving as data storage. More...
 
Face * data () 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...
 
Face & front ()
 Access first element of the list, position [0]. More...
 
const Face & front () const
 Access first element of the list. More...
 
Face & back ()
 Access last element of the list, position [size()-1]. More...
 
const Face & back () const
 Access last element of the list, position [size()-1]. More...
 
std::streamsize size_bytes () const noexcept
 Number of contiguous bytes for the List data. More...
 
std::streamsize byteSize () const
 Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More...
 
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 Face &val, label pos=0) const
 Find index of the first occurrence of the value. More...
 
label rfind (const Face &val, label pos=-1) const
 Find index of the last occurrence of the value. More...
 
bool contains (const Face &val, label pos=0) const
 Is the value contained 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< Face > &list)
 Copy the pointer and size held by the given UList. More...
 
void deepCopy (const UList< Face > &list)
 Copy elements of the given UList. Sizes must match! More...
 
void deepCopy (const IndirectListBase< Face, Addr > &list)
 Copy elements of the given indirect list. Sizes must match! More...
 
SubList< Face > slice (const label pos, label len=-1)
 Return SubList slice (non-const access) - no range checking. More...
 
const SubList< Face > slice (const label pos, label len=-1) const
 Return SubList slice (const access) - no range checking. More...
 
SubList< Face > slice (const labelRange &range)
 Return SubList slice (non-const access) - with range checking. More...
 
const SubList< Face > slice (const labelRange &range) const
 Return SubList slice (const access) - with range checking. More...
 
Face & operator[] (const label i)
 Return element of UList. More...
 
const Face & operator[] (const label i) const
 Return element of constant UList. More...
 
const bool & operator[] (const label i) const
 
UPstream::commsStructoperator[] (const label procID)
 
const UPstream::commsStructoperator[] (const label procID) const
 
Foam::UPstream::commsStructoperator[] (const label procID)
 
const Foam::UPstream::commsStructoperator[] (const label procID) const
 
 operator const Foam::List< Face > & () const
 Allow cast to a const List<T>&. More...
 
iterator begin () noexcept
 Return an iterator to begin traversing the UList. More...
 
iterator begin (const label i) noexcept
 Return iterator at offset i from begin, clamped to [0,size] range. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator begin (const label i) const noexcept
 Return const_iterator at offset i from begin, clamped to [0,size] range. More...
 
iterator end () noexcept
 Return an iterator to end traversing the UList. More...
 
const_iterator end () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cbegin (const label i) const noexcept
 Return const_iterator at offset i from begin, clamped to [0,size] range. More...
 
const_iterator cend () 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...
 
const_reverse_iterator rbegin () const
 Return const_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 rend () const
 Return const_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...
 
bool empty () const noexcept
 True if List is empty (ie, size() is zero) More...
 
void swap (UList< Face > &list)
 Swap content with another UList of the same type in constant time. More...
 
bool operator== (const UList< Face > &a) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< Face > &a) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< Face > &list) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< Face > &a) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< Face > &a) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< Face > &a) const
 Return true if !(a < b). Takes linear time. More...
 
IstreamreadList (Istream &is)
 Read List contents from Istream. More...
 
IstreamreadList (Istream &is)
 Specialized list reading for character lists which always uses binary format. More...
 
IstreamreadList (Istream &is)
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write List, with line-breaks in ASCII when length exceeds shortLen. More...
 
OstreamwriteList (Ostream &os, const label) const
 Specialized writeList for character lists which always uses binary format. More...
 
OstreamwriteList (Ostream &os, const label) const
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type test (const label i) const
 Test bool value at specified position, always false for out-of-range access. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type get (const label i) const
 Return bool value at specified position, always false for out-of-range access. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type unset (const label i)
 Unset the bool entry at specified position, always false for out-of-range access. More...
 
Face & first ()
 Access first element of the list, position [0]. More...
 
const Face & first () const
 Access first element of the list. More...
 
Face & last ()
 Access last element of the list, position [size()-1]. More...
 
const Face & last () const
 Access last element of the list, position [size()-1]. More...
 
bool found (const Face &val, label pos=0) const
 Same as contains() More...
 
- Public Member Functions inherited from surfaceFormatsCore
 surfaceFormatsCore ()=default
 Default construct. More...
 
virtual ~surfaceFormatsCore ()=default
 Destructor. More...
 
- Public Member Functions inherited from isoSurfaceParams
 isoSurfaceParams (const algorithmType algo=algorithmType::ALGO_DEFAULT, const filterType filter=filterType::DIAGCELL) noexcept
 Default construct, or with specified algorithm. More...
 
 isoSurfaceParams (const dictionary &dict, const isoSurfaceParams &params=isoSurfaceParams())
 Default construct, setting parameters from dictionary. More...
 
 isoSurfaceParams (const dictionary &dict, const algorithmType algo, const filterType filter=filterType::DIAGCELL)
 Default construct, setting parameters from dictionary. More...
 
algorithmType algorithm () const noexcept
 Get current algorithm. More...
 
void algorithm (algorithmType algo) noexcept
 Set algorithm. More...
 
filterType filter () const noexcept
 Get current filter type. More...
 
void filter (filterType fltr) noexcept
 Set filter type. More...
 
bool snap () const noexcept
 Get point snapping flag. More...
 
void snap (bool on) noexcept
 Set point snapping flag. More...
 
scalar mergeTol () const noexcept
 Get current merge tolerance. More...
 
void mergeTol (const scalar relTol) noexcept
 Set merge tolerance (cell/point algo) More...
 
const boundBoxgetClipBounds () const noexcept
 Get optional clipping bounding box. More...
 
boundBoxgetClipBounds () noexcept
 Access optional clipping bounding box. More...
 
void setClipBounds (const boundBox &bb)
 Set optional clipping bounding box. More...
 
void print (Ostream &os) const
 Print information about the settings. More...
 

Additional Inherited Members

- Public Types inherited from isoSurfaceBase
enum  cutType : uint8_t {
  NOTCUT = 0, CUT = 0x1, TETCUT = 0x2, SPHERE = 0x4,
  ANYCUT = 0xF, UNVISITED = 0x10, BLOCKED = 0x20, SPECIAL = 0xF0
}
 The type of cell/face cuts. More...
 
enum  algorithmType
 The algorithm types. More...
 
enum  filterType
 The filtering (regularization) to apply. More...
 
- Public Types inherited from MeshedSurface< Face >
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< Face >
typedef Face value_type
 The value type the list contains. More...
 
typedef Face * pointer
 The pointer type for non-const access to value_type items. More...
 
typedef const Face * const_pointer
 The pointer type for const access to value_type items. More...
 
typedef Face & reference
 The type used for storing into value_type objects. More...
 
typedef const Face & const_reference
 The type used for reading from constant value_type objects. More...
 
typedef Face * iterator
 Random access iterator for traversing a UList. More...
 
typedef const Face * const_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 Types inherited from isoSurfaceParams
enum  algorithmType : uint8_t { ALGO_DEFAULT = 0, ALGO_TOPO, ALGO_CELL, ALGO_POINT }
 The algorithm types. More...
 
enum  filterType : uint8_t {
  NONE = 0, CELL, DIAGCELL, NONMANIFOLD,
  PARTIAL = CELL, FULL = DIAGCELL, CLEAN = NONMANIFOLD
}
 The filtering (regularization) to apply. More...
 
- Static Public Member Functions inherited from isoSurfaceBase
static autoPtr< isoSurfaceBaseNew (const isoSurfaceParams &params, const volScalarField &cellValues, const scalarField &pointValues, const scalar iso, const bitSet &ignoreCells=bitSet())
 Create for specified algorithm type. More...
 
static void resetCuts (UList< cutType > &cuts)
 Restore non-BLOCKED state to an UNVISITED state. More...
 
- Static Public Member Functions inherited from MeshedSurface< Face >
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< Face >
static const UList< Face > & 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)
 Use IOobject information to resolve file to load from, or empty if the file does not exist. More...
 
static fileName findFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true)
 Use IOobject information to resolve file to load from, or empty if the file does not exist. More...
 
- Static Public Member Functions inherited from isoSurfaceParams
static algorithmType getAlgorithmType (const dictionary &dict, const algorithmType deflt)
 Get 'isoMethod' or 'isoAlgorithm' as enumeration. More...
 
static filterType getFilterType (const dictionary &dict, const filterType deflt)
 Get 'regularise' as bool or enumeration. More...
 
- Static Public Attributes inherited from surfaceFormatsCore
static word nativeExt
 The file extension corresponding to 'native' surface format. More...
 
- Static Public Attributes inherited from isoSurfaceParams
static const Enum< algorithmTypealgorithmNames
 Names for the iso-surface algorithms. More...
 
static const Enum< filterTypefilterNames
 Names for the filtering types. More...
 
- Protected Types inherited from isoSurfaceBase
typedef meshedSurface Mesh
 
typedef cutType cellCutType
 
- Protected Member Functions inherited from isoSurfaceBase
template<class Type >
tmp< Field< Type > > interpolateTemplate (const VolumeField< Type > &cellValues, const Field< Type > &pointValues) const
 Dummy templated interpolate method. More...
 
 isoSurfaceBase (const isoSurfaceBase &)=delete
 No copy construct. More...
 
void operator= (const isoSurfaceBase &)=delete
 No copy assignment. More...
 
- Protected Member Functions inherited from MeshedSurface< Face >
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...
 
template<>
void transcribe (MeshedSurface< face > &surf)
 
template<>
void transcribe (MeshedSurface< face > &surf)
 
template<>
void transcribe (MeshedSurface< face > &surf)
 
- Protected Member Functions inherited from UList< Face >
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...
 
void writeEntry (Ostream &os) const
 Specialized writeEntry for character lists which always uses binary format. More...
 
void writeEntry (Ostream &os) const
 
labelRange validateRange (const labelRange &requestedRange) const
 Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More...
 
UList< Face > & operator= (const UList< Face > &)=delete
 No copy assignment (default: shallow copy) More...
 
- Static Protected Member Functions inherited from isoSurfaceBase
static label countCutType (const UList< cutType > &cuts, const uint8_t maskValue)
 Count the number of cuts matching the mask type. 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")
 Return a surfZone list with a single entry, the size of which corresponds to that of the container. More...
 
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...
 
- Protected Attributes inherited from isoSurfaceBase
const polyMeshmesh_
 Reference to mesh. More...
 
const scalarFieldcVals_
 Cell values. More...
 
const scalarFieldpVals_
 Point values. More...
 
const scalar iso_
 Iso value. More...
 
bitSet ignoreBoundaryFaces_
 Optional boundary faces to ignore. More...
 
labelList meshCells_
 For every face, the original cell in mesh. More...
 

Detailed Description

A surface formed by the iso value. After "Polygonising A Scalar Field Using Tetrahedrons", Paul Bourke (http://paulbourke.net/geometry/polygonise) and "Regularised Marching Tetrahedra: improved iso-surface extraction", G.M. Treece, R.W. Prager and A.H. Gee.

See isoSurface. This is a variant which does tetrahedrisation from triangulation of face to cell centre instead of edge of face to two neighbouring cell centres. This gives much lower quality triangles but they are local to a cell.

Source files

Definition at line 62 of file isoSurfaceCell.H.

Constructor & Destructor Documentation

◆ isoSurfaceCell()

isoSurfaceCell ( const polyMesh mesh,
const scalarField cellValues,
const scalarField pointValues,
const scalar  iso,
const isoSurfaceParams params = isoSurfaceParams(),
const bitSet ignoreCells = bitSet() 
)

◆ ~isoSurfaceCell()

virtual ~isoSurfaceCell ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "isoSurfaceCell"  )

Runtime type information.

◆ interpolate() [1/5]

virtual tmp<Field< scalar > > interpolate ( const VolumeField< scalar > &  cellValues,
const Field< scalar > &  pointValues 
) const
virtual

interpolate scalar cellValues, pointValues on iso-surface

Reimplemented from isoSurfaceBase.

◆ interpolate() [2/5]

virtual tmp<Field< vector > > interpolate ( const VolumeField< vector > &  cellValues,
const Field< vector > &  pointValues 
) const
virtual

interpolate vector cellValues, pointValues on iso-surface

Reimplemented from isoSurfaceBase.

◆ interpolate() [3/5]

virtual tmp<Field< sphericalTensor > > interpolate ( const VolumeField< sphericalTensor > &  cellValues,
const Field< sphericalTensor > &  pointValues 
) const
virtual

interpolate sphericalTensor cellValues, pointValues on iso-surface

Reimplemented from isoSurfaceBase.

◆ interpolate() [4/5]

virtual tmp<Field< symmTensor > > interpolate ( const VolumeField< symmTensor > &  cellValues,
const Field< symmTensor > &  pointValues 
) const
virtual

interpolate symmTensor cellValues, pointValues on iso-surface

Reimplemented from isoSurfaceBase.

◆ interpolate() [5/5]

virtual tmp<Field< tensor > > interpolate ( const VolumeField< tensor > &  cellValues,
const Field< tensor > &  pointValues 
) const
virtual

interpolate tensor cellValues, pointValues on iso-surface

Reimplemented from isoSurfaceBase.

◆ interpolateTemplate()

Foam::tmp<Foam::Field<Type> > interpolateTemplate ( const Field< Type > &  cCoords,
const Field< Type > &  pCoords 
) const

Definition at line 466 of file isoSurfaceCellTemplates.C.

References points.


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