Base for creating a MeshedSurface by performing some type of cell cutting/intersection. More...

Inheritance diagram for cuttingSurfaceBase:

Collaboration diagram for cuttingSurfaceBase:

Public Member Functions
	cuttingSurfaceBase ()=default
	Default construct. 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 >
	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 labelList &	faceIds () const
	Return const access to faces ids. More...

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

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

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

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

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

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

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

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

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

virtual void	removeZones ()
	Remove surface zones. More...

virtual void	movePoints (const pointField &newPoints)
	Move points. More...

virtual void	scalePoints (const scalar scaleFactor)
	Scale points. A non-positive factor is ignored. More...

virtual void	cleanup (const bool verbose)
	Remove invalid faces. More...

virtual 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 ()

Static Public Attributes
static int	debug
	Debug information. More...

Protected Types
typedef meshedSurface	Mesh
	Typedef for convenience. More...

Protected Member Functions
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	checkZones (const bool verbose=true)
	Sanity check/resizing on zones. More...

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

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

labelList &	storedFaceIds ()
	Non-const access to face ids. More...

surfZoneList &	storedZones ()
	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...

template<>
void	transcribe (MeshedSurface< face > &surf)

template<>
void	transcribe (MeshedSurface< face > &surf)

template<>
void	transcribe (MeshedSurface< face > &surf)

Static Protected Member Functions
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
labelList	meshCells_
	List of the cells cut. More...

Additional Inherited Members
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...

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< MeshedSurface >	New (const fileName &name, const word &fileType, bool mandatory=true)
	Read construct from filename with given file type. More...

