olb::IndicatorLayer3D< S > Class Template Reference

indicator function for a layer More...

#include <indicatorF3D.h>

Inheritance diagram for olb::IndicatorLayer3D< S >:

Collaboration diagram for olb::IndicatorLayer3D< S >:

Public Member Functions
	IndicatorLayer3D (FunctorPtr< IndicatorF3D< S > > &&indicatorF, S layerSize)
bool	operator() (bool output[], const S input[]) override
	has to be implemented for 'every' derived class
S	signedDistance (const Vector< S, 3 > &input) override
	Returns signed distance to the nearest point on the indicator surface.
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 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::IndicatorLayer3D< S >

indicator function for a layer

Definition at line 116 of file indicatorF3D.h.

Constructor & Destructor Documentation

IndicatorLayer3D()

template<typename S >

olb::IndicatorLayer3D< S >::IndicatorLayer3D	(	FunctorPtr< IndicatorF3D< S > > &&	indicatorF,
		S	layerSize )

Definition at line 220 of file indicatorF3D.hh.

  :  _indicatorF(std::move(indicatorF)), _layerSize(layerSize)
{
  this->_myMin = indicatorF->getMin() - layerSize;
  this->_myMax = indicatorF->getMax() + layerSize;
}

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

Member Function Documentation

operator()()

template<typename S >

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

overridevirtual

has to be implemented for 'every' derived class

Implements olb::GenericF< bool, S >.

Definition at line 229 of file indicatorF3D.hh.

{
  output[0] = false;
  S r[3];
  for (int iX =- 1; iX < 2; ++iX) {
    for (int iY =- 1; iY < 2; ++iY) {
      for (int iZ =- 1; iZ < 2; ++iZ) {
        r[0] = input[0] + iX*_layerSize;
        r[1] = input[1] + iY*_layerSize;
        r[2] = input[2] + iZ*_layerSize;
        _indicatorF(output,r);
        if (output[0]) {
          return true;
        }
      }
    }
  }
  return true;
}

signedDistance()

template<typename S >

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

{
 
// Rounding: Creates a Layer with a constant thickness --> edges are rounded
  return sdf::rounding(_indicatorF->signedDistance(input), _layerSize);
 
 
}

References olb::sdf::rounding().

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