Preferences for controlling iso-surface algorithms. More...

Inheritance diagram for isoSurfaceParams:

Collaboration diagram for isoSurfaceParams:

[legend]

Public Types
enum	algorithmType : uint8_t { ALGO_DEFAULT = 0 , ALGO_TOPO , ALGO_CELL , ALGO_POINT }
	The algorithm types. More...
enum class	filterType : uint8_t { NONE = 0 , CELL , DIAGCELL , NONMANIFOLD , PARTIAL = CELL , FULL = DIAGCELL , CLEAN = NONMANIFOLD }
	The filtering (regularization) to apply. More...

Public Member Functions
	isoSurfaceParams (const algorithmType algo=algorithmType::ALGO_DEFAULT, const filterType filter=filterType::DIAGCELL) noexcept
	Default construct, or with specified algorithm.
	isoSurfaceParams (const dictionary &dict, const isoSurfaceParams &params=isoSurfaceParams())
	Default construct, setting parameters from dictionary.
	isoSurfaceParams (const dictionary &dict, const algorithmType algo, const filterType filter=filterType::DIAGCELL)
	Default construct, setting parameters from dictionary.
algorithmType	algorithm () const noexcept
	Get current algorithm.
void	algorithm (algorithmType algo) noexcept
	Set algorithm.
filterType	filter () const noexcept
	Get current filter type.
void	filter (filterType fltr) noexcept
	Set filter type.
bool	snap () const noexcept
	Get point snapping flag.
void	snap (bool on) noexcept
	Set point snapping flag.
scalar	mergeTol () const noexcept
	Get current merge tolerance.
void	mergeTol (const scalar relTol) noexcept
	Set merge tolerance (cell/point algo).
const boundBox &	getClipBounds () const noexcept
	Get optional clipping bounding box.
boundBox &	getClipBounds () noexcept
	Access optional clipping bounding box.
void	setClipBounds (const boundBox &bb)
	Set optional clipping bounding box.
void	print (Ostream &os) const
	Print information about the settings.

Static Public Member Functions
static algorithmType	getAlgorithmType (const dictionary &dict, const algorithmType deflt)
	Get 'isoMethod' or 'isoAlgorithm' as enumeration.
static filterType	getFilterType (const dictionary &dict, const filterType deflt)
	Get 'regularise' as bool or enumeration.

Static Public Attributes
static const Enum< algorithmType >	algorithmNames
	Names for the iso-surface algorithms.
static const Enum< filterType >	filterNames
	Names for the filtering types.

Detailed Description

Preferences for controlling iso-surface algorithms.

Some common dictionary properties:

Property	Description	Required	Default
`isoMethod`	Algorithm (cell/topo/point/default)	no	default
`regularise`	Face simplification (enum or bool)	no	true
`mergeTol`	Point merge tolerance (cell/point)	no	1e-6
`snap`	Point snapping (topo)	no	true
`bounds`	Optional clip bounds	no	inverted

The default algorithm denotes the use of the current standard algorithm.

Filtering types (for topological iso-surface)

none : leave tet cuts untouched
partial , cell : Combine intra-cell faces
full , diagcell : Perform partial and remove face-diagonal points
clean : Perform full and eliminate open edges as well. (May cause excessive erosion!)

Source files

Definition at line 102 of file isoSurfaceParams.H.

Member Enumeration Documentation

enum algorithmType : uint8_t

The algorithm types.

Enumerator
ALGO_DEFAULT	Use current 'standard' algorithm.
ALGO_TOPO
ALGO_CELL
ALGO_POINT

Definition at line 111 of file isoSurfaceParams.H.

enum class filterType : uint8_t

strong

The filtering (regularization) to apply.

Enumerator
NONE	No filtering.
CELL	Remove pyramid edge points.
DIAGCELL	Remove pyramid edge points, face-diagonals.
NONMANIFOLD	Remove pyramid edge points, face-diagonals and non-manifold faces
PARTIAL	Same as CELL.
FULL	Same as DIAGCELL.
CLEAN	Same as NONMANIFOLD.