EBGeometry::ImplicitFunction< T > Class Template Reference

Abstract representation of an implicit function (not necessarily a signed distance function). More...

#include <EBGeometry_ImplicitFunction.hpp>

Inheritance diagram for EBGeometry::ImplicitFunction< T >:

Public Member Functions
	ImplicitFunction ()=default
	Default constructor.
virtual	~ImplicitFunction ()=default
	Default destructor.
virtual T	value (const Vec3T< T > &a_point) const noexcept=0
	Value function. Points are outside the object if value > 0.0 and inside if value < 0.0.
T	operator() (const Vec3T< T > &a_point) const noexcept
	Call operator — alternative signature for the value function.
template<class BV >
BV	approximateBoundingVolumeOctree (const Vec3T< T > &a_initialLowCorner, const Vec3T< T > &a_initialHighCorner, const unsigned int a_maxTreeDepth, const T &a_safety=0.0) const
	Compute an approximation to the bounding volume for the implicit surface using octree subdivision.

Detailed Description

template<class T>
class EBGeometry::ImplicitFunction< T >

Abstract representation of an implicit function (not necessarily a signed distance function).

The value function must be implemented by subclasses. Points with value < 0 are considered inside the object; points with value > 0 are outside.

Template Parameters

T	Floating-point precision.

Member Function Documentation

approximateBoundingVolumeOctree()

template<class T >

template<class BV >

BV EBGeometry::ImplicitFunction< T >::approximateBoundingVolumeOctree ( const Vec3T< T > &  a_initialLowCorner, const Vec3T< T > &  a_initialHighCorner, const unsigned int  a_maxTreeDepth, const T &  a_safety = 0.0  ) const

inline

Compute an approximation to the bounding volume for the implicit surface using octree subdivision.

Recursively subdivides the initial box and marks each child cell as intersected when |value(center)| <= (1+a_safety)*half_width. The bounding volume is built from the corners of all intersected leaf cells. Relies on the implicit function being reasonably close to a signed distance function; if octree subdivision fails entirely, returns the maximally representable bounding volume.

Template Parameters

BV	Bounding volume type; must be constructible from std::vector<Vec3T<T>>.

Parameters

[in]	a_initialLowCorner	Low corner of the initial search box.
[in]	a_initialHighCorner	High corner of the initial search box.
[in]	a_maxTreeDepth	Maximum permitted octree depth.
[in]	a_safety	Safety factor for intersection test; 0 = exact, 1 = 1x cell-width margin.

Returns

Bounding volume enclosing the approximate zero-isosurface region.

operator()()

template<class T >

T EBGeometry::ImplicitFunction< T >::operator() ( const Vec3T< T > &  a_point ) const

noexcept

Call operator — alternative signature for the value function.

Parameters

[in]

a_point

3D query point.

Returns

Implicit function value at a_point (delegates to value()).

value()

template<class T >

virtual T EBGeometry::ImplicitFunction< T >::value ( const Vec3T< T > &  a_point ) const

pure virtualnoexcept

Value function. Points are outside the object if value > 0.0 and inside if value < 0.0.

Parameters

[in]

a_point

3D query point.

Returns

Implicit function value at a_point.

Implemented in EBGeometry::SignedDistanceFunction< T >, EBGeometry::UnionIF< T >, EBGeometry::SmoothUnionIF< T >, EBGeometry::BVHUnionIF< T, P, BV, K >, EBGeometry::BVHSmoothUnionIF< T, P, BV, K >, EBGeometry::IntersectionIF< T >, EBGeometry::SmoothIntersectionIF< T >, EBGeometry::DifferenceIF< T >, EBGeometry::SmoothDifferenceIF< T >, EBGeometry::FiniteRepetitionIF< T >, EBGeometry::ComplementIF< T >, EBGeometry::TranslateIF< T >, EBGeometry::RotateIF< T >, EBGeometry::OffsetIF< T >, EBGeometry::ScaleIF< T >, EBGeometry::AnnularIF< T >, EBGeometry::BlurIF< T >, EBGeometry::MollifyIF< T >, EBGeometry::ElongateIF< T >, and EBGeometry::ReflectIF< T >.

---

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

• Source/EBGeometry_ImplicitFunction.hpp