olb::IndicatorCuboid3D< S > Class Template Reference

indicator function for a 3d-cuboid, parallel to the planes x=0, y=0, z=0. More...

#include <indicatorF3D.h>

Inheritance diagram for olb::IndicatorCuboid3D< S >:

Collaboration diagram for olb::IndicatorCuboid3D< S >:

Public Member Functions
	IndicatorCuboid3D (Vector< S, 3 > extend, Vector< S, 3 > origin)
	constructs an cuboid with x axis from origin[0] to origin[0]+extend[0], ...
	IndicatorCuboid3D (S xlength, S ylength, S zlength, Vector< S, 3 > center)
	constructs an cuboid with x axis dimension center[0]-xlength/2 to center[0]+xlength/2
Vector< S, 3 > const &	getCenter () const
S const	getxLength () const
S const	getyLength () const
S const	getzLength () const
bool	operator() (bool output[], const S input[]) override
	returns true if input is inside, otherwise false
S	signedDistance (const Vector< S, 3 > &input) override
	Returns signed distance to the nearest point on the indicator surface.
Vector< S, 3 >	getSample (const std::function< S()> &randomness) const override
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
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::IndicatorCuboid3D< S >

indicator function for a 3d-cuboid, parallel to the planes x=0, y=0, z=0.

Parameters

extend	must have only positive elements
xLength	must be positive

Definition at line 238 of file indicatorF3D.h.

Constructor & Destructor Documentation

IndicatorCuboid3D() [1/2]

template<typename S >

olb::IndicatorCuboid3D< S >::IndicatorCuboid3D	(	Vector< S, 3 >	extend,
		Vector< S, 3 >	origin )

constructs an cuboid with x axis from origin[0] to origin[0]+extend[0], ...

Definition at line 640 of file indicatorF3D.hh.

  : _center(origin+.5*extend),_xLength(extend[0]), _yLength(extend[1]), _zLength(extend[2])
{
  assert(_xLength>0 && _yLength>0 && _zLength>0);
 
  this->_myMin = origin;
  this->_myMax = origin + extend;
}

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

IndicatorCuboid3D() [2/2]

template<typename S >

olb::IndicatorCuboid3D< S >::IndicatorCuboid3D	(	S	xlength,
		S	ylength,
		S	zlength,
		Vector< S, 3 >	center )

constructs an cuboid with x axis dimension center[0]-xlength/2 to center[0]+xlength/2

Definition at line 650 of file indicatorF3D.hh.

  : _center(center), _xLength(xLength), _yLength(yLength), _zLength(zLength)
{
  assert(_xLength>0 && _yLength>0 && _zLength>0);
 
  this->_myMin = {_center[0] - S{0.5}*_xLength, _center[1] - S{0.5}*_yLength, _center[2] - S{0.5}*_zLength};
  this->_myMax = {_center[0] + S{0.5}*_xLength, _center[1] + S{0.5}*_yLength, _center[2] + S{0.5}*_zLength};
}

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

Member Function Documentation

getCenter()

template<typename S >

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

(

)

const

Definition at line 660 of file indicatorF3D.hh.

{
  return _center;
}

getSample()

template<typename S >

Vector< S, 3 > olb::IndicatorCuboid3D< S >::getSample ( const std::function< S()> & randomness ) const

overridevirtual

Parameters

randomness

Callable returning uniformly sampled values in [0,1]

Reimplemented from olb::IndicatorF3D< S >.

Definition at line 709 of file indicatorF3D.hh.

{
  // Select random point on center axis
  Vector<S,3> v = {_xLength, _yLength, _zLength};
  auto it = std::minmax_element(v.begin(), v.end());
  int min_idx = std::distance(v.begin(), it.first);
  Vector<S,3> axis{0, 0, 0};
  axis[min_idx] = v[min_idx];
  auto axisPoint = _center + axis * randomness();
  // Compute cut at point on center axis
  auto hyperplane = Hyperplane3D<S>().originAt(axisPoint)
                                     .normalTo(axis);
  // Select random point on 2D square
  int max_idx = std::distance(v.begin(), it.second);
  const S width = v[max_idx] * randomness();
  int i = 3 - max_idx - min_idx;
  const S height = v[i] * randomness();
  // Project random square point to axis-orthogonal plane with axisPoint intersect
  return hyperplane.project({width,height});
}

References olb::Vector< T, D >::begin(), olb::Vector< T, D >::end(), olb::Hyperplane3D< T >::normalTo(), and olb::Hyperplane3D< T >::originAt().

Here is the call graph for this function:

getxLength()

template<typename S >

S const olb::IndicatorCuboid3D< S >::getxLength

(

)

const

Definition at line 666 of file indicatorF3D.hh.

{
  return _xLength;
}

Here is the caller graph for this function:

getyLength()

template<typename S >

S const olb::IndicatorCuboid3D< S >::getyLength

(

)

const

Definition at line 672 of file indicatorF3D.hh.

{
  return _yLength;
}

getzLength()

template<typename S >

S const olb::IndicatorCuboid3D< S >::getzLength

(

)

const

Definition at line 678 of file indicatorF3D.hh.

{
  return _zLength;
}

operator()()

template<typename S >

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

overridevirtual

returns true if input is inside, otherwise false

Implements olb::GenericF< bool, S >.

Reimplemented in olb::IndicatorCuboidRotate3D< S >.

Definition at line 684 of file indicatorF3D.hh.

{
  // returns true if x is inside the cuboid
  Vector<S,3> q = distanceXYZ(input);
  Vector<S,3> eps = std::numeric_limits<BaseType<S>>::epsilon();
  output[0] = ( q < eps );
  return output[0];
}

Here is the caller graph for this function:

signedDistance()

template<typename S >

S olb::IndicatorCuboid3D< S >::signedDistance ( const Vector< S, 3 > & input )

overridevirtual

Returns signed distance to the nearest point on the indicator surface.

Reimplemented from olb::IndicatorF3D< S >.

Reimplemented in olb::IndicatorCuboidRotate3D< S >.

Definition at line 703 of file indicatorF3D.hh.

{
  return sdf::box(input - _center, Vector<S,3>(.5*_xLength, .5*_yLength, .5*_zLength));
}

References olb::sdf::box().

Here is the call graph for this function:

Here is the caller 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