static autoPtr< MeshedSurface >	New (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...

Detailed Description

Base for creating a MeshedSurface by performing some type of cell cutting/intersection.

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

Source files

Definition at line 60 of file cuttingSurfaceBase.H.

Member Typedef Documentation

◆ Mesh

typedef meshedSurface Mesh

protected

Typedef for convenience.

Definition at line 67 of file cuttingSurfaceBase.H.

Constructor & Destructor Documentation

◆ cuttingSurfaceBase()

cuttingSurfaceBase ( )

default

Default construct.

◆ ~cuttingSurfaceBase()

virtual ~cuttingSurfaceBase ( )

virtualdefault

Destructors.

Member Function Documentation

◆ walkCellCuts()

void walkCellCuts	(	const primitiveMesh &	mesh,
		const bitSet &	cellCuts,
		const EdgeOrientIntersect &	edgeOrientIntersect,
		const EdgeAlphaIntersect &	edgeAlphaIntersect,
		const bool	triangulate,
		label	nFaceCuts = `0`
	)

protected

Walk cell cuts to create faces.

Template Parameters

EdgeOrientIntersect	Parameter (edge&), returns bool. Orient edge for a consistent positive gradient. Checks for edge intersection (true\|false).
EdgeAlphaIntersect	Parameter (const edge&), returns scalar. Determine alpha [0-1] for an intersecting edge. No guarantees when used with non-intersecting edges.

Parameters

cellCuts [in] The cells to walk.

Definition at line 36 of file cuttingSurfaceBaseTemplates.C.

References Foam::constant::atomic::alpha, DynamicList< T, SizeMin >::append(), HashTable< T, edge, Hash< edge > >::begin(), cells, DynamicList< T, SizeMin >::clear(), HashTable< T, Key, Hash >::clear(), HashTable< T, edge, Hash< edge > >::clear(), DebugInfo, Foam::constant::electromagnetic::e, Foam::endl(), HashTable< T, edge, Hash< edge > >::erase(), f(), Foam::flatOutput(), forAll, forAllIters, HashTable< T, Key, Hash >::found(), HashSet< Key, Hash >::insert(), HashTable< T, edge, Hash< edge > >::insert(), HashTable< T, Key, Hash >::insert(), HashTable< T, Key, Hash >::lookup(), mesh, Foam::nl, p0, points, DynamicList< T, SizeMin >::resize(), HashTable< T, edge, Hash< edge > >::size(), Foam::HashTableOps::values(), edge::vec(), and WarningInFunction.

Here is the call graph for this function:

◆ performCut() [1/3]

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

protectedvirtual

Cut mesh, restricted to a list of cells.

Definition at line 54 of file cuttingSurfaceBase.C.

References mesh, Foam::notNull(), PackedList< Width >::resize(), and bitSet::set().

Here is the call graph for this function:

◆ performCut() [2/3]

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

protectedvirtual

Cut mesh, restricted to a list of cells.

Definition at line 41 of file cuttingSurfaceBase.C.

References mesh.

◆ performCut() [3/3]

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

protectedpure virtual

Cut mesh, restricted to a list of cells.

Reclaim memory for cellSelectionMask

Implemented in cuttingPlane, and cuttingSurface.

◆ remapFaces()

void remapFaces ( const labelUList & faceMap )

protectedvirtual

Remap action on triangulation or cleanup.

Reimplemented from MeshedSurface< Face >.

Definition at line 73 of file cuttingSurfaceBase.C.

References Foam::faceMap(), forAll, cuttingSurfaceBase::meshCells_, MeshedSurface< face >::remapFaces(), and List< T >::transfer().

Here is the call graph for this function:

◆ checkOverlap()

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

staticprotected

Check and warn if bounding boxes do not intersect.

Definition at line 34 of file cuttingSurfaceBaseSelection.C.

References Foam::endl(), Foam::nl, boundBox::overlaps(), boundBox::valid(), and WarningInFunction.

Here is the call graph for this function:

◆ cellSelection() [1/2]

Foam::bitSet cellSelection	(	const polyMesh &	mesh,
		const boundBox &	userBounds,
		const wordRes &	zoneNames,
		boundBox &	meshBounds
	)

staticprotected

Define cell selection from bounding-box and zones.

Parameters

userBounds	Optionally user-specified bounding box
zoneNames	Optionally user-specified zone names
meshBounds	[out] The effective mesh bounds after applying the user-specified zone names

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 53 of file cuttingSurfaceBaseSelection.C.

References boundBox::add(), C, boundBox::clear(), boundBox::contains(), boundBox::empty(), mesh, boundBox::reduce(), PackedList< Width >::resize(), Foam::returnReduce(), and bitSet::set().

Here is the call graph for this function:

◆ cellSelection() [2/2]

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

staticprotected

Define cell selection from bounding-box and zones.

Parameters

userBounds	Optionally user-specified bounding box
zoneNames	Optionally user-specified zone names
callerName	The caller name for warnings
warn	Check and warn 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 150 of file cuttingSurfaceBaseSelection.C.

References mesh.

◆ meshCells() [1/2]

const labelList& meshCells ( ) const

inline

The mesh cells cut.

Definition at line 197 of file cuttingSurfaceBase.H.

References cuttingSurfaceBase::meshCells_.

Referenced by cuttingPlane::operator=(), and cuttingSurfaceBase::operator=().

Here is the caller graph for this function:

◆ meshCells() [2/2]

labelList& meshCells ( )

inline

The mesh cells cut.

Definition at line 203 of file cuttingSurfaceBase.H.

References cuttingSurfaceBase::meshCells_.

◆ cut()

bool cut ( ) const

inline

Have any cells been cut?

Definition at line 209 of file cuttingSurfaceBase.H.

References cuttingSurfaceBase::meshCells_.

◆ operator=()

void operator= ( const cuttingSurfaceBase & rhs )

Copy assignment.

Definition at line 91 of file cuttingSurfaceBase.C.

References cuttingSurfaceBase::meshCells().

Here is the call graph for this function:

Member Data Documentation

◆ meshCells_

labelList meshCells_

protected

List of the cells cut.

Definition at line 73 of file cuttingSurfaceBase.H.

Referenced by cuttingSurfaceBase::cut(), cuttingSurfaceBase::meshCells(), and cuttingSurfaceBase::remapFaces().

◆ debug

int debug

static

Debug information.

Definition at line 181 of file cuttingSurfaceBase.H.

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

src/sampling/surface/cutting/cuttingSurfaceBase.H
src/sampling/surface/cutting/cuttingSurfaceBase.C
src/sampling/surface/cutting/cuttingSurfaceBaseSelection.C
src/sampling/surface/cutting/cuttingSurfaceBaseTemplates.C

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Mesh

Constructor & Destructor Documentation

◆ cuttingSurfaceBase()

◆ ~cuttingSurfaceBase()

Member Function Documentation

◆ walkCellCuts()

◆ performCut() [1/3]

◆ performCut() [2/3]

◆ performCut() [3/3]

◆ remapFaces()

◆ checkOverlap()

◆ cellSelection() [1/2]

◆ cellSelection() [2/2]

◆ meshCells() [1/2]

◆ meshCells() [2/2]

◆ cut()

◆ operator=()

Member Data Documentation

◆ meshCells_

◆ debug