EBGeometry::TorusSDF< T > Class Template Reference

Signed distance field for a torus. More...

#include <EBGeometry_AnalyticDistanceFunctions.hpp>

Inheritance diagram for EBGeometry::TorusSDF< T >:

Collaboration diagram for EBGeometry::TorusSDF< T >:

Public Member Functions
	TorusSDF ()=default
	Default constructor. Constructs a torus centered at the origin with major radius 1 and minor radius 0.5.
	TorusSDF (const Vec3T< T > &a_center, const T &a_majorRadius, const T &a_minorRadius) noexcept
	Full constructor.
	TorusSDF (const TorusSDF &)=default
	Copy constructor.
	TorusSDF (TorusSDF &&)=default
	Move constructor.
TorusSDF &	operator= (const TorusSDF &)=default
	Copy assignment.
TorusSDF &	operator= (TorusSDF &&)=default
	Move assignment.
	~TorusSDF () override=default
	Destructor.
const Vec3T< T > &	getCenter () const noexcept
	Get torus center.
Vec3T< T > &	getCenter () noexcept
	Get torus center.
const T &	getMajorRadius () const noexcept
	Get major radius.
T &	getMajorRadius () noexcept
	Get major radius.
const T &	getMinorRadius () const noexcept
	Get minor radius.
T &	getMinorRadius () noexcept
	Get minor radius.
T	signedDistance (const Vec3T< T > &a_point) const noexcept override
	Signed distance function for the torus.
Public Member Functions inherited from EBGeometry::SignedDistanceFunction< T >
	SignedDistanceFunction ()=default
	Default constructor.
	~SignedDistanceFunction () override=default
	Destructor.
T	value (const Vec3T< T > &a_point) const noexcept final
	Implementation of ImplicitFunction::value; delegates to signedDistance().
virtual Vec3T< T >	normal (const Vec3T< T > &a_point, const T &a_delta) const noexcept
	Compute the outward normal using central finite differences.
Public Member Functions inherited from EBGeometry::ImplicitFunction< T >
	ImplicitFunction ()=default
	Default constructor.
virtual	~ImplicitFunction ()=default
	Default destructor.
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.

Protected Attributes
Vec3T< T >	m_center = Vec3T<T>::zeros()
	Torus center.
T	m_majorRadius = T(1)
	Major (ring) radius.
T	m_minorRadius = T(0.5)
	Minor (tube) radius.

Detailed Description

template<class T>
class EBGeometry::TorusSDF< T >

Signed distance field for a torus.

The torus ring lies in the xy-plane and is centred at m_center. The major radius m_majorRadius is the distance from the torus centre to the centre-line of the tube; the minor radius m_minorRadius is the tube radius. The bounding box spans [center ± (majorRadius + minorRadius)] in x and y, and [center ± minorRadius] in z. The SDF is negative inside the tube and positive outside. The minor radius must be strictly less than the major radius; otherwise the tube would self-intersect at the torus centre. By default the torus is centred at the origin with major radius 1 and minor radius 0.5.

Template Parameters

T	Floating-point precision.

Constructor & Destructor Documentation

TorusSDF()

template<class T >

EBGeometry::TorusSDF< T >::TorusSDF ( const Vec3T< T > &  a_center, const T &  a_majorRadius, const T &  a_minorRadius  )

inlinenoexcept

Full constructor.

Parameters

[in]	a_center	Torus center.
[in]	a_majorRadius	Major (ring) radius.
[in]	a_minorRadius	Minor (tube) radius.

Member Function Documentation

getCenter() [1/2]

template<class T >

const Vec3T< T > & EBGeometry::TorusSDF< T >::getCenter ( ) const

inlinenoexcept

Get torus center.

Returns

m_center

getCenter() [2/2]

template<class T >

Vec3T< T > & EBGeometry::TorusSDF< T >::getCenter ( )

inlinenoexcept

Get torus center.

Returns

m_center

getMajorRadius() [1/2]

template<class T >

const T & EBGeometry::TorusSDF< T >::getMajorRadius ( ) const

inlinenoexcept

Get major radius.

Returns

m_majorRadius

getMajorRadius() [2/2]

template<class T >

T & EBGeometry::TorusSDF< T >::getMajorRadius ( )

inlinenoexcept

Get major radius.

Returns

m_majorRadius

getMinorRadius() [1/2]

template<class T >

const T & EBGeometry::TorusSDF< T >::getMinorRadius ( ) const

inlinenoexcept

Get minor radius.

Returns

m_minorRadius

getMinorRadius() [2/2]

template<class T >

T & EBGeometry::TorusSDF< T >::getMinorRadius ( )

inlinenoexcept

Get minor radius.

Returns

m_minorRadius

operator=() [1/2]

template<class T >

TorusSDF & EBGeometry::TorusSDF< T >::operator= ( const TorusSDF< T > &  )

default

Copy assignment.

Returns

Reference to (*this).

operator=() [2/2]

template<class T >

TorusSDF & EBGeometry::TorusSDF< T >::operator= ( TorusSDF< T > &&  )

default

Move assignment.

Returns

Reference to (*this).

signedDistance()

template<class T >

T EBGeometry::TorusSDF< T >::signedDistance ( const Vec3T< T > &  a_point ) const

inlineoverridevirtualnoexcept

Signed distance function for the torus.

Parameters

[in]

a_point

Position.

Returns

Signed distance from a_point to the torus surface; negative inside the torus tube.

Implements EBGeometry::SignedDistanceFunction< T >.

---

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

• Source/EBGeometry_AnalyticDistanceFunctions.hpp