olb::BlockIndicatorFfromSmoothIndicatorF3D< T, HLBM > Class Template Reference

BlockIndicatorF3D from SmoothIndicatorF3D. More...

#include <blockIndicatorF3D.h>

Inheritance diagram for olb::BlockIndicatorFfromSmoothIndicatorF3D< T, HLBM >:

Collaboration diagram for olb::BlockIndicatorFfromSmoothIndicatorF3D< T, HLBM >:

Public Member Functions
	BlockIndicatorFfromSmoothIndicatorF3D (SmoothIndicatorF3D< T, T, HLBM > &indicatorF, BlockGeometry< T, 3 > &blockGeometry)
bool	operator() (bool output[], const int input[]) override
Vector< int, 3 >	getMin () override
	Returns min lattice position of the indicated domain's bounding box.
Vector< int, 3 >	getMax () override
	Returns max lattice position of the indicated domain's bounding box.
Public Member Functions inherited from olb::BlockIndicatorF3D< T >
	BlockIndicatorF3D (BlockGeometry< T, 3 > &geometry)
BlockGeometry< T, 3 > &	getBlockGeometry ()
	Get underlying block geometry structure.
bool	operator() (const int input[])
	Block indicator specific function operator overload.
bool	operator() (int iX, int iY, int iZ)
bool	operator() (LatticeR< 3 > loc)
void	setCache (const BlockData< 3, T, bool > &cache)
	Set bool-mask cache to be used by indicator operator overloads.
virtual bool	isEmpty ()
	Returns true only if the indicated domain subset is empty.
Public Member Functions inherited from olb::BlockF3D< bool >
	~BlockF3D () override
	virtual destructor for defined behaviour
virtual BlockStructureD< 3 > &	getBlockStructure () const
BlockF3D< bool > &	operator- (BlockF3D< bool > &rhs)
BlockF3D< bool > &	operator+ (BlockF3D< bool > &rhs)
BlockF3D< bool > &	operator* (BlockF3D< bool > &rhs)
BlockF3D< bool > &	operator/ (BlockF3D< bool > &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
virtual bool	operator() (T output[], const S input[])=0
	has to be implemented for 'every' derived class
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 Attributes
SmoothIndicatorF3D< T, T, HLBM > &	_indicatorF
Protected Attributes inherited from olb::BlockIndicatorF3D< T >
BlockGeometry< T, 3 > &	_block
const BlockData< 3, T, bool > *	_cachedData
Protected Attributes inherited from olb::BlockF3D< bool >
BlockStructureD< 3 > &	_blockStructure

Additional Inherited Members
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)
Protected Member Functions inherited from olb::BlockF3D< bool >
	BlockF3D (BlockStructureD< 3 > &blockStructure, int targetDim)
Protected Member Functions inherited from olb::GenericF< T, S >
	GenericF (int targetDim, int sourceDim)

Detailed Description

template<typename T, bool HLBM>
class olb::BlockIndicatorFfromSmoothIndicatorF3D< T, HLBM >

BlockIndicatorF3D from SmoothIndicatorF3D.

Definition at line 58 of file blockIndicatorF3D.h.

Constructor & Destructor Documentation

BlockIndicatorFfromSmoothIndicatorF3D()

template<typename T , bool HLBM>

olb::BlockIndicatorFfromSmoothIndicatorF3D< T, HLBM >::BlockIndicatorFfromSmoothIndicatorF3D	(	SmoothIndicatorF3D< T, T, HLBM > &	indicatorF,
		BlockGeometry< T, 3 > &	blockGeometry )

Parameters

indicatorF	Smooth indicator to be reduced to lattice space
blockGeometry	Block geometry structure to be used for conversion between lattice and physical coordinates.

Definition at line 73 of file blockIndicatorF3D.hh.

  : BlockIndicatorF3D<T>(blockGeometry),
    _indicatorF(indicatorF)
{ }

Member Function Documentation

getMax()

template<typename T , bool HLBM>

Vector< int, 3 > olb::BlockIndicatorFfromSmoothIndicatorF3D< T, HLBM >::getMax ( )

overridevirtual

Returns max lattice position of the indicated domain's bounding box.

Implements olb::BlockIndicatorF3D< T >.

Definition at line 101 of file blockIndicatorF3D.hh.

{
  const T max = _indicatorF.getCircumRadius();
  return Vector<int,3> {
    static_cast<int>(util::ceil(max)),
    static_cast<int>(util::ceil(max)),
    static_cast<int>(util::ceil(max))
  };
}

References olb::util::ceil().

Here is the call graph for this function:

getMin()

template<typename T , bool HLBM>

Vector< int, 3 > olb::BlockIndicatorFfromSmoothIndicatorF3D< T, HLBM >::getMin ( )

overridevirtual

Returns min lattice position of the indicated domain's bounding box.

Implements olb::BlockIndicatorF3D< T >.

Definition at line 90 of file blockIndicatorF3D.hh.

{
  const T min = -_indicatorF.getCircumRadius();
  return Vector<int,3> {
    static_cast<int>(util::floor(min)),
    static_cast<int>(util::floor(min)),
    static_cast<int>(util::floor(min))
  };
}

References olb::util::floor().

Here is the call graph for this function:

operator()()

template<typename T , bool HLBM>

bool olb::BlockIndicatorFfromSmoothIndicatorF3D< T, HLBM >::operator() ( bool output[], const int input[] )

override

Definition at line 80 of file blockIndicatorF3D.hh.

{
  T physR[3];
  T inside[1];
  this->_block.getPhysR(physR,input);
  _indicatorF(inside, physR);
  return !util::nearZero(inside[0]);
}

References olb::util::nearZero().

Here is the call graph for this function:

Member Data Documentation

_indicatorF

template<typename T , bool HLBM>

SmoothIndicatorF3D<T,T,HLBM>& olb::BlockIndicatorFfromSmoothIndicatorF3D< T, HLBM >::_indicatorF

protected

Definition at line 60 of file blockIndicatorF3D.h.

---

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

• src/functors/lattice/indicator/blockIndicatorF3D.h
• src/functors/lattice/indicator/blockIndicatorF3D.hh