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

Uniformly scaled implicit function. More...

#include <EBGeometry_Transform.hpp>

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

Public Member Functions

 ScaleIF ()=delete
 Disallowed weak construction.
 
 ScaleIF (const ScaleIF &a_other) noexcept=default
 Copy constructor.
 
 ScaleIF (ScaleIF &&a_other) noexcept=default
 Move constructor.
 
 ScaleIF (const std::shared_ptr< ImplicitFunction< T > > &a_implicitFunction, const T a_scale) noexcept
 Full constructor.
 
 ~ScaleIF () override=default
 Destructor.
 
ScaleIFoperator= (const ScaleIF &a_other) noexcept=default
 Copy assignment operator.
 
ScaleIFoperator= (ScaleIF &&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
 Original implicit function.
 
m_scale
 Scaling factor.
 

Detailed Description

template<class T>
class EBGeometry::ScaleIF< T >

Uniformly scaled implicit function.

Template Parameters
TFloating-point precision

Constructor & Destructor Documentation

◆ ScaleIF() [1/3]

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

Copy constructor.

Parameters
[in]a_otherOther ScaleIF.

◆ ScaleIF() [2/3]

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

Move constructor.

Parameters
[in,out]a_otherOther ScaleIF.

◆ ScaleIF() [3/3]

template<class T >
EBGeometry::ScaleIF< T >::ScaleIF ( const std::shared_ptr< ImplicitFunction< T > > &  a_implicitFunction,
const a_scale 
)
noexcept

Full constructor.

Parameters
[in]a_implicitFunctionImplicit function to be scaled.
[in]a_scaleScaling factor (must be non-zero).

Member Function Documentation

◆ operator=() [1/2]

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

Copy assignment operator.

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

◆ operator=() [2/2]

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

Move assignment operator.

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

◆ value()

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

Value function.

Parameters
[in]a_pointQuery point
Returns
Signed distance of the wrapped function evaluated at a_point/m_scale, multiplied by m_scale

Implements EBGeometry::ImplicitFunction< T >.


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