EBGeometry
Compact, header-only C++ library for fast evaluation of signed distance functions
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
EBGeometry::ReflectIF< T > Class Template Reference

Implicit function which is a reflection of another implicit function. More...

#include <EBGeometry_Transform.hpp>

Inheritance diagram for EBGeometry::ReflectIF< T >:
Inheritance graph
[legend]
Collaboration diagram for EBGeometry::ReflectIF< T >:
Collaboration graph
[legend]

Public Member Functions

 ReflectIF ()=delete
 Disallowed weak construction.
 
 ReflectIF (const ReflectIF &a_other) noexcept=default
 Copy constructor.
 
 ReflectIF (ReflectIF &&a_other) noexcept=default
 Move constructor.
 
 ReflectIF (const std::shared_ptr< ImplicitFunction< T > > &a_implicitFunction, const size_t &a_reflectPlane) noexcept
 Full constructor. Reflects across the specified plane.
 
 ~ReflectIF () override=default
 Destructor.
 
ReflectIFoperator= (const ReflectIF &a_other) noexcept=default
 Copy assignment operator.
 
ReflectIFoperator= (ReflectIF &&a_other) noexcept=default
 Move assignment operator.
 
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.
 
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 reflected.
 
Vec3T< T > m_reflectParams
 Reflection parameters.
 

Detailed Description

template<class T>
class EBGeometry::ReflectIF< T >

Implicit function which is a reflection of another implicit function.

Template Parameters
TFloating-point precision

Constructor & Destructor Documentation

◆ ReflectIF() [1/3]

template<class T >
EBGeometry::ReflectIF< T >::ReflectIF ( const ReflectIF< T > &  a_other)
defaultnoexcept

Copy constructor.

Parameters
[in]a_otherOther ReflectIF.

◆ ReflectIF() [2/3]

template<class T >
EBGeometry::ReflectIF< T >::ReflectIF ( ReflectIF< T > &&  a_other)
defaultnoexcept

Move constructor.

Parameters
[in,out]a_otherOther ReflectIF.

◆ ReflectIF() [3/3]

template<class T >
EBGeometry::ReflectIF< T >::ReflectIF ( const std::shared_ptr< ImplicitFunction< T > > &  a_implicitFunction,
const size_t a_reflectPlane 
)
noexcept

Full constructor. Reflects across the specified plane.

Parameters
[in]a_implicitFunctionImplicit function to be reflected
[in]a_reflectPlanePlane to reflect across (0=yz-plane flips x, 1=xz-plane flips y, 2=xy-plane flips z)

Member Function Documentation

◆ operator=() [1/2]

template<class T >
ReflectIF & EBGeometry::ReflectIF< T >::operator= ( const ReflectIF< T > &  a_other)
defaultnoexcept

Copy assignment operator.

Parameters
[in]a_otherOther ReflectIF.
Returns
Reference to (*this).

◆ operator=() [2/2]

template<class T >
ReflectIF & EBGeometry::ReflectIF< T >::operator= ( ReflectIF< T > &&  a_other)
defaultnoexcept

Move assignment operator.

Parameters
[in,out]a_otherOther ReflectIF.
Returns
Reference to (*this).

◆ value()

template<class T >
T EBGeometry::ReflectIF< T >::value ( const Vec3T< T > &  a_point) const
overridevirtualnoexcept

Value function.

Parameters
[in]a_pointQuery point
Returns
Value of the wrapped function evaluated at a_point with the reflected coordinate flipped

Implements EBGeometry::ImplicitFunction< T >.


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