olb::IndicatorTranslate3D< S > Class Template Reference

#include <indicatorF3D.h>

Inheritance diagram for olb::IndicatorTranslate3D< S >:

Collaboration diagram for olb::IndicatorTranslate3D< S >:

Public Member Functions
	IndicatorTranslate3D (std::array< S, 3 > translate, IndicatorF3D< S > &indicator)
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.
Vector< S, 3 > &	getMin () override
Vector< S, 3 > &	getMax () override
Public Member Functions inherited from olb::IndicatorF3D< S >
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::IndicatorTranslate3D< S >

Definition at line 59 of file indicatorF3D.h.

Constructor & Destructor Documentation

IndicatorTranslate3D()

template<typename S >

olb::IndicatorTranslate3D< S >::IndicatorTranslate3D	(	std::array< S, 3 >	translate,
		IndicatorF3D< S > &	indicator )

Definition at line 40 of file indicatorF3D.hh.

  : _translate(translate), _indicator(indicator), _myMin(indicator.getMin()), _myMax(indicator.getMax())
{
  this->_myMin[0] += this->_translate[0];
  this->_myMin[1] += this->_translate[1];
  this->_myMin[2] += this->_translate[2];
 
  this->_myMax[0] += this->_translate[0];
  this->_myMax[1] += this->_translate[1];
  this->_myMax[2] += this->_translate[2];
}

Member Function Documentation

getMax()

template<typename S >

Vector< S, 3 > & olb::IndicatorTranslate3D< S >::getMax ( )

overridevirtual

Reimplemented from olb::IndicatorF3D< S >.

Definition at line 79 of file indicatorF3D.hh.

{
  return _myMax;
}

getMin()

template<typename S >

Vector< S, 3 > & olb::IndicatorTranslate3D< S >::getMin ( )

overridevirtual

Reimplemented from olb::IndicatorF3D< S >.

Definition at line 73 of file indicatorF3D.hh.

{
  return _myMin;
}

operator()()

template<typename S >

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

overridevirtual

has to be implemented for 'every' derived class

Implements olb::GenericF< bool, S >.

Definition at line 53 of file indicatorF3D.hh.

{
  const S inputTranslated[3] = {
    input[0] - _translate[0],
    input[1] - _translate[1],
    input[2] - _translate[2]
  };
 
  _indicator.operator()(output, inputTranslated);
  return output[0];
}

signedDistance()

template<typename S >

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

{
  Vector<S,3> translate = sdf::translate(input, {_translate[0], _translate[1], _translate[2]});
  return _indicator.signedDistance(translate);
}

References olb::sdf::translate().

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