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

Implicit function which is an elongation of another implicit function along some axis. More...

#include <EBGeometry_Transform.hpp>

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

Public Member Functions

 ElongateIF ()=delete
 Disallowed weak construction.
 
 ElongateIF (const std::shared_ptr< ImplicitFunction< T >> &a_implicitFunction, const Vec3T< T > &a_elongation) noexcept
 Full constructor. More...
 
virtual ~ElongateIF () noexcept
 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
 Underlying implicit function to be elongated.
 
Vec3T< T > m_elongation
 Elongation.
 

Detailed Description

template<class T>
class ElongateIF< T >

Implicit function which is an elongation of another implicit function along some axis.

Constructor & Destructor Documentation

◆ ElongateIF()

template<class T >
ElongateIF< T >::ElongateIF ( const std::shared_ptr< ImplicitFunction< T >> &  a_implicitFunction,
const Vec3T< T > &  a_elongation 
)
noexcept

Full constructor.

Parameters
[in]a_implicitFunctionImplicit function to be stretched
[in]a_elongationStretching (per coordinate)

Member Function Documentation

◆ value()

template<class T >
virtual T ElongateIF< 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: