OpenLB 1.7
Loading...
Searching...
No Matches
Public Member Functions | List of all members
olb::IndicatorEllipsoid3D< S > Class Template Reference

indicator function for an ellipsoid More...

#include <indicatorF3D.h>

+ Inheritance diagram for olb::IndicatorEllipsoid3D< S >:
+ Collaboration diagram for olb::IndicatorEllipsoid3D< S >:

Public Member Functions

 IndicatorEllipsoid3D (Vector< S, 3 > center, Vector< S, 3 > radius)
 
Vector< S, 3 > const & getCenter () const
 
Vector< S, 3 > const & getRadius () const
 
signedDistance (const Vector< S, 3 > &input) override
 Returns signed distance to the nearest point on the indicator surface.
 
- Public Member Functions inherited from olb::IndicatorF3D< S >
virtual Vector< S, 3 > & getMin ()
 
virtual Vector< S, 3 > & getMax ()
 
virtual bool distance (S &distance, const Vector< S, 3 > &origin, S precision, const Vector< S, 3 > &direction)
 
virtual bool distance (S &distance, const Vector< S, 3 > &origin, const Vector< S, 3 > &direction, S precision, S pitch)
 
virtual bool distance (S &distance, const Vector< S, 3 > &origin, const Vector< S, 3 > &direction, int iC=-1)
 
virtual bool distance (S &distance, const Vector< S, 3 > &origin)
 
virtual bool distance (S &distance, const S input[])
 
virtual bool normal (Vector< S, 3 > &normal, const Vector< S, 3 > &origin, const Vector< S, 3 > &direction, int iC=-1)
 returns true and the normal if there was one found for an given origin and direction
 
virtual bool rotOnAxis (Vector< S, 3 > &vec_rot, const Vector< S, 3 > &vec, const Vector< S, 3 > &axis, S &theta)
 Rotate vector around axis by angle theta.
 
virtual bool operator() (bool output[1], const S input[3])
 Returns true if input is inside the indicator.
 
virtual Vector< S, 3 > surfaceNormal (const Vector< S, 3 > &pos, const S meshSize)
 Return surface normal.
 
Vector< S, 3 > surfaceNormal (const Vector< S, 3 > &pos, const S meshSize, std::function< Vector< S, 3 >(const Vector< S, 3 > &)> transformPos)
 Return surface normal after possible translation and rotation.
 
bool isInsideBox (Vector< S, 3 > point)
 Returns true if point is inside a cube with corners _myMin and _myMax
 
virtual Vector< S, 3 > getSample (const std::function< S()> &randomness) const
 
- Public Member Functions inherited from olb::GenericF< bool, S >
virtual ~GenericF ()=default
 
int getSourceDim () const
 read only access to member variable _m
 
int getTargetDim () const
 read only access to member variable _n
 
std::string & getName ()
 read and write access to name
 
std::string const & getName () const
 read only access to name
 
virtual bool operator() (bool output[], const S input[])=0
 has to be implemented for 'every' derived class
 
bool operator() (bool output[])
 wrapper that call the pure virtual operator() (T output[], const S input[]) from above
 
bool operator() (bool output[], S input0)
 
bool operator() (bool output[], S input0, S input1)
 
bool operator() (bool output[], S input0, S input1, S input2)
 
bool operator() (bool output[], S input0, S input1, S input2, S input3)
 

Additional Inherited Members

- Public Types inherited from olb::GenericF< bool, S >
using targetType
 
using sourceType
 
- Public Attributes inherited from olb::GenericF< bool, S >
std::shared_ptr< GenericF< bool, S > > _ptrCalcC
 memory management, frees resouces (calcClass)
 
- Protected Member Functions inherited from olb::IndicatorF3D< S >
 IndicatorF3D ()
 
- Protected Member Functions inherited from olb::GenericF< bool, S >
 GenericF (int targetDim, int sourceDim)
 
- Protected Attributes inherited from olb::IndicatorF3D< S >
Vector< S, 3 > _myMin
 
Vector< S, 3 > _myMax
 

Detailed Description

template<typename S>
class olb::IndicatorEllipsoid3D< S >

indicator function for an ellipsoid

Definition at line 196 of file indicatorF3D.h.

Constructor & Destructor Documentation

◆ IndicatorEllipsoid3D()

template<typename S >
olb::IndicatorEllipsoid3D< S >::IndicatorEllipsoid3D ( Vector< S, 3 > center,
Vector< S, 3 > radius )

Definition at line 531 of file indicatorF3D.hh.

532 : _center(center), _radius(radius)
533{
534#ifdef OLB_DEBUG
535 OstreamManager clout(std::cout, "IndicatorEllipsoid3D");
536 clout << "WARNING: The indicator doesn't provide an exact signed distance function." << std::endl;
537#endif
538
539 assert(_radius[0]>0 && _radius[1]>0 && _radius[2]>0);
540
541 this->_myMin = center - radius;
542 this->_myMax = center + radius;
543}
Vector< S, 3 > _myMin
Vector< S, 3 > _myMax

References olb::IndicatorF3D< S >::_myMax, and olb::IndicatorF3D< S >::_myMin.

Member Function Documentation

◆ getCenter()

template<typename S >
Vector< S, 3 > const & olb::IndicatorEllipsoid3D< S >::getCenter ( ) const

Definition at line 552 of file indicatorF3D.hh.

553{
554 return _center;
555}

◆ getRadius()

template<typename S >
Vector< S, 3 > const & olb::IndicatorEllipsoid3D< S >::getRadius ( ) const

Definition at line 546 of file indicatorF3D.hh.

547{
548 return _radius;
549}

◆ signedDistance()

template<typename S >
S olb::IndicatorEllipsoid3D< S >::signedDistance ( const Vector< S, 3 > & input)
overridevirtual

Returns signed distance to the nearest point on the indicator surface.

Reimplemented from olb::IndicatorF3D< S >.

Definition at line 558 of file indicatorF3D.hh.

559{
560 Vector<S,3> p = input - _center;
561 return sdf::ellipsoid(p, _radius);
562}
T ellipsoid(Vector< T, 3 > p, Vector< T, 3 > r) any_platform
Calculate the NOT EXACT (!) signed distance to the surface of three-dimensional ellipsoid.
Definition sdf.h:253

References olb::sdf::ellipsoid().

+ Here is the call graph for this function:

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