EBGeometry::RotateIF< T > Class Template Reference

Rotated implicit function. Rotates an implicit function about an axis. More...

#include <EBGeometry_Transform.hpp>

Inheritance diagram for EBGeometry::RotateIF< T >:

Collaboration diagram for EBGeometry::RotateIF< T >:

Public Member Functions
	RotateIF ()=delete
	No weak construction.
	RotateIF (const RotateIF &a_other) noexcept=default
	Copy constructor.
	RotateIF (RotateIF &&a_other) noexcept=default
	Move constructor.
	RotateIF (const std::shared_ptr< ImplicitFunction< T > > &a_implicitFunction, const T a_angle, const size_t a_axis) noexcept
	Full constructor. Rotates the wrapped implicit function by a_angle degrees about a_axis.
	~RotateIF () override=default
	Destructor.
RotateIF &	operator= (const RotateIF &a_other) noexcept=default
	Copy assignment operator.
RotateIF &	operator= (RotateIF &&a_other) noexcept=default
	Move assignment operator.
T	value (const Vec3T< T > &a_point) const noexcept override
	Value function with rotation applied to the query point.
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.
size_t	m_axis
	Axis to rotate about.
T	m_angle
	Angle to rotate.
T	m_cosAngle
	Parameter in rotation matrix. Stored for efficiency.
T	m_sinAngle
	Parameter in rotation matrix. Stored for efficiency.

Detailed Description

template<class T>
class EBGeometry::RotateIF< T >

Rotated implicit function. Rotates an implicit function about an axis.

Template Parameters

T	Floating-point precision

Constructor & Destructor Documentation

RotateIF() [1/3]

template<class T >

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

defaultnoexcept

Copy constructor.

Parameters

[in]

a_other

Other RotateIF.

RotateIF() [2/3]

template<class T >

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

defaultnoexcept

Move constructor.

Parameters

[in,out]

a_other

Other RotateIF.

RotateIF() [3/3]

template<class T >

EBGeometry::RotateIF< T >::RotateIF ( const std::shared_ptr< ImplicitFunction< T > > &  a_implicitFunction, const T  a_angle, const size_t  a_axis  )

noexcept

Full constructor. Rotates the wrapped implicit function by a_angle degrees about a_axis.

Parameters

[in]	a_implicitFunction	Input implicit function.
[in]	a_angle	Angle to rotate (in degrees)
[in]	a_axis	Axis to rotate about (0=x, 1=y, 2=z)

Member Function Documentation

operator=() [1/2]

template<class T >

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

defaultnoexcept

Copy assignment operator.

Parameters

[in]

a_other

Other RotateIF.

Returns

Reference to (*this).

operator=() [2/2]

template<class T >

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

defaultnoexcept

Move assignment operator.

Parameters

[in,out]

a_other

Other RotateIF.

Returns

Reference to (*this).

value()

template<class T >

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

overridevirtualnoexcept

Value function with rotation applied to the query point.

Parameters

[in]

a_point

Query point

Returns

Value of the wrapped implicit function evaluated at the inversely rotated point

Implements EBGeometry::ImplicitFunction< T >.

---

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

• Source/EBGeometry_Transform.hpp