EBGeometry::AnnularIF< T > Class Template Reference

Annular implicit function. Creates a shell out of the implicit function. More...

#include <EBGeometry_Transform.hpp>

Inheritance diagram for EBGeometry::AnnularIF< T >:

Collaboration diagram for EBGeometry::AnnularIF< T >:

Public Member Functions
	AnnularIF ()=delete
	Disallowed weak construction.
	AnnularIF (const AnnularIF &a_other) noexcept=default
	Copy constructor.
	AnnularIF (AnnularIF &&a_other) noexcept=default
	Move constructor.
	AnnularIF (const std::shared_ptr< ImplicitFunction< T > > &a_implicitFunction, const T a_delta) noexcept
	Full constructor.
	~AnnularIF () override=default
	Destructor.
AnnularIF &	operator= (const AnnularIF &a_other) noexcept=default
	Copy assignment operator.
AnnularIF &	operator= (AnnularIF &&a_other) noexcept=default
	Move assignment operator.
T	value (const Vec3T< T > &a_point) const noexcept override
	Value function.
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
std::shared_ptr< const ImplicitFunction< T > >	m_implicitFunction = nullptr
	Original implicit function.
T	m_delta
	Shell thickness.

Detailed Description

template<class T>
class EBGeometry::AnnularIF< T >

Annular implicit function. Creates a shell out of the implicit function.

Template Parameters

T	Floating-point precision

Constructor & Destructor Documentation

AnnularIF() [1/3]

template<class T >

EBGeometry::AnnularIF< T >::AnnularIF ( const AnnularIF< T > &  a_other )

defaultnoexcept

Copy constructor.

Parameters

[in]

a_other

Other AnnularIF.

AnnularIF() [2/3]

template<class T >

EBGeometry::AnnularIF< T >::AnnularIF ( AnnularIF< T > &&  a_other )

defaultnoexcept

Move constructor.

Parameters

[in,out]

a_other

Other AnnularIF.

AnnularIF() [3/3]

template<class T >

EBGeometry::AnnularIF< T >::AnnularIF ( const std::shared_ptr< ImplicitFunction< T > > &  a_implicitFunction, const T  a_delta  )

noexcept

Full constructor.

Parameters

[in]	a_implicitFunction	Input implicit function.
[in]	a_delta	Shell thickness (at least if the implicit function is also signed distance)

Member Function Documentation

operator=() [1/2]

template<class T >

AnnularIF & EBGeometry::AnnularIF< T >::operator= ( AnnularIF< T > &&  a_other )

defaultnoexcept

Move assignment operator.

Parameters

[in,out]

a_other

Other AnnularIF.

Returns

Reference to (*this).

operator=() [2/2]

template<class T >

AnnularIF & EBGeometry::AnnularIF< T >::operator= ( const AnnularIF< T > &  a_other )

defaultnoexcept

Copy assignment operator.

Parameters

[in]

a_other

Other AnnularIF.

Returns

Reference to (*this).

value()

template<class T >

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

overridevirtualnoexcept

Value function.

Parameters

[in]

a_point

Query point

Returns

std::abs(f(a_point)) - m_delta, hollowing out the shape at distance m_delta from the surface

Implements EBGeometry::ImplicitFunction< T >.

---

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

• Source/EBGeometry_Transform.hpp