Constructs a cutting surface through a mesh. More...

Inheritance diagram for cuttingSurface:

Collaboration diagram for cuttingSurface:

Public Member Functions
	cuttingSurface (const polyMesh &mesh, const word &surfaceType, const word &surfaceName)
	Construct from components. More...

	cuttingSurface (const word &defaultSurfaceName, const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

virtual	~cuttingSurface ()=default
	Destructor. More...

const word &	surfaceName () const
	The name of the underlying searchableSurface. More...

void	print (Ostream &os) const
	Print information. More...

Public Member Functions inherited from cuttingSurfaceBase
	cuttingSurfaceBase ()
	Construct null. More...

virtual	~cuttingSurfaceBase ()=default
	Destructors. More...

const labelList &	meshCells () const
	The mesh cells cut. More...

labelList &	meshCells ()
	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 ()
	Construct null, an empty surface. More...

	MeshedSurface (const MeshedSurface &surf)
	Copy construct. More...

	MeshedSurface (const UnsortedMeshedSurface< face > &surf)
	Copy construct from an UnsortedMeshedSurface. More...

	MeshedSurface (MeshedSurface &&surf)
	Move construct. More...

	MeshedSurface (UnsortedMeshedSurface< face > &&surf)
	Move construct from an UnsortedMeshedSurface. More...

	MeshedSurface (const pointField &pointLst, const UList< face > &faceLst, const UList< surfZone > &zoneLst)
	Copy construct from components (points, faces, zones). More...

	MeshedSurface (pointField &&pointLst, List< face > &&faceLst, const UList< surfZone > &zoneLst)
	Move construct from components (points, faces). More...

	MeshedSurface (const pointField &pointLst, const UList< face > &faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
	Copy construct from components (points, faces). More...

	MeshedSurface (pointField &&pointLst, List< face > &&faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
	Move construct from components (points, faces). More...

	MeshedSurface (const polyBoundaryMesh &bMesh, const bool globalPoints=false)
	Construct from a boundary mesh with local points/faces. More...

	MeshedSurface (const surfMesh &mesh)
	Construct from a surfMesh. More...

	MeshedSurface (const fileName &name)
	Construct from file name (uses extension to determine type) More...

	MeshedSurface (const fileName &name, const word &ext)
	Construct from file name (uses extension to determine type) More...

	MeshedSurface (Istream &is)
	Construct from Istream. More...

	MeshedSurface (const Time &runTime, const word &surfName=word::null)
	Construct from database. More...

	MeshedSurface (const MeshedSurface< face > &surf)

	MeshedSurface (MeshedSurface< face > &&surf)

bool	read (const fileName &name, const word &ext)
	Read from file. Chooses reader based on explicit extension. More...

virtual bool	read (const fileName &name)
	Read from file. Chooses reader based on detected extension. More...

virtual void	write (const fileName &name, const dictionary &options=dictionary::null) const
	Generic write routine. Chooses writer based on extension. More...

void	write (const Time &t, const word &surfName=word::null) const
	Write to database. More...

	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, const dictionary &options),(name, surf, options))

label	size () const
	The surface size is the number of faces. More...

const List< face > &	surfFaces () const
	Return const access to the faces. More...

const surfZoneList &	surfZones () const
	Const access to the surface zones. More...

const vectorField &	Sf () const
	Face area vectors (normals) More...

const scalarField &	magSf () const
	Face area magnitudes. More...

const vectorField &	Cf () const
	Face centres. More...

virtual void	clear ()
	Clear all storage. More...

virtual void	addZones (const UList< surfZone > &, const bool cullEmpty=false)
	Add surface zones. More...

virtual void	addZones (const labelUList &sizes, const UList< word > &names, const bool cullEmpty=false)
	Add surface zones. More...

virtual void	addZones (const labelUList &sizes, const bool cullEmpty=false)
	Add surface zones. More...

bool	addZonesToFaces ()
	Propagate zone information on face regions. More...

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 bool	stitchFaces (const scalar tol=SMALL, const bool verbose=false)

virtual bool	checkFaces (const bool verbose=false)

virtual label	nTriangles () const
	Count number of triangles. More...

virtual label	nTriangles (List< label > &faceMap) const
	Count number of triangles, returning a face map of original ids. More...

virtual label	triangulate ()
	Triangulate in-place, returning the number of triangles added. More...

virtual label	triangulate (List< label > &faceMap)
	Triangulate in-place, returning the number of triangles added. More...

MeshedSurface	subsetMesh (const BoolListType &include, labelList &pointMap, labelList &faceMap) const
	Return new surface. More...

MeshedSurface	subsetMesh (const bitSet &include) const
	Return new surface. More...

MeshedSurface	subsetMesh (const labelHashSet &include) const
	Return new surface. More...

Foam::MeshedSurface< face >	subsetMesh (const BoolListType &include, labelList &pointMap, labelList &faceMap) const

void	swap (MeshedSurface< face > &surf)
	Swap contents. More...

void	transfer (pointField &pointLst, List< face > &faceLst)
	Transfer the components. More...

void	transfer (MeshedSurface< face > &surf)
	Transfer the contents of the argument and annul the argument. More...

void	transfer (UnsortedMeshedSurface< face > &surf)
	Transfer the contents of the argument and annul the argument. More...

autoPtr< MeshedSurface< face > >	releaseGeom ()
	Release (clear) geometry and return for reuse. More...

void	swapFaces (List< face > &faces)
	Swap the stored faces. More...

void	swapPoints (pointField &points)
	Swap the stored points. More...

void	swapZones (surfZoneList &zones)
	Swap the stored zones. More...

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...

Protected Member Functions
virtual void	performCut (const primitiveMesh &mesh, const bool triangulate, bitSet &&cellIdLabels)
	Cut mesh, restricted to a list of cells. 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	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 ()
	Basic sanity check on zones. More...

pointField &	storedPoints ()
	Non-const access to global points. More...

List< face > &	storedFaces ()
	Non-const access to the faces. More...

surfZoneList &	storedZones ()
	Non-const access to the zones. More...

void	sortFacesAndStore (DynamicList< face > &unsortedFaces, DynamicList< label > &zoneIds, const bool sorted)
	Sort faces by zones and store sorted faces. More...

Additional Inherited Members
Public Types inherited from MeshedSurface< face >
typedef face	FaceType
	Face type used. More...

Static Public Member Functions inherited from MeshedSurface< face >
static void	write (const fileName &name, const MeshedSurface< face > &surf, const dictionary &options=dictionary::null)
	Write to file, selecting writer based on its extension. More...

static void	write (const fileName &name, const word &ext, const MeshedSurface< face > &surf, const dictionary &options=dictionary::null)
	Write to file, selecting writer based on the given extension. More...

static bool	canRead (const fileName &name, bool verbose=false)
	Can we read this file format? More...

static bool	canReadType (const word &ext, bool verbose=false)
	Can we read this file format? More...

static bool	canWriteType (const word &ext, bool verbose=false)
	Can we write this file format? More...

static wordHashSet	readTypes ()
	Known readable file-types. More...

static wordHashSet	writeTypes ()
	Known writable file-types. More...

static autoPtr< MeshedSurface >	New (const fileName &name, const word &ext)
	Select constructed from filename (explicit extension) More...

static autoPtr< MeshedSurface >	New (const fileName &name)
	Select constructed from filename (implicit extension) More...

Static Public Attributes inherited from cuttingSurfaceBase
static int	debug
	Debug information. More...

Protected Types inherited from cuttingSurfaceBase
typedef MeshedSurface< face >	MeshStorage
	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...

Protected Attributes inherited from cuttingSurfaceBase
labelList	meshCells_
	List of the cells cut. More...

Detailed Description

Constructs a cutting surface 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 54 of file cuttingSurface.H.

Constructor & Destructor Documentation

◆ cuttingSurface() [1/2]

cuttingSurface	(	const polyMesh &	mesh,
		const word &	surfaceType,
		const word &	surfaceName
	)

Construct from components.

Definition at line 35 of file cuttingSurface.C.

◆ cuttingSurface() [2/2]

cuttingSurface	(	const word &	defaultSurfaceName,
		const polyMesh &	mesh,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 63 of file cuttingSurface.C.

◆ ~cuttingSurface()

virtual ~cuttingSurface ( )

virtualdefault

Destructor.

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 cellSelectionMask

Implements cuttingSurfaceBase.

Definition at line 93 of file cuttingSurface.C.

References clear(), Foam::constant::electromagnetic::e, Foam::mag(), and mesh.

Here is the call graph for this function:

◆ surfaceName()

const word& surfaceName ( ) const

inline

The name of the underlying searchableSurface.

Definition at line 126 of file cuttingSurface.H.

Referenced by cuttingSurface::print().

Here is the caller graph for this function:

◆ print()

void print ( Ostream & os ) const

Print information.

Definition at line 170 of file cuttingSurface.C.

References points, cuttingSurface::surfaceName(), and MeshedSurface< face >::surfFaces().

Referenced by sampledCuttingSurface::update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ performCut() [2/4]

void performCut

protected

Cut mesh, restricted to a list of cells.

Definition at line 60 of file cuttingSurfaceBase.C.

◆ performCut() [3/4]

void performCut

protected

Cut mesh, restricted to a list of cells.

Definition at line 47 of file cuttingSurfaceBase.C.

◆ performCut() [4/4]

virtual void performCut

protected

Cut mesh, restricted to a list of cells.

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

src/sampling/surface/cutting/cuttingSurface.H
src/sampling/surface/cutting/cuttingSurface.C
src/sampling/surface/cutting/cuttingSurfaceCuts.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cuttingSurface() [1/2]

◆ cuttingSurface() [2/2]

◆ ~cuttingSurface()

Member Function Documentation

◆ performCut() [1/4]

◆ surfaceName()

◆ print()

◆ performCut() [2/4]

◆ performCut() [3/4]

◆ performCut() [4/4]