SmoothIndicatorF3D is an application from $\Omega \subset R^3 \to [0,1]$ . More...

#include <smoothIndicatorBaseF3D.h>

Inheritance diagram for olb::SmoothIndicatorF3D< T, S, true >:

Collaboration diagram for olb::SmoothIndicatorF3D< T, S, true >:

Public Member Functions
const S &	getCircumRadius () const

const S &	getEpsilon () const

std::string	name ()

void	setEpsilon (S epsilon)

virtual S	getVolume ()

virtual Vector< S, 4 >	calcMofiAndMass (S density)

virtual Vector< S, 3 >	calcCenterOfMass ()

virtual Vector< S, 3 >	surfaceNormal (const Vector< S, 3 > &pos, const S meshSize)

virtual Vector< S, 3 >	surfaceNormal (const Vector< S, 3 > &pos, const S meshSize, std::function< Vector< S, 3 >(const Vector< S, 3 > &)> transformPos)

virtual const S	signedDistance (const PhysR< T, 3 > input)

virtual bool	distance (S &distance, const Vector< S, 3 > &origin, const Vector< S, 3 > &direction, S precision, S pitch)

virtual bool	operator() (T output[], const S input[])
	has to be implemented for 'every' derived class

bool	isInsideCircumRadius (const PhysR< S, 3 > &input)

Public Member Functions inherited from olb::AnalyticalF< D, T, S >
AnalyticalF< D, T, S > &	operator- (AnalyticalF< D, T, S > &rhs)

AnalyticalF< D, T, S > &	operator+ (AnalyticalF< D, T, S > &rhs)

AnalyticalF< D, T, S > &	operator* (AnalyticalF< D, T, S > &rhs)

AnalyticalF< D, T, S > &	operator/ (AnalyticalF< D, T, S > &rhs)

Public Member Functions inherited from olb::GenericF< T, 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() (T output[])
	wrapper that call the pure virtual operator() (T output[], const S input[]) from above

bool	operator() (T output[], S input0)

bool	operator() (T output[], S input0, S input1)

bool	operator() (T output[], S input0, S input1, S input2)

bool	operator() (T output[], S input0, S input1, S input2, S input3)

Protected Member Functions
	SmoothIndicatorF3D ()

Protected Member Functions inherited from olb::AnalyticalF< D, T, S >
	AnalyticalF (int n)

Protected Member Functions inherited from olb::GenericF< T, S >
	GenericF (int targetDim, int sourceDim)

Protected Attributes
S	_circumRadius

S	_epsilon

std::string	_name ="3D-Particle surface"

Additional Inherited Members
Public Types inherited from olb::AnalyticalF< D, T, S >
using	identity_functor_type = AnalyticalIdentity<D,T,S>

Public Types inherited from olb::GenericF< T, S >
using	targetType = T

using	sourceType = S

Public Attributes inherited from olb::GenericF< T, S >
std::shared_ptr< GenericF< T, S > >	_ptrCalcC
	memory management, frees resouces (calcClass)

Static Public Attributes inherited from olb::AnalyticalF< D, T, S >
static constexpr unsigned	dim = D

Detailed Description

template<typename T, typename S>
class olb::SmoothIndicatorF3D< T, S, true >

SmoothIndicatorF3D is an application from $\Omega \subset R^3 \to [0,1]$ .

Base class for specific SmoothIndicator implementation providing common data..

Definition at line 101 of file smoothIndicatorBaseF3D.h.

Constructor & Destructor Documentation

◆ SmoothIndicatorF3D()

template<typename T , typename S >

olb::SmoothIndicatorF3D< T, S, true >::SmoothIndicatorF3D ( )

protected

Definition at line 245 of file smoothIndicatorBaseF3D.hh.

  : AnalyticalF3D<T,S>(1),
    _circumRadius(S()), _epsilon(S())
{ }

Member Function Documentation

◆ calcCenterOfMass()

template<typename T , typename S >

Vector< S, 3 > olb::SmoothIndicatorF3D< T, S, true >::calcCenterOfMass ( )

virtual

Definition at line 380 of file smoothIndicatorBaseF3D.hh.

{
  // TODO: Fallback
  assert(false);
  return S(std::numeric_limits<BaseType<S>>::quiet_NaN());
}

◆ calcMofiAndMass()

template<typename T , typename S >

Vector< S, 4 > olb::SmoothIndicatorF3D< T, S, true >::calcMofiAndMass ( S density )

virtual

Definition at line 372 of file smoothIndicatorBaseF3D.hh.

{
  // TODO: Fallback
  assert(false);
  return S(std::numeric_limits<BaseType<S>>::quiet_NaN());
}

◆ distance()

template<typename T , typename S >

bool olb::SmoothIndicatorF3D< T, S, true >::distance	(	S &	distance,
		const Vector< S, 3 > &	origin,
		const Vector< S, 3 > &	direction,
		S	precision,
		S	pitch )

virtual

Definition at line 293 of file smoothIndicatorBaseF3D.hh.

{
  S const halfEps = this->getEpsilon() * 0.5;
  bool originValue;
  bool currentValue;
 
  // start at origin and move into given direction
  PhysR<S,3> currentPoint(origin);
 
  originValue = this->signedDistance(origin) <= halfEps;
  currentValue = this->signedDistance(currentPoint) <= halfEps;
 
  while (currentValue == originValue && this->isInsideCircumRadius(currentPoint)) {
    currentPoint += direction;
    // update currentValue until the first point on the other side (inside/outside) is found
    currentValue = this->signedDistance(currentPoint) <= halfEps;
  }
 
  // return false if no point was found in given direction
  if (!this->isInsideCircumRadius(currentPoint) && !originValue) {
    return false;
  }
 
 
  while (pitch >= precision) {
    if (!this->isInsideCircumRadius(currentPoint) && originValue) {
      currentPoint -= pitch * direction;
      pitch /= 2.;
    }
    else {
      currentValue = this->signedDistance(currentPoint) <= halfEps;
      if (currentValue == originValue) {
        currentPoint += pitch * direction;
        pitch /= 2.;
      }
      else {
        currentPoint -= pitch * direction;
        pitch /= 2.;
      }
    }
  }
 
  distance = norm(currentPoint - origin);
  return true;
}

