EBGeometry::OffsetIF< T > Class Template Reference

Offset implicit function. Offsets (grows or shrinks) the implicit function by a constant. More...

#include <EBGeometry_Transform.hpp>

Inheritance diagram for EBGeometry::OffsetIF< T >:

Collaboration diagram for EBGeometry::OffsetIF< T >:

Public Member Functions
	OffsetIF ()=delete
	Disallowed weak construction.
	OffsetIF (const OffsetIF &a_other) noexcept=default
	Copy constructor.
	OffsetIF (OffsetIF &&a_other) noexcept=default
	Move constructor.
	OffsetIF (const std::shared_ptr< ImplicitFunction< T > > &a_implicitFunction, const T a_offset) noexcept
	Full constructor. Subtracts a_offset from the wrapped function value.
	~OffsetIF () override=default
	Destructor.
OffsetIF &	operator= (const OffsetIF &a_other) noexcept=default
	Copy assignment operator.
OffsetIF &	operator= (OffsetIF &&a_other) noexcept=default
	Move assignment operator.
T	value (const Vec3T< T > &a_point) const noexcept override
	Value function with offset applied.
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< ImplicitFunction< T > >	m_implicitFunction = nullptr
	Underlying implicit function.
T	m_offset
	Offset value.

Detailed Description

template<class T>
class EBGeometry::OffsetIF< T >

Offset implicit function. Offsets (grows or shrinks) the implicit function by a constant.

Template Parameters

T	Floating-point precision

Constructor & Destructor Documentation

OffsetIF() [1/3]

template<class T >

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

defaultnoexcept

Copy constructor.

Parameters

[in]

a_other

Other OffsetIF.

OffsetIF() [2/3]

template<class T >

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

defaultnoexcept

Move constructor.

Parameters

[in,out]

a_other

Other OffsetIF.

OffsetIF() [3/3]

template<class T >

EBGeometry::OffsetIF< T >::OffsetIF ( const std::shared_ptr< ImplicitFunction< T > > &  a_implicitFunction, const T  a_offset  )

noexcept

Full constructor. Subtracts a_offset from the wrapped function value.

Parameters

[in]	a_implicitFunction	Input implicit function.
[in]	a_offset	Offset value.

Member Function Documentation

operator=() [1/2]

template<class T >

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

defaultnoexcept

Copy assignment operator.

Parameters

[in]

a_other

Other OffsetIF.

Returns

Reference to (*this).

operator=() [2/2]

template<class T >

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

defaultnoexcept

Move assignment operator.

Parameters

[in,out]

a_other

Other OffsetIF.

Returns

Reference to (*this).

value()

template<class T >

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

overridevirtualnoexcept

Value function with offset applied.

Parameters

[in]

a_point

Query point

Returns

Value of the wrapped implicit function minus the stored offset

Implements EBGeometry::ImplicitFunction< T >.

---

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

• Source/EBGeometry_Transform.hpp