Public Member Functions | Protected Member Functions | List of all members
cuttingPlane Class Reference

Constructs plane through mesh. More...

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

Public Member Functions

 cuttingPlane (const plane &, const primitiveMesh &, const bool triangulate, const labelUList &cellIdLabels=labelUList::null())
 Construct from plane and mesh reference,. More...
 
const planeplaneDesc () const
 Return plane used. More...
 
const labelListcutCells () const
 Return List of cells cut by the plane. More...
 
bool cut () const
 Return true or false to question: have any cells been cut? More...
 
template<class Type >
tmp< Field< Type > > sample (const Field< Type > &) const
 Sample the cell field. More...
 
template<class Type >
tmp< Field< Type > > sample (const tmp< Field< Type > > &) const
 
void operator= (const cuttingPlane &)
 
template<class Type >
Foam::tmp< Foam::Field< Type > > sample (const Field< Type > &fld) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > sample (const tmp< Field< Type > > &tfld) const
 
- Public Member Functions inherited from plane
 plane (const vector &normalVector)
 Construct from normal vector through the origin. More...
 
 plane (const point &basePoint, const vector &normalVector)
 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 scalarList &C)
 Construct from coefficients for the. More...
 
 plane (const dictionary &planeDict)
 Construct from dictionary. More...
 
 plane (Istream &is)
 Construct from Istream. Assumes the base + normal notation. More...
 
const vectornormal () const
 Return plane normal. More...
 
const pointrefPoint () const
 Return or return plane base point. More...
 
FixedList< scalar, 4 > planeCoeffs () const
 Return coefficients for the. More...
 
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 from the given point to the plane. More...
 
scalar normalIntersect (const point &pnt0, const vector &dir) const
 Return cut coefficient for plane and line defined by. More...
 
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 &) const
 Return the cutting line between this plane and another. More...
 
point planePlaneIntersect (const plane &, const plane &) const
 Return the cutting point between this plane and two other planes. More...
 
side sideOfPlane (const point &p) const
 Return 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 &) const
 Write to dictionary. More...
 
- Public Member Functions inherited from MeshedSurface< face >
 MeshedSurface ()
 Construct null. More...
 
 MeshedSurface (const Xfer< pointField > &, const Xfer< List< face > > &, const Xfer< surfZoneList > &)
 Construct by transferring components (points, faces, zones). More...
 
 MeshedSurface (const Xfer< pointField > &, const Xfer< List< face > > &, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
 Construct by transferring components (points, faces). More...
 
 MeshedSurface (const MeshedSurface &)
 Construct as copy. More...
 
 MeshedSurface (const UnsortedMeshedSurface< face > &)
 Construct from a UnsortedMeshedSurface. More...
 
 MeshedSurface (const polyBoundaryMesh &, const bool globalPoints=false)
 Construct from a boundary mesh with local points/faces. More...
 
 MeshedSurface (const surfMesh &)
 Construct from a surfMesh. More...
 
 MeshedSurface (const Xfer< UnsortedMeshedSurface< face > > &)
 Construct by transferring the contents from a UnsortedMeshedSurface. More...
 
 MeshedSurface (const Xfer< MeshedSurface< face > > &)
 Construct by transferring the contents from a MeshedSurface. More...
 
 MeshedSurface (const fileName &)
 Construct from file name (uses extension to determine type) More...
 
 MeshedSurface (const fileName &, const word &ext)
 Construct from file name (uses extension to determine type) More...
 
 MeshedSurface (const Time &, const word &surfName="")
 Construct from database. More...
 
 ClassName ("MeshedSurface")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, MeshedSurface, fileExtension,( const fileName &name ),(name))
 
virtual ~MeshedSurface ()
 Destructor. More...
 
 declareMemberFunctionSelectionTable (void, UnsortedMeshedSurface, write, fileExtension,( const fileName &name, const MeshedSurface< face > &surf ),(name, surf))
 
virtual void write (const fileName &name) const
 Generic write routine. Chooses writer based on extension. More...
 
void write (const Time &, const word &surfName="") const
 Write to database. More...
 
label size () const
 The surface size is the number of faces. More...
 
const List< face > & faces () const
 Return const access to the faces. More...
 
