olb::BlockIndicatorFfromCallableF2D< T > Class Template Reference

Block indicator helper for people that don't like writing boilerplate. More...

#include <blockIndicatorF2D.h>

Inheritance diagram for olb::BlockIndicatorFfromCallableF2D< T >:

Collaboration diagram for olb::BlockIndicatorFfromCallableF2D< T >:

Public Member Functions
template<typename F >
	BlockIndicatorFfromCallableF2D (BlockGeometry< T, 2 > &blockGeometry, F &&f)
bool	operator() (bool output[], const int input[]) override
	has to be implemented for 'every' derived class
Vector< int, 2 >	getMin () override
	Returns min lattice position of the indicated subset's bounding box.
Vector< int, 2 >	getMax () override
	Returns max lattice position of the indicated subset's bounding box.
Public Member Functions inherited from olb::BlockIndicatorF2D< T >
	BlockIndicatorF2D (BlockGeometry< T, 2 > &geometry)
BlockGeometry< T, 2 > &	getBlockGeometry ()
	Get underlying block geometry structure.
bool	operator() (const int input[])
	Block indicator specific function operator overload.
bool	operator() (int iX, int iY)
bool	operator() (LatticeR< 2 > loc)
void	setCache (const BlockData< 2, 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::BlockF2D< bool >
virtual BlockStructureD< 2 > &	getBlockStructure ()
	virtual destructor for defined behaviour
void	setBlockStructure (BlockStructureD< 2 > *blockStructure)
BlockF2D< bool > &	operator- (BlockF2D< bool > &rhs)
BlockF2D< bool > &	operator+ (BlockF2D< bool > &rhs)
BlockF2D< bool > &	operator* (BlockF2D< bool > &rhs)
BlockF2D< bool > &	operator/ (BlockF2D< bool > &rhs)
Public Member Functions inherited from olb::GenericF< bool, int >
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[], int input0)
bool	operator() (bool output[], int input0, int input1)
bool	operator() (bool output[], int input0, int input1, int input2)
bool	operator() (bool output[], int input0, int input1, int input2, int input3)

Protected Attributes
std::function< bool(LatticeR< 2 >)>	_callableF
Protected Attributes inherited from olb::BlockIndicatorF2D< T >
BlockGeometry< T, 2 > &	_blockGeometryStructure
const BlockData< 2, T, bool > *	_cachedData
Protected Attributes inherited from olb::BlockF2D< bool >
BlockStructureD< 2 > *	_blockStructure

Additional Inherited Members
Public Types inherited from olb::GenericF< bool, int >
using	targetType
using	sourceType
Public Attributes inherited from olb::GenericF< bool, int >
std::shared_ptr< GenericF< bool, int > >	_ptrCalcC
	memory management, frees resouces (calcClass)
Protected Member Functions inherited from olb::BlockF2D< bool >
	BlockF2D (BlockStructureD< 2 > &blockStructure, int targetDim)
	BlockF2D (int targetDim)
Protected Member Functions inherited from olb::GenericF< bool, int >
	GenericF (int targetDim, int sourceDim)

Detailed Description

template<typename T>
class olb::BlockIndicatorFfromCallableF2D< T >

Block indicator helper for people that don't like writing boilerplate.

Definition at line 366 of file aliases.h.

Constructor & Destructor Documentation

BlockIndicatorFfromCallableF2D()

template<typename T >

template<typename F >

olb::BlockIndicatorFfromCallableF2D< T >::BlockIndicatorFfromCallableF2D ( BlockGeometry< T, 2 > & blockGeometry, F && f )

inline

Definition at line 65 of file blockIndicatorF2D.h.

  : BlockIndicatorF2D<T>(blockGeometry)
  , _callableF(f)
  { }

Member Function Documentation

getMax()

template<typename T >

Vector< int, 2 > olb::BlockIndicatorFfromCallableF2D< T >::getMax ( )

inlineoverridevirtual

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

Implements olb::BlockIndicatorF2D< T >.

Definition at line 80 of file blockIndicatorF2D.h.

                                  {
    return std::numeric_limits<int>::max();
  }

getMin()

template<typename T >

Vector< int, 2 > olb::BlockIndicatorFfromCallableF2D< T >::getMin ( )

inlineoverridevirtual

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

Implements olb::BlockIndicatorF2D< T >.

Definition at line 77 of file blockIndicatorF2D.h.

                                  {
    return std::numeric_limits<int>::min();
  }

operator()()

template<typename T >

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

inlineoverridevirtual

has to be implemented for 'every' derived class

Implements olb::GenericF< bool, int >.

Definition at line 72 of file blockIndicatorF2D.h.

                                                              {
    output[0] = _callableF(input);
    return true;
  }

References olb::BlockIndicatorFfromCallableF2D< T >::_callableF.

Member Data Documentation

_callableF

template<typename T >

std::function<bool(LatticeR<2>)> olb::BlockIndicatorFfromCallableF2D< T >::_callableF

protected

Definition at line 61 of file blockIndicatorF2D.h.

---

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

• src/functors/lattice/indicator/blockIndicatorF2D.h
• src/utilities/aliases.h