olb::SmoothIndicatorSuperEllipsoid3D< T, S, PARTICLE > Class Template Reference

implements a smooth particle super-ellipsoid in 3D. The epsilon sector is currently missing. More...

#include <smoothIndicatorF3D.h>

Inheritance diagram for olb::SmoothIndicatorSuperEllipsoid3D< T, S, PARTICLE >:

Collaboration diagram for olb::SmoothIndicatorSuperEllipsoid3D< T, S, PARTICLE >:

Public Member Functions
	SmoothIndicatorSuperEllipsoid3D (IndicatorSuperEllipsoid3D< S > &ind, S epsilon, Vector< S, 3 > theta=Vector< S, 3 >(0., 0., 0.))
	SmoothIndicatorSuperEllipsoid3D (Vector< S, 3 > center, S xHalfAxis, S yHalfAxis, S zHalfAxis, S exponent1, S exponent2, S epsilon, Vector< S, 3 > theta=Vector< S, 3 >(0., 0., 0.))
IndicatorSuperEllipsoid3D< S > &	getIndicator ()
S	beta (S arg1, S arg2)
S	moments (S p, S q, S r)
Vector< S, 3 >	surfaceNormal (const Vector< S, 3 > &pos, const S meshSize) override
const S	signedDistance (const PhysR< S, 3 > input) override
S	getVolume () override
Vector< S, 4 >	calcMofiAndMass (const S density) override
bool	operator() (T output[], const S input[]) override

Detailed Description

template<typename T, typename S, bool PARTICLE = false>
class olb::SmoothIndicatorSuperEllipsoid3D< T, S, PARTICLE >

implements a smooth particle super-ellipsoid in 3D. The epsilon sector is currently missing.

Definition at line 76 of file smoothIndicatorF3D.h.

Constructor & Destructor Documentation

SmoothIndicatorSuperEllipsoid3D() [1/2]

template<typename T , typename S , bool PARTICLE>

olb::SmoothIndicatorSuperEllipsoid3D< T, S, PARTICLE >::SmoothIndicatorSuperEllipsoid3D	(	IndicatorSuperEllipsoid3D< S > &	ind,
		S	epsilon,
		Vector< S, 3 >	theta = Vector<S,3> (0.,0.,0.) )

Definition at line 261 of file smoothIndicatorF3D.hh.

  :SmoothIndicatorSuperEllipsoid3D(ind.getCenter(), ind.getXHalfAxis(), ind.getYHalfAxis(), ind.getZHalfAxis(), ind.getExponent1(), ind.getExponent2(), epsilon, theta)
{ }

SmoothIndicatorSuperEllipsoid3D() [2/2]

template<typename T , typename S , bool PARTICLE>

olb::SmoothIndicatorSuperEllipsoid3D< T, S, PARTICLE >::SmoothIndicatorSuperEllipsoid3D	(	Vector< S, 3 >	center,
		S	xHalfAxis,
		S	yHalfAxis,
		S	zHalfAxis,
		S	exponent1,
		S	exponent2,
		S	epsilon,
		Vector< S, 3 >	theta = Vector<S,3> (0.,0.,0.) )

Definition at line 267 of file smoothIndicatorF3D.hh.

  :_ind(center, xHalfAxis, yHalfAxis, zHalfAxis, exponent1, exponent2)
{
  this->_epsilon = epsilon;
  if constexpr (!PARTICLE) {
    this->_pos = _ind.getCenter();
    this->_theta = util::degreeToRadian(theta);
  }
 
  T const max_axis = util::max( xHalfAxis, util::max(yHalfAxis, zHalfAxis) );
  this->_circumRadius = util::sqrt(2.)*max_axis+0.5*epsilon;
  if constexpr (!PARTICLE) {
    this->_myMin = {
      this->_pos[0] - this->getCircumRadius(),
      this->_pos[1] - this->getCircumRadius(),
      this->_pos[2] - this->getCircumRadius()
    };
    this->_myMax = {
      this->_pos[0] + this->getCircumRadius(),
      this->_pos[1] + this->getCircumRadius(),
      this->_pos[2] + this->getCircumRadius()
    };
    this->init();
  }
}

References olb::util::degreeToRadian(), olb::util::max(), and olb::util::sqrt().

Here is the call graph for this function:

Member Function Documentation

beta()

template<typename T , typename S , bool PARTICLE>

S olb::SmoothIndicatorSuperEllipsoid3D< T, S, PARTICLE >::beta	(	S	arg1,
		S	arg2 )

Definition at line 318 of file smoothIndicatorF3D.hh.

{
  return (std::tgamma(arg1)*std::tgamma(arg2)) / std::tgamma(arg1+arg2);
}

calcMofiAndMass()

template<typename T , typename S , bool PARTICLE>

Vector< S, 4 > olb::SmoothIndicatorSuperEllipsoid3D< T, S, PARTICLE >::calcMofiAndMass ( const S density )

override

Definition at line 307 of file smoothIndicatorF3D.hh.