const List< surfZone > & surfZones () const
 Const access to the surface zones. More...
 
virtual void addZones (const UList< surfZone > &, const bool cullEmpty=false)
 Add surface zones. More...
 
virtual void addZones (const labelUList &sizes, const UList< word > &names, const bool cullEmpty=false)
 Add surface zones. More...
 
virtual void addZones (const labelUList &sizes, const bool cullEmpty=false)
 Add surface zones. More...
 
virtual void removeZones ()
 Remove surface zones. More...
 
virtual void clear ()
 Clear all storage. More...
 
virtual void movePoints (const pointField &)
 Move points. More...
 
virtual void scalePoints (const scalar)
 Scale points. A non-positive factor is ignored. More...
 
virtual void reset (const Xfer< pointField > &points, const Xfer< List< face > > &faces, const Xfer< surfZoneList > &zones)
 Reset primitive data (points, faces and zones) More...
 
virtual void reset (const Xfer< List< point > > &points, const Xfer< List< face > > &faces, const Xfer< surfZoneList > &zones)
 Reset primitive data (points, faces and zones) More...
 
virtual void cleanup (const bool verbose)
 Remove invalid faces. More...
 
virtual bool stitchFaces (const scalar tol=SMALL, const bool verbose=false)
 
virtual bool checkFaces (const bool verbose=false)
 
virtual label triangulate ()
 Triangulate in-place, returning the number of triangles added. More...
 
virtual label triangulate (List< label > &faceMap)
 Triangulate in-place, returning the number of triangles added. More...
 
MeshedSurface subsetMesh (const labelHashSet &include, labelList &pointMap, labelList &faceMap) const
 Return new surface. More...
 
MeshedSurface subsetMesh (const labelHashSet &include) const
 Return new surface. More...
 
void transfer (MeshedSurface< face > &)
 Transfer the contents of the argument and annul the argument. More...
 
void transfer (UnsortedMeshedSurface< face > &)
 Transfer the contents of the argument and annul the argument. More...
 
Xfer< MeshedSurface< face > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool read (const fileName &, const word &ext)
 Read from file. Chooses reader based on explicit extension. More...
 
virtual bool read (const fileName &)
 Read from file. Chooses reader based on detected extension. More...
 
void writeStats (Ostream &os) const
 
void operator= (const MeshedSurface< face > &)
 
 operator MeshedSurfaceProxy< face > () const
 Conversion operator to MeshedSurfaceProxy. More...
 
- Public Member Functions inherited from PrimitivePatch< Face, FaceList, PointField, PointType >
 PrimitivePatch (const FaceList< Face > &faces, const Field< PointType > &points)
 Construct from components. More...
 
 PrimitivePatch (const Xfer< FaceList< Face > > &faces, const Xfer< List< PointType > > &points)
 Construct from components. More...
 
 PrimitivePatch (FaceList< Face > &faces, Field< PointType > &points, const bool reUse)
 Construct from components, reuse storage. More...
 
 PrimitivePatch (const PrimitivePatch< Face, FaceList, PointField, PointType > &)
 Construct as copy. More...
 
virtual ~PrimitivePatch ()
 Destructor. More...
 
void clearOut ()
 
void clearGeom ()
 
void clearTopology ()
 
void clearPatchMeshAddr ()
 
const Field< PointType > & points () const
 Return reference to global points. More...
 
label nPoints () const
 Return number of points supporting patch faces. More...
 
label nEdges () const
 Return number of edges in patch. More...
 
const edgeListedges () const
 Return list of edges, address into LOCAL point list. More...
 
label nInternalEdges () const
 Number of internal edges. More...
 
bool isInternalEdge (const label edgeI) const
 Is internal edge? More...
 
const labelListboundaryPoints () const
 Return list of boundary points,. More...
 
const labelListListfaceFaces () const
 Return face-face addressing. More...
 
const labelListListedgeFaces () const
 Return edge-face addressing. More...
 
const labelListListfaceEdges () const
 Return face-edge addressing. More...
 
const labelListListpointEdges () const
 Return point-edge addressing. More...
 
const labelListListpointFaces () const
 Return point-face addressing. More...
 
