Low-level components common to various iso-surface algorithms. More...

Inheritance diagram for isoSurfaceBase:

Collaboration diagram for isoSurfaceBase:

Public Types
enum	algorithmType : uint8_t { ALGO_POINT, ALGO_CELL, ALGO_TOPO }
	The algorithm types. More...

enum	filterType : uint8_t { NONE = 0, CELL, DIAGCELL, PARTIAL = CELL, FULL = DIAGCELL }
	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 Member Functions
	isoSurfaceBase (const scalar iso, const boundBox &bounds=boundBox::invertedBox)
	Construct with iso value. More...

scalar	isoValue () const
	The iso-value associated with the surface. More...

const labelList &	meshCells () const
	For each face, the original cell in mesh. More...

labelList &	meshCells ()
	For each face, the original cell in mesh. 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 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...

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

Static Public Member Functions
static filterType	getFilterType (const dictionary &dict, const isoSurfaceBase::filterType deflt)
	Get 'regularise' as bool or enumeration. 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< 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 Public Attributes
static const Enum< algorithmType >	algorithmNames
	Names for the iso-surface algorithms. More...

static const Enum< filterType >	filterNames
	Names for the filtering types. More...

Protected Types
typedef meshedSurface	MeshStorage

Protected Attributes
const scalar	iso_
	Iso value. More...

const boundBox	bounds_
	Optional bounds. More...

labelList	meshCells_
	For every face, the original cell in mesh. More...

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

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

virtual void	remapFaces (const labelUList &faceMapNewToOld)
	Set new zones from faceMap. More...

Detailed Description

Low-level components common to various iso-surface algorithms.

Source files

Definition at line 54 of file isoSurfaceBase.H.

Member Typedef Documentation

◆ MeshStorage

typedef meshedSurface MeshStorage

protected

Definition at line 61 of file isoSurfaceBase.H.

Member Enumeration Documentation

◆ algorithmType

enum algorithmType : uint8_t

The algorithm types.

Enumerator
ALGO_POINT
ALGO_CELL
ALGO_TOPO

Definition at line 78 of file isoSurfaceBase.H.

◆ filterType

enum filterType : uint8_t

strong

The filtering (regularization) to apply.

Enumerator
NONE	No filtering.
CELL	Remove points from pyramid edges.
DIAGCELL	Remove points from pyramid edges and face-diagonals.
PARTIAL	Same as CELL.
FULL	Same as DIAGCELL.

Definition at line 87 of file isoSurfaceBase.H.

Constructor & Destructor Documentation

◆ isoSurfaceBase()

isoSurfaceBase	(	const scalar	iso,
		const boundBox &	bounds = `boundBox::invertedBox`
	)

explicit

Construct with iso value.

Definition at line 103 of file isoSurfaceBase.C.

Member Function Documentation

◆ getFilterType()

Foam::isoSurfaceBase::filterType getFilterType	(	const dictionary &	dict,
		const isoSurfaceBase::filterType	deflt
	)

static

Get 'regularise' as bool or enumeration.

Definition at line 62 of file isoSurfaceBase.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::ListOps::find(), found, Switch::good(), and Foam::nl.

Here is the call graph for this function:

◆ isoValue()

scalar isoValue ( ) const

inline

The iso-value associated with the surface.

Definition at line 130 of file isoSurfaceBase.H.

References isoSurfaceBase::iso_.

◆ meshCells() [1/2]

const labelList& meshCells ( ) const

inline

For each face, the original cell in mesh.

Definition at line 136 of file isoSurfaceBase.H.

References isoSurfaceBase::meshCells_.

◆ meshCells() [2/2]

labelList& meshCells ( )

inline

For each face, the original cell in mesh.

Definition at line 142 of file isoSurfaceBase.H.

References isoSurfaceBase::meshCells_.

Member Data Documentation

◆ iso_

const scalar iso_

protected

Iso value.

Definition at line 66 of file isoSurfaceBase.H.

Referenced by isoSurfaceBase::isoValue().

◆ bounds_

const boundBox bounds_

protected

Optional bounds.

Definition at line 69 of file isoSurfaceBase.H.

◆ meshCells_

labelList meshCells_

protected

For every face, the original cell in mesh.

Definition at line 72 of file isoSurfaceBase.H.

Referenced by isoSurfaceBase::meshCells().

◆ algorithmNames

const Foam::Enum< Foam::isoSurfaceBase::algorithmType > algorithmNames

static

Names for the iso-surface algorithms.

Definition at line 100 of file isoSurfaceBase.H.

Referenced by Foam::getIsoAlgorithm().

◆ filterNames

const Foam::Enum< Foam::isoSurfaceBase::filterType > filterNames

static

Names for the filtering types.

Definition at line 103 of file isoSurfaceBase.H.

Referenced by isoSurfaceTopo::isoSurfaceTopo().

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

src/sampling/surface/isoSurface/isoSurfaceBase.H
src/sampling/surface/isoSurface/isoSurfaceBase.C

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MeshStorage

Member Enumeration Documentation

◆ algorithmType

◆ filterType

Constructor & Destructor Documentation

◆ isoSurfaceBase()

Member Function Documentation

◆ getFilterType()

◆ isoValue()

◆ meshCells() [1/2]

◆ meshCells() [2/2]

Member Data Documentation

◆ iso_

◆ bounds_

◆ meshCells_

◆ algorithmNames

◆ filterNames