{
  T const mass = getVolume() * density;
  Vector<S,3> mofi;
  mofi[0] = ( moments(0., 2., 0.) + moments(0., 0., 2.) ) * density;
  mofi[1] = ( moments(2., 0., 0.) + moments(0., 0., 2.) ) * density;
  mofi[2] = ( moments(0., 2., 0.) + moments(2., 0., 0.) ) * density;
  return Vector<S,4>(mofi[0], mofi[1], mofi[2], mass);
}

getIndicator()

template<typename T , typename S , bool PARTICLE>

IndicatorSuperEllipsoid3D< S > & olb::SmoothIndicatorSuperEllipsoid3D< T, S, PARTICLE >::getIndicator

(

)

Definition at line 296 of file smoothIndicatorF3D.hh.

                                                                                         {
  return _ind;
}

getVolume()

template<typename T , typename S , bool PARTICLE>

S olb::SmoothIndicatorSuperEllipsoid3D< T, S, PARTICLE >::getVolume ( )

override

Definition at line 301 of file smoothIndicatorF3D.hh.

{
  return moments(0., 0., 0.);
}

moments()

template<typename T , typename S , bool PARTICLE>

S olb::SmoothIndicatorSuperEllipsoid3D< T, S, PARTICLE >::moments	(	S	p,
		S	q,
		S	r )

Definition at line 324 of file smoothIndicatorF3D.hh.

{
  S ex1 = 2./_ind.getExponent1();
  S ex2 = 2./_ind.getExponent2();
  S tmp1 = 2./(p+q+2.);
  S tmp2 = util::pow(_ind.getXHalfAxis(), p+1.) * util::pow(_ind.getYHalfAxis(), q+1.) * util::pow(_ind.getZHalfAxis(), r+1.) * ex1 * ex2;
  S tmp3 = beta( (r+1.)*(ex1/2.), (p+q+2.)*(ex2/2.)+1. ) * beta( (q+1.)*(ex2/2.), (p+1.)*(ex2/2.) );
  return tmp1 * tmp2 * tmp3;
}

References olb::util::pow().

Here is the call graph for this function:

operator()()

template<typename T , typename S , bool PARTICLE>

bool olb::SmoothIndicatorSuperEllipsoid3D< T, S, PARTICLE >::operator() ( T output[], const S input[] )

override

Definition at line 356 of file smoothIndicatorF3D.hh.

{
  Vector<T,3> pos(0.);
  Vector<T,9> rotMatrix = {1, 0, 0, 0, 1, 0, 0, 0, 1};
  if constexpr (!PARTICLE) {
    pos = this->getPos();
    rotMatrix = this->getRotationMatrix();
  }
 
  //1.Calculate distance between point and center of unrotated indicator
  T xDist = input[0] - pos[0];
  T yDist = input[1] - pos[1];
  T zDist = input[2] - pos[2];
 
  //2.Calculate point projected to rotated indicator
  // counter-clockwise rotation by _theta=-theta around center
  T x = pos[0] + rotMatrix[0]*xDist + rotMatrix[3]*yDist + rotMatrix[6]*zDist;
  T y = pos[1] + rotMatrix[1]*xDist + rotMatrix[4]*yDist + rotMatrix[7]*zDist;
  T z = pos[2] + rotMatrix[2]*xDist + rotMatrix[5]*yDist + rotMatrix[8]*zDist;
 
  T a = util::pow ( util::abs( (x-pos[0]) / _ind.getXHalfAxis() ), _ind.getExponent1() );
  T b = util::pow ( util::abs( (y-pos[1]) / _ind.getYHalfAxis() ), _ind.getExponent1() );
  T c = util::pow ( util::abs( (z-pos[2]) / _ind.getZHalfAxis() ), _ind.getExponent2() );
  T ab = util::pow( a+b, _ind.getExponent2()/_ind.getExponent1() );
 
  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:

signedDistance()

template<typename T , typename S , bool PARTICLE>

const S olb::SmoothIndicatorSuperEllipsoid3D< T, S, PARTICLE >::signedDistance ( const PhysR< S, 3 > input )

override

Definition at line 341 of file smoothIndicatorF3D.hh.

{
  // counter-clockwise rotation by _theta=-theta around the center of mass
  Vector<S,3> p;
  if constexpr(!PARTICLE) {
    // counter-clockwise rotation by _theta=-theta around the current position of the center of mass & translation
    p = util::executeRotation<S,3,true>(input, this->_rotMat, this->getPos());
  }
  else {
    p = input;
  }
  return _ind.signedDistance(p + _ind.getCenter());
}

surfaceNormal()

template<typename T , typename S , bool PARTICLE>

Vector< S, 3 > olb::SmoothIndicatorSuperEllipsoid3D< T, S, PARTICLE >::surfaceNormal ( const Vector< S, 3 > & pos, const S meshSize )

override

Definition at line 335 of file smoothIndicatorF3D.hh.

{
  return _ind.surfaceNormal(pos, meshSize);
}

---

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

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