EBGeometry  1.0
Public Member Functions | Protected Attributes | List of all members
AnnularIF< T > Class Template Reference

Annular implicit function function. Creates a shell out of the implicit function. More...

#include <EBGeometry_Transform.hpp>

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

Public Member Functions

 AnnularIF ()=delete
 Disallowed weak construction.
 
 AnnularIF (const std::shared_ptr< ImplicitFunction< T >> a_implicitFunction, const T a_delta)
 Full constructor. More...
 
virtual ~AnnularIF ()
 Destructor.
 
virtual T value (const Vec3T< T > &a_point) const noexcept override
 Value function. More...
 
- Public Member Functions inherited from ImplicitFunction< T >
 ImplicitFunction ()=default
 Disallowed, use the full constructor.
 
virtual ~ImplicitFunction ()=default
 Destructor (does nothing)
 
operator() (const Vec3T< T > &a_point) const noexcept
 Alternative signature for the value function. More...
 
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 noexcept
 Compute an approximation to the bounding volume for the implicit surface, using octrees. More...
 

Protected Attributes

std::shared_ptr< const ImplicitFunction< T > > m_implicitFunction
 Original implicit function.
 
m_delta
 Shell thickness.
 

Detailed Description

template<class T>
class AnnularIF< T >

Annular implicit function function. Creates a shell out of the implicit function.

Constructor & Destructor Documentation

◆ AnnularIF()

template<class T >
AnnularIF< T >::AnnularIF ( const std::shared_ptr< ImplicitFunction< T >>  a_implicitFunction,
const T  a_delta 
)

Full constructor.

Parameters
[in]a_implicitFunctionInput implicit function.
[in]a_deltaShell thickness (at least if the implicit function is also signed distance)

Member Function Documentation

◆ value()

template<class T >
virtual T AnnularIF< T >::value ( const Vec3T< T > &  a_point) const
overridevirtualnoexcept

Value function.

Parameters
[in]a_pointInput point.

Implements ImplicitFunction< T >.


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