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::TranslateIF< T > Class Template Reference

Translated implicit function. More...

#include <EBGeometry_Transform.hpp>

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

Public Member Functions

 TranslateIF ()=delete
 No weak construction for this one.
 
 TranslateIF (const TranslateIF &a_other) noexcept=default
 Copy constructor.
 
 TranslateIF (TranslateIF &&a_other) noexcept=default
 Move constructor.
 
 TranslateIF (const std::shared_ptr< ImplicitFunction< T > > &a_implicitFunction, const Vec3T< T > &a_shift) noexcept
 Full constructor.
 
 ~TranslateIF () override=default
 Destructor (does nothing)
 
TranslateIFoperator= (const TranslateIF &a_other) noexcept=default
 Copy assignment operator.
 
TranslateIFoperator= (TranslateIF &&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< ImplicitFunction< T > > m_implicitFunction = nullptr
 Underlying implicit function.
 
Vec3T< T > m_shift
 Input point translate.
 

Detailed Description

template<class T>
class EBGeometry::TranslateIF< T >

Translated implicit function.

Template Parameters
TFloating-point precision

Constructor & Destructor Documentation

◆ TranslateIF() [1/3]

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

Copy constructor.

Parameters
[in]a_otherOther TranslateIF.

◆ TranslateIF() [2/3]

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

Move constructor.

Parameters
[in,out]a_otherOther TranslateIF.

◆ TranslateIF() [3/3]

template<class T >
EBGeometry::TranslateIF< T >::TranslateIF ( const std::shared_ptr< ImplicitFunction< T > > &  a_implicitFunction,
const Vec3T< T > &  a_shift 
)
noexcept

Full constructor.

Parameters
[in]a_implicitFunctionInput implicit function to be translated
[in]a_shiftDistance to shift

Member Function Documentation

◆ operator=() [1/2]

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

Copy assignment operator.

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

◆ operator=() [2/2]

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

Move assignment operator.

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

◆ value()

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

Value function.

Parameters
[in]a_pointQuery point
Returns
Value of the wrapped implicit function evaluated at a_point shifted by -m_shift

Implements EBGeometry::ImplicitFunction< T >.


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