olb::IndicatorSuperEllipsoid3D< S > Class Template Reference

indicator function for a super ellipsoid More...

#include <indicatorF3D.h>

Inheritance diagram for olb::IndicatorSuperEllipsoid3D< S >:

Collaboration diagram for olb::IndicatorSuperEllipsoid3D< S >:

Public Member Functions
	IndicatorSuperEllipsoid3D (Vector< S, 3 > center, S xHalfAxis, S yHalfAxis, S zHalfAxis, S exponent1, S exponent2)
Vector< S, 3 > const &	getCenter () const
S	getXHalfAxis () const
S	getYHalfAxis () const
S	getZHalfAxis () const
S	getExponent1 () const
S	getExponent2 () const
bool	operator() (bool output[], const S input[]) override
	has to be implemented for 'every' derived class
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 S	signedDistance (const Vector< S, 3 > &input)
	Returns signed distance to the nearest point on the indicator surface.
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
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::IndicatorSuperEllipsoid3D< S >

indicator function for a super ellipsoid

Definition at line 211 of file indicatorF3D.h.

Constructor & Destructor Documentation

IndicatorSuperEllipsoid3D()

template<typename S >

olb::IndicatorSuperEllipsoid3D< S >::IndicatorSuperEllipsoid3D	(	Vector< S, 3 >	center,
		S	xHalfAxis,
		S	yHalfAxis,
		S	zHalfAxis,
		S	exponent1,
		S	exponent2 )

Definition at line 565 of file indicatorF3D.hh.

  : _center(center), _xHalfAxis(xHalfAxis), _yHalfAxis(yHalfAxis), _zHalfAxis(zHalfAxis), _exp1(exponent1), _exp2(exponent2)
{
  assert(_xHalfAxis>0 && _yHalfAxis>0 && _zHalfAxis>0);
 
  S max_axis = util::max( xHalfAxis, util::max(yHalfAxis, zHalfAxis) );
  this->_myMin = {
    center[0] - util::sqrt(2.)*max_axis,
    center[1] - util::sqrt(2.)*max_axis,
    center[2] - util::sqrt(2.)*max_axis
  };
  this->_myMax = {
    center[0] + util::sqrt(2.)*max_axis,
    center[1] + util::sqrt(2.)*max_axis,
    center[2] + util::sqrt(2.)*max_axis
  };
}

References olb::IndicatorF3D< S >::_myMax, olb::IndicatorF3D< S >::_myMin, olb::util::max(), and olb::util::sqrt().

Here is the call graph for this function:

Member Function Documentation

getCenter()

template<typename S >

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

(

)

const

Definition at line 584 of file indicatorF3D.hh.

{
  return _center;
}

getExponent1()

template<typename S >

S olb::IndicatorSuperEllipsoid3D< S >::getExponent1

(

)

const

Definition at line 608 of file indicatorF3D.hh.

{
  return _exp1;
}

getExponent2()

template<typename S >

S olb::IndicatorSuperEllipsoid3D< S >::getExponent2

(

)

const

Definition at line 614 of file indicatorF3D.hh.

{
  return _exp2;
}

getXHalfAxis()

template<typename S >

S olb::IndicatorSuperEllipsoid3D< S >::getXHalfAxis

(

)

const

Definition at line 590 of file indicatorF3D.hh.

{
  return _xHalfAxis;
}

getYHalfAxis()

template<typename S >

S olb::IndicatorSuperEllipsoid3D< S >::getYHalfAxis

(

)

const

Definition at line 596 of file indicatorF3D.hh.

{
  return _yHalfAxis;
}

getZHalfAxis()

template<typename S >

S olb::IndicatorSuperEllipsoid3D< S >::getZHalfAxis

(

)

const

Definition at line 602 of file indicatorF3D.hh.

{
  return _zHalfAxis;
}

operator()()

template<typename S >

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

overridevirtual

has to be implemented for 'every' derived class

Implements olb::GenericF< bool, S >.

Definition at line 620 of file indicatorF3D.hh.

{
  S a = util::pow ( util::abs( (input[0] - _center[0]) / _xHalfAxis ), _exp1 );
  S b = util::pow ( util::abs( (input[1] - _center[1]) / _yHalfAxis ), _exp1 );
  S c = util::pow ( util::abs( (input[2] - _center[2]) / _zHalfAxis ), _exp2 );
  S ab = util::pow( a+b, _exp2/_exp1 );
 
  if ( (ab+c) <= 1. ) {
    output[0] = 1.;
    return true;
  }
 
  output[0] = 0.;
  return false;
}

References olb::util::abs(), and olb::util::pow().

Here is the call graph for this function:

---

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

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