const List< Face > & localFaces () const
 Return patch faces addressing into local point list. More...
 
const labelListmeshPoints () const
 Return labelList of mesh points in patch. They are constructed. More...
 
const Map< label > & meshPointMap () const
 Mesh point map. Given the global point index find its. More...
 
const Field< PointType > & localPoints () const
 Return pointField of points in patch. More...
 
const labelListlocalPointOrder () const
 Return orders the local points for most efficient search. More...
 
label whichPoint (const label gp) const
 Given a global point index, return the local point index. More...
 
label whichEdge (const edge &) const
 Given an edge in local point labels, return its. More...
 
labelList meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
 Return labels of patch edges in the global edge list using. More...
 
labelList meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
 Return labels of patch edges in the global edge list using. More...
 
const Field< PointType > & faceCentres () const
 Return face centres for patch. More...
 
const Field< PointType > & faceNormals () const
 Return face normals for patch. More...
 
const Field< PointType > & pointNormals () const
 Return point normals for patch. More...
 
template<class ToPatch >
List< objectHitprojectPoints (const ToPatch &targetPatch, const Field< PointType > &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< PointType > &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=NULL) const
 Check surface formed by patch for manifoldness (see above). More...
 
bool checkPointManifold (const bool report=false, labelHashSet *setPtr=NULL) const
 Checks primitivePatch for faces sharing point but not edge. More...
 
virtual void movePoints (const Field< PointType > &)
 Correct patch after moving points. More...
 
void operator= (const PrimitivePatch< Face, FaceList, PointField, PointType > &)
 Assignment. More...
 