References olb::norm().

Here is the call graph for this function:

◆ getCircumRadius()

template<typename T , typename S >

const S & olb::SmoothIndicatorF3D< T, S, true >::getCircumRadius ( ) const

Definition at line 340 of file smoothIndicatorBaseF3D.hh.

{
  return _circumRadius;
}

◆ getEpsilon()

template<typename T , typename S >

const S & olb::SmoothIndicatorF3D< T, S, true >::getEpsilon ( ) const

Definition at line 346 of file smoothIndicatorBaseF3D.hh.

{
  return _epsilon;
}

◆ getVolume()

template<typename T , typename S >

S olb::SmoothIndicatorF3D< T, S, true >::getVolume ( )

virtual

Definition at line 364 of file smoothIndicatorBaseF3D.hh.

{
  // TODO: Fallback
  assert(false);
  return std::numeric_limits<double>::quiet_NaN();
}

◆ isInsideCircumRadius()

template<typename T , typename S >

bool olb::SmoothIndicatorF3D< T, S, true >::isInsideCircumRadius ( const PhysR< S, 3 > & input )

Definition at line 262 of file smoothIndicatorBaseF3D.hh.

{
  return norm(input) <= this->getCircumRadius();
}

References olb::norm().

Here is the call graph for this function:

◆ name()

template<typename T , typename S >

std::string olb::SmoothIndicatorF3D< T, S, true >::name ( )

Definition at line 352 of file smoothIndicatorBaseF3D.hh.

{
  return _name;
}

◆ operator()()

template<typename T , typename S >

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

virtual

has to be implemented for 'every' derived class

Implements olb::GenericF< T, S >.

Definition at line 251 of file smoothIndicatorBaseF3D.hh.

{
#ifdef OLB_DEBUG
  OstreamManager clout(std::cout, "SmoothIndicator3D");
  clout << "WARNING: SmoothIndicatorF3D::operator() a particle (= true) SmoothIndicator does not consider the current position of the particle. Please use the evalSolidVolumeFraction method for this." << std::endl;
#endif
  T const signedDist = this->signedDistance(input);
  return sdf::evalSolidVolumeFraction(output, signedDist, this->getEpsilon());
}

References olb::sdf::evalSolidVolumeFraction().

Here is the call graph for this function:

◆ setEpsilon()

template<typename T , typename S >

void olb::SmoothIndicatorF3D< T, S, true >::setEpsilon ( S epsilon )

Definition at line 358 of file smoothIndicatorBaseF3D.hh.

{
  _epsilon = epsilon;
}

◆ signedDistance()

template<typename T , typename S >

const S olb::SmoothIndicatorF3D< T, S, true >::signedDistance ( const PhysR< T, 3 > input )

virtual

Definition at line 285 of file smoothIndicatorBaseF3D.hh.

{
  // TODO: Raymarching as fallback
  assert(false);
  return std::numeric_limits<double>::quiet_NaN();
}

◆ surfaceNormal() [1/2]

template<typename T , typename S >

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

virtual

Definition at line 268 of file smoothIndicatorBaseF3D.hh.

{
  return surfaceNormal(pos, meshSize, [&](const Vector<S,3>& pos) {
    return pos;
  });
}

◆ surfaceNormal() [2/2]

template<typename T , typename S >

Vector< S, 3 > olb::SmoothIndicatorF3D< T, S, true >::surfaceNormal	(	const Vector< S, 3 > &	pos,
		const S	meshSize,
		std::function< Vector< S, 3 >(const Vector< S, 3 > &)>	transformPos )

virtual

Definition at line 276 of file smoothIndicatorBaseF3D.hh.

{
  return util::surfaceNormal(pos, meshSize, [&](const Vector<S,3>& pos) {
    return this->signedDistance( transformPos(pos) );
  });
}

References olb::util::surfaceNormal().

Here is the call graph for this function:

Member Data Documentation

◆ _circumRadius

template<typename T , typename S >

S olb::SmoothIndicatorF3D< T, S, true >::_circumRadius

protected

Definition at line 104 of file smoothIndicatorBaseF3D.h.

◆ _epsilon

template<typename T , typename S >

S olb::SmoothIndicatorF3D< T, S, true >::_epsilon

protected

Definition at line 105 of file smoothIndicatorBaseF3D.h.

◆ _name

template<typename T , typename S >

std::string olb::SmoothIndicatorF3D< T, S, true >::_name ="3D-Particle surface"

protected

Definition at line 106 of file smoothIndicatorBaseF3D.h.

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

src/functors/analytical/indicator/smoothIndicatorBaseF3D.h
src/functors/analytical/indicator/smoothIndicatorBaseF3D.hh

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SmoothIndicatorF3D()

Member Function Documentation

◆ calcCenterOfMass()

◆ calcMofiAndMass()

◆ distance()

◆ getCircumRadius()

◆ getEpsilon()

◆ getVolume()

◆ isInsideCircumRadius()

◆ name()

◆ operator()()

◆ setEpsilon()

◆ signedDistance()

◆ surfaceNormal() [1/2]

◆ surfaceNormal() [2/2]

Member Data Documentation

◆ _circumRadius

◆ _epsilon

◆ _name