EBGeometry::ElongateIF< T > Class Template Reference

Implicit function which is an elongation of another implicit function along each axis. More...

#include <EBGeometry_Transform.hpp>

Inheritance diagram for EBGeometry::ElongateIF< T >:

Collaboration diagram for EBGeometry::ElongateIF< T >:

Public Member Functions
	ElongateIF ()=delete
	Disallowed weak construction.
	ElongateIF (const ElongateIF &a_other) noexcept=default
	Copy constructor.
	ElongateIF (ElongateIF &&a_other) noexcept=default
	Move constructor.
	ElongateIF (const std::shared_ptr< ImplicitFunction< T > > &a_implicitFunction, const Vec3T< T > &a_elongation) noexcept
	Full constructor.
	~ElongateIF () override=default
	Destructor.
ElongateIF &	operator= (const ElongateIF &a_other) noexcept=default
	Copy assignment operator.
ElongateIF &	operator= (ElongateIF &&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
	Underlying implicit function to be elongated.
Vec3T< T >	m_elongation
	Elongation.

Detailed Description

template<class T>
class EBGeometry::ElongateIF< T >

Implicit function which is an elongation of another implicit function along each axis.

Elongation clamps the query point component-wise to [-elongation, +elongation] and subtracts the clamped value before evaluating the wrapped function — effectively stretching the shape without changing its cross-section profile.

Template Parameters

T	Floating-point precision

Constructor & Destructor Documentation

ElongateIF() [1/3]

template<class T >

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

defaultnoexcept

Copy constructor.

Parameters

[in]

a_other

Other ElongateIF.

ElongateIF() [2/3]

template<class T >

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

defaultnoexcept

Move constructor.

Parameters

[in,out]

a_other

Other ElongateIF.

ElongateIF() [3/3]

template<class T >

EBGeometry::ElongateIF< T >::ElongateIF ( const std::shared_ptr< ImplicitFunction< T > > &  a_implicitFunction, const Vec3T< T > &  a_elongation  )

noexcept

Full constructor.

Parameters

[in]	a_implicitFunction	Implicit function to be stretched
[in]	a_elongation	Per-axis elongation amounts (non-negative values expected)

Member Function Documentation

operator=() [1/2]

template<class T >

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

defaultnoexcept

Copy assignment operator.

Parameters

[in]

a_other

Other ElongateIF.

Returns

Reference to (*this).

operator=() [2/2]

template<class T >

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

defaultnoexcept

Move assignment operator.

Parameters

[in,out]

a_other

Other ElongateIF.

Returns

Reference to (*this).

value()

template<class T >

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

overridevirtualnoexcept

Value function.

Parameters

[in]

a_point

Query point

Returns

Value of the wrapped function evaluated at a_point clamped by m_elongation

Implements EBGeometry::ImplicitFunction< T >.

---

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

• Source/EBGeometry_Transform.hpp