A surface defined by a distance from an input searchable surface. Uses an iso-surface algorithm (cell, topo, point) for constructing the distance surface. More...

Inheritance diagram for distanceSurface:

[legend]

Public Member Functions
	TypeName ("distanceSurface")

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

	distanceSurface (const polyMesh &mesh, const word &surfaceType, const word &surfaceName, const isoSurfaceParams &params=isoSurfaceParams(), const bool interpolate=false)

	distanceSurface (const polyMesh &mesh, const bool interpolate, const word &surfaceType, const word &surfaceName, const scalar distance, const bool useSignedDistance, const isoSurfaceParams &params=isoSurfaceParams())

	distanceSurface (const polyMesh &mesh, const bool interpolate, autoPtr< searchableSurface > &&surface, const scalar distance, const bool useSignedDistance, const isoSurfaceParams &params=isoSurfaceParams())

virtual	~distanceSurface ()=default

void	createGeometry ()

const word &	surfaceName () const

scalar	distance () const noexcept

const meshedSurface &	surface () const

meshedSurface &	surface ()

const labelList &	meshCells () const

labelList &	meshCells ()

void	print (Ostream &os, int level=0) const

Protected Member Functions
bool	hasIsoSurface () const

template<class Type >
tmp< Field< Type > >	isoSurfaceInterpolate (const GeometricField< Type, fvPatchField, volMesh > &cellValues, const Field< Type > &pointValues) const

bool	refineBlockedCells (bitSet &ignoreCells, const isoSurfaceBase &isoContext) const

bitSet	filterPrepareRegionSplit (const bitSet &ignoreCells) const

void	filterKeepLargestRegion (bitSet &ignoreCells) const

void	filterKeepNearestRegions (bitSet &ignoreCells) const

void	filterRegionProximity (bitSet &ignoreCells) const

void	filterFaceProximity ()

Detailed Description

A surface defined by a distance from an input searchable surface. Uses an iso-surface algorithm (cell, topo, point) for constructing the distance surface.

For a zero-distance surface, it performs additional checks and supports filtering to handle the surface boundaries.

Usage

Example of function object partial specification:

surfaces
{
    surface1
    {
        type        distanceSurface;
        surfaceType triSurfaceMesh;
        surfaceName something.obj;
        topology    proximityFaces;
    }

    surface2
    {
        type        distanceSurface;
        surfaceType triSurfaceMesh;
        surfaceName other.obj;

        topology    nearestPoints;
        nearestPoints
        (
            (0 0 0)
            (10 10 0)
        );

        // Max search distance for nearestPoints
        maxDistance 0.005;
    }
}

Dictionary controls:

Property	Description	Required	Default
`distance`	distance from surface	no	0
`signed`	Use sign when distance is positive	no	true
`isoMethod`	Iso-algorithm (cell/topo/point)	no	default
`regularise`	Face simplification (enum or bool)	no	true
`bounds`	Limit with bounding box	no
`surfaceType`	Type of surface	yes
`surfaceName`	Name of surface in `triSurface/`	no	dict name
`topology`	Topology filter name	no	none
`nearestPoints`	Points for point-based segmentation	no
`maxDistance`	Max search distance for nearestPoints	no	GREAT
`absProximity`	Max proximity of face centres	no	1e-5

Topology/Filtering (for zero-distance only). These represent different ways to tackle the "ragged edge" problem.

none : No filtering
proximityFaces or proximity (post-filter): Checks the resulting faces against the original search surface and rejects faces with a distance greater than absProximity.
proximityRegions (post-filter): Checks the distance of the resulting faces against the original search surface. Filters based on the area-weighted distance of each topologically connected region. If the area-weighted distance of a region is greater than absProximity, the entire region is rejected.
largestRegion (pre-filter): The cut cells are checked for topological connectivity and the region with the most number of cut cells is retained.
nearestPoints (pre-filter): The cut cells split into regions, the regions closest to the user-defined points are retained. Uses maxDistance for additional control.

Note

For distance = 0, some special adjustments.

Always signed (ignoring the input value).
Use normal distance from surface (for better treatment of open edges).
Additional checks for open surfaces edges are used to limit the extend of resulting distance surface. The resulting surface elements will, however, contain partial cell coverage. NB: Not applicable if the point isoMethod is used.

The keyword cell (bool value) which was use in 1906 and earlier to switch between point/cell algorithms is now ignored (2020-12).

Changed default algorithm from cell to topo (2020-12).

Source files

Definition at line 205 of file distanceSurface.H.

Constructor & Destructor Documentation

◆ distanceSurface() [1/4]

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

Definition at line 243 of file distanceSurface.C.

References dict, and Foam::sqr().

Here is the call graph for this function:

◆ distanceSurface() [2/4]

distanceSurface	(	const polyMesh &	mesh,
		const word &	surfaceType,
		const word &	surfaceName,
		const isoSurfaceParams &	params = `isoSurfaceParams()`,
		const bool	interpolate = `false`
	)

Definition at line 313 of file distanceSurface.C.

◆ distanceSurface() [3/4]

distanceSurface	(	const polyMesh &	mesh,
		const bool	interpolate,
		const word &	surfaceType,
		const word &	surfaceName,
		const scalar	distance,
		const bool	useSignedDistance,
		const isoSurfaceParams &	params = `isoSurfaceParams()`
	)

Definition at line 335 of file distanceSurface.C.

◆ distanceSurface() [4/4]

distanceSurface	(	const polyMesh &	mesh,
		const bool	interpolate,
		autoPtr< searchableSurface > &&	surface,
		const scalar	distance,
		const bool	useSignedDistance,
		const isoSurfaceParams &	params = `isoSurfaceParams()`
	)