olb::IndicatorSphere3D< S > Class Template Reference

indicator function for a 3D-sphere More...

#include <indicatorF3D.h>

Inheritance diagram for olb::IndicatorSphere3D< S >:

Collaboration diagram for olb::IndicatorSphere3D< S >:

Public Member Functions
	IndicatorSphere3D (Vector< S, 3 > center, S radius)
	IndicatorSphere3D (const IndicatorSphere3D &)
Vector< S, 3 > const &	getCenter () const
S const	getRadius () const
S	signedDistance (const Vector< S, 3 > &input) override
	Returns signed distance to the nearest point on the indicator surface.
bool	distance (S &distance, const Vector< S, 3 > &origin, const Vector< S, 3 > &direction, int iC=-1) override
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)
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::IndicatorSphere3D< S >

indicator function for a 3D-sphere

Definition at line 98 of file indicatorF3D.h.

Constructor & Destructor Documentation

IndicatorSphere3D() [1/2]

template<typename S >

olb::IndicatorSphere3D< S >::IndicatorSphere3D	(	Vector< S, 3 >	center,
		S	radius )

Definition at line 131 of file indicatorF3D.hh.

  :  _center(center), _radius(radius), _radius2(_radius*_radius)
{
  this->_myMin = _center - radius;
  this->_myMax = _center + radius;
}

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

IndicatorSphere3D() [2/2]

template<typename S >

olb::IndicatorSphere3D< S >::IndicatorSphere3D

(

const IndicatorSphere3D< S > &

sphere

)

Definition at line 139 of file indicatorF3D.hh.

{
  this->_myMin = sphere._myMin;
  this->_myMax = sphere._myMax;
  _center = sphere._center;
  _radius = sphere._radius;
  _radius2 = sphere._radius2;
}

Member Function Documentation

distance()

template<typename S >

bool olb::IndicatorSphere3D< S >::distance ( S & distance, const Vector< S, 3 > & origin, const Vector< S, 3 > & direction, int iC = -1 )

overridevirtual

Reimplemented from olb::IndicatorF3D< S >.

Definition at line 168 of file indicatorF3D.hh.

{
  // computes pos. distance by solving quadratic equation by a-b-c-formula
  S a = direction[0]*direction[0] + direction[1]*direction[1] + direction[2]*direction[2];
 
  // returns 0 if point is at the boundary of the sphere
  if ( util::approxEqual(a,_radius2) ) {
    distance = S();
    return true;
  }
  // norm of direction
  a = util::sqrt(a);
 
  S b = 2.*((origin[0] - _center[0])*direction[0] +
            (origin[1] - _center[1])*direction[1] +
            (origin[2] - _center[2])*direction[2])/a;
  S c = -_radius2 + (origin[0] - _center[0])*(origin[0] - _center[0])
        + (origin[1] - _center[1])*(origin[1] - _center[1])
        + (origin[2] - _center[2])*(origin[2] - _center[2]);
 
  // discriminant
  S d = b*b - 4.*c;
  if (d < 0) {
    return false;
  }
 
  S x1 = (- b + util::sqrt(d)) *0.5;
  S x2 = (- b - util::sqrt(d)) *0.5;
 
  // case if origin is inside the sphere
  if ((x1<0.) || (x2<0.)) {
    if (x1>0.) {
      distance = x1;
      return true;
    }
    if (x2>0.) {
      distance = x2;
      return true;
    }
  }
  // case if origin is outside the sphere
  else {
    distance = util::min(x1,x2);
    return true;
  }
 
  return false;
}

References olb::util::approxEqual(), olb::util::min(), and olb::util::sqrt().

Here is the call graph for this function:

getCenter()

template<typename S >

Vector< S, 3 > const & olb::IndicatorSphere3D< S >::getCenter

(

)

const

Definition at line 149 of file indicatorF3D.hh.

{
  return _center;
}

getRadius()

template<typename S >

S const olb::IndicatorSphere3D< S >::getRadius

(

)

const

Definition at line 155 of file indicatorF3D.hh.

{
  return _radius;
}

signedDistance()

template<typename S >

S olb::IndicatorSphere3D< 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 161 of file indicatorF3D.hh.

{
  Vector<S,3> p = input - _center;
  return sdf::sphere(p, _radius);
}

References olb::sdf::sphere().

Here is the call graph for this function:

---

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

• src/core/blockLatticeStructure3D.h
• src/functors/analytical/indicator/indicatorF3D.h
• src/functors/analytical/indicator/indicatorF3D.hh