cuttingPlane Class Reference

Constructs cutting plane through a mesh. More...

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

Public Member Functions

 cuttingPlane (const plane &pln, const primitiveMesh &mesh, const bool triangulate, const bitSet &cellIdLabels=bitSet())
 
 cuttingPlane (const plane &pln, const primitiveMesh &mesh, const bool triangulate, bitSet &&cellIdLabels)
 
 cuttingPlane (const plane &pln, const primitiveMesh &mesh, const bool triangulate, const labelUList &cellIdLabels)
 
const planeplaneDesc () const
 The plane used. More...
 
planeplaneDesc ()
 The plane used. Non-const access. More...
 
void operator= (const cuttingPlane &rhs)
 Copy assignment. More...
 
- Public Member Functions inherited from plane
 plane ()
 Construct zero-initialised. More...
 
 plane (const vector &normalVector)
 Construct from normal vector through the origin. More...
 
 plane (const point &originPoint, const vector &normalVector, const bool doNormalise=true)
 Construct from normal vector and point in plane. More...
 
 plane (const point &point1, const point &point2, const point &point3)
 Construct from three points in plane. More...
 
 plane (const UList< scalar > &coeffs)
 
 plane (const FixedList< scalar, 4 > &coeffs)
 
 plane (const dictionary &dict)
 Construct from dictionary. More...
 
 plane (Istream &is)
 Construct from Istream. Assumes (normal) (origin) input. More...
 
const vectornormal () const noexcept
 The plane unit normal. More...
 
const pointorigin () const noexcept
 The plane base point. More...
 
pointorigin () noexcept
 The plane base point, for modification. More...
 
void flip ()
 Flip the plane by reversing the normal. More...
 
FixedList< scalar, 4 > planeCoeffs () const
 
point nearestPoint (const point &p) const
 Return nearest point in the plane for the given point. More...
 
scalar distance (const point &p) const
 Return distance (magnitude) from the given point to the plane. More...
 
scalar signedDistance (const point &p) const
 Return distance from the given point to the plane. More...
 
scalar normalIntersect (const point &pnt0, const vector &dir) const
 
scalar normalIntersect (const ray &r) const
 Return cut coefficient for plane and ray. More...
 
template<class Point , class PointRef >
scalar lineIntersect (const line< Point, PointRef > &l) const
 Return the cutting point between the plane and. More...
 
ray planeIntersect (const plane &plane2) const
 Return the cutting line between this plane and another. More...
 
point planePlaneIntersect (const plane &plane2, const plane &plane3) const
 Return the cutting point between this plane and two other planes. More...
 
point somePointInPlane (const scalar dist=1e-3) const
 Return a point somewhere on the plane, a distance from the base. More...
 
side sideOfPlane (const point &p) const
 Return the side of the plane that the point is on. More...
 
int sign (const point &p, const scalar tol=SMALL) const
 The sign for the side of the plane that the point is on. More...
 
point mirror (const point &p) const
 Mirror the supplied point in the plane. Return the mirrored point. More...
 
void writeDict (Ostream &os) const
 Write to dictionary. More...
 
const pointrefPoint () const noexcept
 The plane base point (same as origin) More...
 
- Public Member Functions inherited from cuttingSurfaceBase
 cuttingSurfaceBase ()=default
 Default construct. More...
 
virtual ~cuttingSurfaceBase ()=default
 Destructors. More...
 
const labelListmeshCells () const
 The mesh cells cut. More...
 
labelListmeshCells ()
 The mesh cells cut. More...
 
bool cut () const
 Have any cells been cut? More...
 
void operator= (const cuttingSurfaceBase &rhs)
 Copy assignment. More...
 
- Public Member Functions inherited from MeshedSurface< face >
 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...
 
 MeshedSurface (const MeshedSurface< face > &surf)
 
 MeshedSurface (MeshedSurface< face > &&surf)
 
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...
 
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...
 
 ClassName ("MeshedSurface")
 Declare type-name (with debug switch) 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...
 
bool addZonesToFaces ()
 Specialization for labelledTri. More...
 
bool addZonesToFaces ()
 
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...
 
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...
 
void writeStats (Ostream &os) const
 
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...
 