template<class ToPatch >
Foam::List< Foam::objectHitprojectPoints (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
 
template<class ToPatch >
Foam::List< Foam::objectHitprojectFaceCentres (const ToPatch &targetPatch, const Field< PointType > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const
 
- Public Member Functions inherited from surfaceFormatsCore
 surfaceFormatsCore ()
 Construct null. More...
 
virtual ~surfaceFormatsCore ()
 Destructor. More...
 

Protected Member Functions

 cuttingPlane (const plane &)
 Construct plane description without cutting. More...
 
void reCut (const primitiveMesh &, const bool triangulate, const labelUList &cellIdLabels=labelUList::null())
 Recut mesh with existing planeDesc, 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 > &)
 Transfer points/zones and transcribe face -> triFace. More...
 
void checkZones ()
 Basic sanity check on zones. More...
 
pointFieldstoredPoints ()
 Non-const access to global points. More...
 
List< face > & storedFaces ()
 Non-const access to the faces. More...
 
surfZoneListstoredZones ()
 Non-const access to the zones. More...
 
void sortFacesAndStore (const Xfer< List< face > > &unsortedFaces, const Xfer< List< label > > &zoneIds, const bool sorted)
 Sort faces by zones and store sorted faces. More...
 

Additional Inherited Members

- Public Types inherited from plane
enum  side { NORMAL, FLIP }
 Side of the plane. More...
 
- Public Types inherited from MeshedSurface< face >
typedef face FaceType
 Face type used. More...
 
- Public Types inherited from PrimitivePatch< Face, FaceList, PointField, PointType >
enum  surfaceTopo { MANIFOLD, OPEN, ILLEGAL }
 Enumeration defining the surface type. Used in check routines. More...
 
typedef Face FaceType
 
typedef FaceList< Face > FaceListType
 
typedef PointField PointFieldType
 
- Static Public Member Functions inherited from MeshedSurface< face >
static bool isTri ()
 Face storage only handles triangulated faces. More...
 
static bool canRead (const fileName &, const bool verbose=false)
 Can we read this file format? More...
 
static bool canReadType (const word &ext, const bool verbose=false)
 Can we read this file format? More...
 
static bool canWriteType (const word &ext, const bool verbose=false)
 Can we write this file format? More...
 
static wordHashSet readTypes ()
 
static wordHashSet writeTypes ()
 
static autoPtr< MeshedSurfaceNew (const fileName &, const word &ext)
 Select constructed from filename (explicit extension) More...
 
static autoPtr< MeshedSurfaceNew (const fileName &)
 Select constructed from filename (implicit extension) More...
 
static void write (const fileName &, const MeshedSurface< face > &)
 Write to file. More...
 
- Static Public Member Functions inherited from surfaceFormatsCore
static bool checkSupport (const wordHashSet &available, const word &ext, const bool verbose, const word &functionName)
 
static fileName localMeshFileName (const word &surfName="")
 Return the local file name (within time directory) More...
 
static fileName findMeshInstance (const Time &, const word &surfName="")
 Find instance with surfName. More...
 
static fileName findMeshFile (const Time &, const word &surfName="")
 Find mesh file with surfName. More...
 
- Static Public Attributes inherited from surfaceFormatsCore
static word nativeExt
 The file extension corresponding to 'native' surface format. More...
 
- Static Protected Member Functions inherited from surfaceFormatsCore
template<class Container >
static List< surfZoneoneZone (const Container &container, const word &name="zone0")
 Return a list with a single entry,. More...
 
static string getLineNoComment (IFstream &)
 Read non-comment line. More...
 

Detailed Description

Constructs plane through mesh.

No attempt at resolving degenerate cases. Since the cut faces are usually quite ugly, they will always be triangulated.

Note
When the cutting plane coincides with a mesh face, the cell edge on the positive side of the plane is taken.
Source files

Definition at line 60 of file cuttingPlane.H.

Constructor & Destructor Documentation

cuttingPlane ( const plane pln)
protected

Construct plane description without cutting.

Definition at line 340 of file cuttingPlane.C.

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

Construct from plane and mesh reference,.

possibly restricted to a list of cells

Definition at line 348 of file cuttingPlane.C.

References cuttingPlane::reCut().

Here is the call graph for this function:

Member Function Documentation

void reCut ( const primitiveMesh mesh,
const bool  triangulate,
const labelUList cellIdLabels = labelUList::null() 
)
protected

Recut mesh with existing planeDesc, restricted to a list of cells.

Definition at line 365 of file cuttingPlane.C.

References List< T >::clear(), MeshedSurface< face >::clear(), plane::normal(), primitiveMesh::points(), plane::refPoint(), and cuttingPlane::remapFaces().

Referenced by cuttingPlane::cuttingPlane().

Here is the call graph for this function:

Here is the caller graph for this function:

void remapFaces ( const labelUList faceMap)
protectedvirtual

Remap action on triangulation or cleanup.

Reimplemented from MeshedSurface< face >.

Definition at line 390 of file cuttingPlane.C.

References forAll, Foam::notNull(), MeshedSurface< face >::remapFaces(), UList< T >::size(), and List< T >::transfer().

Referenced by cuttingPlane::reCut().

Here is the call graph for this function:

Here is the caller graph for this function:

const plane& planeDesc ( ) const
inline

Return plane used.

Definition at line 152 of file cuttingPlane.H.

const labelList& cutCells ( ) const
inline

Return List of cells cut by the plane.

Definition at line 158 of file cuttingPlane.H.

Referenced by sampledPlane::meshCells(), and cuttingPlane::operator=().

Here is the caller graph for this function:

bool cut ( ) const
inline

Return true or false to question: have any cells been cut?

Definition at line 164 of file cuttingPlane.H.

References cuttingPlane::operator=(), cuttingPlane::sample(), and List< T >::size().

Here is the call graph for this function:

tmp<Field<Type> > sample ( const Field< Type > &  ) const

Sample the cell field.

Referenced by cuttingPlane::cut(), and cuttingPlane::sample().

Here is the caller graph for this function:

tmp<Field<Type> > sample ( const tmp< Field< Type > > &  ) const
void operator= ( const cuttingPlane rhs)

Definition at line 411 of file cuttingPlane.C.

References Foam::abort(), cuttingPlane::cutCells(), Foam::FatalError, and FatalErrorIn.

Referenced by cuttingPlane::cut().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::tmp<Foam::Field<Type> > sample ( const Field< Type > &  fld) const

Definition at line 37 of file cuttingPlaneTemplates.C.

References fld(), and cuttingPlane::sample().

Here is the call graph for this function:

Foam::tmp<Foam::Field<Type> > sample ( const tmp< Field< Type > > &  tfld) const

Definition at line 47 of file cuttingPlaneTemplates.C.


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