olb::IndicatorCircle2D< S > Class Template Reference

indicator function for a 2D circle More...

#include <indicatorF2D.h>

Inheritance diagram for olb::IndicatorCircle2D< S >:

Collaboration diagram for olb::IndicatorCircle2D< S >:

Public Member Functions
	IndicatorCircle2D (Vector< S, 2 > center, S radius)
Vector< S, 2 > const &	getCenter () const
S const	getRadius () const
bool	operator() (bool output[], const S input[]) override
	has to be implemented for 'every' derived class
bool	distance (S &distance, const Vector< S, 2 > &origin, const Vector< S, 2 > &direction, int iC=-1) override
bool	normal (Vector< S, 2 > &normal, const Vector< S, 2 > &origin, const Vector< S, 2 > &direction, int iC=-1) override
	returns true and the normal if there was one found for an given origin and direction
S	signedDistance (const Vector< S, 2 > &input) override
	Returns signed distance to the nearest point on the indicator surface.
Public Member Functions inherited from olb::IndicatorF2D< S >
virtual Vector< S, 2 > &	getMin ()
virtual Vector< S, 2 > &	getMax ()
virtual bool	distance (S &distance, const Vector< S, 2 > &origin, S precision, const Vector< S, 2 > &direction)
	returns false or true and pos. distance if there was one found for an given origin and direction
virtual bool	distance (S &distance, const Vector< S, 2 > &origin, const Vector< S, 2 > &direction, S precision, S pitch)
virtual bool	distance (S &distance, const Vector< S, 2 > &origin)
virtual bool	distance (S &distance, const S input[])
virtual bool	operator() (bool output[1], const S input[2])
	Returns true if input is inside the indicator.
virtual Vector< S, 2 >	surfaceNormal (const Vector< S, 2 > &pos, const S meshSize)
	Return surface normal.
Vector< S, 2 >	surfaceNormal (const Vector< S, 2 > &pos, const S meshSize, std::function< Vector< S, 2 >(const Vector< S, 2 > &)> transformPos)
	Return surface normal after possible translation and rotation.
bool	isInsideBox (Vector< S, 2 > point)
	Returns true if point is inside a cube with corners _myMin and _myMax
virtual bool	operator() (const S input[])
	Indicator specific function operator overload.
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
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::IndicatorF2D< S >
	IndicatorF2D ()
Protected Member Functions inherited from olb::GenericF< bool, S >
	GenericF (int targetDim, int sourceDim)
Protected Attributes inherited from olb::IndicatorF2D< S >
Vector< S, 2 >	_myMin
Vector< S, 2 >	_myMax

Detailed Description

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

indicator function for a 2D circle

Definition at line 91 of file indicatorF2D.h.

Constructor & Destructor Documentation

IndicatorCircle2D()

template<typename S >

olb::IndicatorCircle2D< S >::IndicatorCircle2D	(	Vector< S, 2 >	center,
		S	radius )

Definition at line 154 of file indicatorF2D.hh.

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

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

Member Function Documentation

distance()

template<typename S >

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

overridevirtual

Reimplemented from olb::IndicatorF2D< S >.

Definition at line 185 of file indicatorF2D.hh.

{
  S a = direction[0]*direction[0] + direction[1]*direction[1];
 
  // returns 0 if point is at the boundary of the sphere
  if ( util::approxEqual(a,_radius2) ) {
    distance = S(0);
    return true;
  }
  // norm of direction
  a = util::sqrt(a);
 
  S b = 2.*((origin[0] - _center[0])*direction[0] +
            (origin[1] - _center[1])*direction[1])/a;
  S c = -_radius2 + (origin[0] - _center[0])*(origin[0] - _center[0])
        + (origin[1] - _center[1])*(origin[1] - _center[1]);
 
  // 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 ouside 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, 2 > const & olb::IndicatorCircle2D< S >::getCenter

(

)

const

Definition at line 164 of file indicatorF2D.hh.

{
  return _center;
}

getRadius()

template<typename S >

S const olb::IndicatorCircle2D< S >::getRadius

(

)

const

Definition at line 170 of file indicatorF2D.hh.

{
  return _radius;
}

Here is the caller graph for this function:

normal()

template<typename S >

bool olb::IndicatorCircle2D< S >::normal ( Vector< S, 2 > & normal, const Vector< S, 2 > & origin, const Vector< S, 2 > & direction, int iC = -1 )

overridevirtual

returns true and the normal if there was one found for an given origin and direction

(mind that the default computation is done by a numerical approximation which searches .. [TODO])

Reimplemented from olb::IndicatorF2D< S >.

Definition at line 233 of file indicatorF2D.hh.

{
  S dist;
  if (!(distance(dist, origin, direction, iC)) ) {
    return false;
  }
 
  Vector<S,2> intresection(origin + dist*direction);
 
  normal = intresection - _center;
 
  return true;
}

operator()()

template<typename S >

bool olb::IndicatorCircle2D< S >::operator() ( bool output[], const S input[] )

overridevirtual

has to be implemented for 'every' derived class

Implements olb::GenericF< bool, S >.

Definition at line 177 of file indicatorF2D.hh.

{
  output[0] = ( util::pow(_center[0] - input[0],2) + util::pow(_center[1] - input[1], 2) <= _radius2 );
  return output[0];
}

References olb::util::pow().

Here is the call graph for this function:

signedDistance()

template<typename S >

S olb::IndicatorCircle2D< S >::signedDistance ( const Vector< S, 2 > & input )

overridevirtual

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

Reimplemented from olb::IndicatorF2D< S >.

Definition at line 248 of file indicatorF2D.hh.

{
  Vector<S,2> 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/functors/analytical/indicator/indicatorF2D.h
• src/functors/analytical/indicator/indicatorF2D.hh