- Public Member Functions inherited from PrimitivePatch< FaceList, PointField >
 PrimitivePatch (const FaceList &faces, const PointField &points)
 Construct from components. More...
 
 PrimitivePatch (FaceList &&faces, const PointField &points)
 Construct from components, transferring faces. More...
 
 PrimitivePatch (FaceList &faces, PointField &points, const bool reuse)
 Construct from components, reuse storage. More...
 
 PrimitivePatch (const PrimitivePatch< FaceList, 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 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
 
label meshEdge (const label edgei, 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
 
template<class ToPatch >
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...
 
template<class ToPatch >
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...
 
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< FaceList, PointField > &rhs)
 Copy assign faces. Leave points alone (could be a reference). More...
 
void operator= (PrimitivePatch< FaceList, PointField > &&rhs)
 Move assign faces. Leave points alone (could be a reference). More...
 
label whichEdge (const edge &e) const
 Identical to findEdge. More...
 
template<class ToPatch >
Foam::List< Foam::objectHitprojectPoints (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< FaceList, PointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
 
template<class ToPatch >
Foam::List< Foam::objectHitprojectFaceCentres (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< FaceList, PointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
 
- Public Member Functions inherited from PrimitivePatchBase
 ClassName ("PrimitivePatch")
 Runtime type information. More...
 
 PrimitivePatchBase ()=default
 Default construct. More...
 
- Public Member Functions inherited from surfaceFormatsCore
 surfaceFormatsCore ()=default
 Default construct. More...
 
virtual ~surfaceFormatsCore ()=default
 Destructor. More...
 

Protected Member Functions

 cuttingPlane (const plane &pln)
 Construct from a plane description without any cutting. More...
 
virtual void performCut (const primitiveMesh &mesh, const bool triangulate, bitSet &&cellIdLabels)
 Cut mesh, restricted to a list of cells. More...
 
void checkOverlap (const word callerName, const boundBox &meshBounds, const boundBox &userBounds) const
 
bitSet cellSelection (const polyMesh &mesh, const boundBox &userBounds, const wordRes &zoneNames, const word callerName, const bool warn) const
 Define cell selection from bounding-box and zones. More...
 
virtual void performCut (const primitiveMesh &mesh, const bool triangulate, const labelUList &cellIdLabels)
 Cut mesh, restricted to a list of cells. More...
 
virtual void performCut (const primitiveMesh &mesh, const bool triangulate, const bitSet &cellSelectionMask=bitSet())
 Cut mesh, restricted to a list of cells. More...
 
virtual void performCut (const primitiveMesh &mesh, const bool triangulate, bitSet &&cellSelectionMask)=0
 Cut mesh, restricted to a list of cells. More...
 
- Protected Member Functions inherited from cuttingSurfaceBase
template<class EdgeOrientIntersect , class EdgeAlphaIntersect >
void walkCellCuts (const primitiveMesh &mesh, const bitSet &cellCuts, const EdgeOrientIntersect &edgeOrientIntersect, const EdgeAlphaIntersect &edgeAlphaIntersect, const bool triangulate, label nFaceCuts=0)
 Walk cell cuts to create faces. More...
 
virtual void performCut (const primitiveMesh &mesh, const bool triangulate, const labelUList &cellIdLabels)
 Cut mesh, restricted to a list of cells. More...
 
virtual void performCut (const primitiveMesh &mesh, const bool triangulate, const bitSet &cellSelectionMask=bitSet())
 Cut mesh, restricted to a list of cells. More...
 
virtual void performCut (const primitiveMesh &mesh, const bool triangulate, bitSet &&cellSelectionMask)=0
 Cut mesh, restricted to a list of cells. More...
 
virtual void remapFaces (const labelUList &faceMap)
 Remap action on triangulation or cleanup. More...
 
- Protected Member Functions inherited from MeshedSurface< face >
void transcribe (MeshedSurface< face > &surf)
 Transfer points/zones from 'face' to other other shapes. More...
 
void transcribe (MeshedSurface< face > &surf)
 
void transcribe (MeshedSurface< face > &surf)
 
void transcribe (MeshedSurface< face > &surf)
 
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...
 

Additional Inherited Members

- Public Types inherited from plane
enum  side { FRONT = 1 , BACK = -1 , NORMAL = 1 , FLIP = -1 }
 Side of the plane. 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< FaceList, PointField >
enum  surfaceTopo { MANIFOLD , OPEN , ILLEGAL }
 Enumeration defining the surface type. Used in check routines. More...
 
typedef std::remove_reference< FaceList >::type::value_type face_type
 The face type. More...
 
typedef std::remove_reference< PointField >::type::value_type point_type
 The point type. More...
 
typedef FaceList 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...
 
- Static Public Member Functions inherited from MeshedSurface< face >
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 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 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)
 
- Static Public Attributes inherited from cuttingSurfaceBase
static int debug
 Debug information. More...
 
- Static Public Attributes inherited from surfaceFormatsCore
static word nativeExt
 The file extension corresponding to 'native' surface format. More...
 
- Protected Types inherited from cuttingSurfaceBase
typedef meshedSurface Mesh
 Typedef for convenience. More...
 
- Static Protected Member Functions inherited from cuttingSurfaceBase
static void checkOverlap (const word callerName, const boundBox &meshBounds, const boundBox &userBounds)
 Check and warn if bounding boxes do not intersect. More...
 
static bitSet cellSelection (const polyMesh &mesh, const boundBox &userBounds, const wordRes &zoneNames, boundBox &meshBounds)
 Define cell selection from bounding-box and zones. More...
 
static bitSet cellSelection (const polyMesh &mesh, const boundBox &userBounds, const wordRes &zoneNames, const word callerName, const bool warn)
 Define cell selection from bounding-box and zones. 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...
 
- Protected Attributes inherited from cuttingSurfaceBase
labelList meshCells_
 List of the cells cut. More...
 

Detailed Description

Constructs cutting plane through a mesh.

No attempt at resolving degenerate cases. Since the cut faces can be quite ugly, they will often be triangulated.

Source files

Definition at line 58 of file cuttingPlane.H.

Constructor & Destructor Documentation

◆ cuttingPlane() [1/4]

cuttingPlane ( const plane pln)
protected

Construct from a plane description without any cutting.

Definition at line 32 of file cuttingPlane.C.

◆ cuttingPlane() [2/4]

cuttingPlane ( const plane pln,
const primitiveMesh mesh,
const bool  triangulate,
const bitSet cellIdLabels = bitSet() 
)

Construct from plane and mesh reference, possibly restricted to a list of cells

Definition at line 38 of file cuttingPlane.C.

References mesh, cuttingPlane::performCut(), and MeshedSurface< face >::triangulate().

Here is the call graph for this function:

◆ cuttingPlane() [3/4]

cuttingPlane ( const plane pln,
const primitiveMesh mesh,
const bool  triangulate,
bitSet &&  cellIdLabels 
)

Construct from plane and mesh reference, possibly restricted to a list of cells

Definition at line 52 of file cuttingPlane.C.

References mesh, cuttingPlane::performCut(), and MeshedSurface< face >::triangulate().

Here is the call graph for this function:

◆ cuttingPlane() [4/4]

cuttingPlane ( const plane pln,
const primitiveMesh mesh,
const bool  triangulate,
const labelUList cellIdLabels 
)

Construct from plane and mesh reference, possibly restricted to a list of cells

Definition at line 66 of file cuttingPlane.C.

References mesh, cuttingPlane::performCut(), and MeshedSurface< face >::triangulate().

Here is the call graph for this function:

Member Function Documentation

◆ performCut() [1/4]

void performCut ( const primitiveMesh mesh,
const bool  triangulate,
bitSet &&  cellIdLabels 
)
protectedvirtual

Cut mesh, restricted to a list of cells.

Reclaim memory for cellIdLabels

Implements cuttingSurfaceBase.

Definition at line 82 of file cuttingPlane.C.

References e, UList< T >::first(), UList< T >::last(), plane::lineIntersect(), mesh, primitiveMesh::nCells(), and polyMesh::points().

Referenced by cuttingPlane::cuttingPlane().

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

◆ checkOverlap()

void checkOverlap ( const word  callerName,
const boundBox meshBounds,
const boundBox userBounds 
) const
protected

Check and warn if bounding boxes do not intersect, and if the plane does not intersect the bounding boxes

Definition at line 33 of file cuttingPlaneSelection.C.

References cuttingSurfaceBase::checkOverlap(), Foam::endl(), boundBox::intersects(), Foam::nl, boundBox::valid(), and WarningInFunction.

Here is the call graph for this function:

◆ cellSelection()

Foam::bitSet cellSelection ( const polyMesh mesh,
const boundBox userBounds,
const wordRes zoneNames,
const word  callerName,
const bool  warn 
) const
protected

Define cell selection from bounding-box and zones.

Parameters
userBoundsOptionally user-specified bounding box
zoneNamesOptionally user-specified zone names
warnCheck and warn if the plane does not intersect with the bounds of the mesh (or submesh) or if the bounding box does not overlap with the mesh (or submesh)
Returns
A set of nCells size with the selected cells or an empty set if no bounding-box or zones were specified.

Definition at line 66 of file cuttingPlaneSelection.C.

References FIRECore::cellSelection, and mesh.

◆ planeDesc() [1/2]

const plane & planeDesc ( ) const
inline

The plane used.

Definition at line 172 of file cuttingPlane.H.

◆ planeDesc() [2/2]

plane & planeDesc ( )
inline

The plane used. Non-const access.

Definition at line 178 of file cuttingPlane.H.

◆ operator=()

void operator= ( const cuttingPlane rhs)

Copy assignment.

Definition at line 149 of file cuttingPlane.C.

References cuttingSurfaceBase::meshCells().

Here is the call graph for this function:

◆ performCut() [2/4]

void performCut ( const primitiveMesh mesh,
const bool  triangulate,
const labelUList cellIdLabels 
)
protectedvirtual

Cut mesh, restricted to a list of cells.

Reimplemented from cuttingSurfaceBase.

Definition at line 104 of file cuttingSurfaceBase.C.

◆ performCut() [3/4]

void performCut ( const primitiveMesh mesh,
const bool  triangulate,
const bitSet cellSelectionMask = bitSet() 
)
protectedvirtual

Cut mesh, restricted to a list of cells.

Reimplemented from cuttingSurfaceBase.

Definition at line 112 of file cuttingSurfaceBase.C.

◆ performCut() [4/4]

virtual void performCut ( const primitiveMesh mesh,
const bool  triangulate,
bitSet &&  cellSelectionMask 
)
protectedvirtual

Cut mesh, restricted to a list of cells.

Implements cuttingSurfaceBase.


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