olb::BlockIndicatorIdentity3D< T > Class Template Reference

Block indicator identity. More...

#include <blockIndicatorF3D.h>

Inheritance diagram for olb::BlockIndicatorIdentity3D< T >:

Collaboration diagram for olb::BlockIndicatorIdentity3D< T >:

Public Member Functions
	BlockIndicatorIdentity3D (BlockIndicatorF3D< T > &indicatorF)
bool	operator() (bool output[], const int input[]) override
	has to be implemented for 'every' derived class
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< 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
BlockIndicatorF3D< T > &	_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< 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::BlockF3D< bool >
	BlockF3D (BlockStructureD< 3 > &blockStructure, int targetDim)
Protected Member Functions inherited from olb::GenericF< bool, int >
	GenericF (int targetDim, int sourceDim)

Detailed Description

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

Block indicator identity.

Definition at line 189 of file blockIndicatorF3D.h.

Constructor & Destructor Documentation

BlockIndicatorIdentity3D()

template<typename T >

olb::BlockIndicatorIdentity3D< T >::BlockIndicatorIdentity3D

(

BlockIndicatorF3D< T > &

indicatorF

)

Parameters

indicatorF

Block indicator to be proxied

Definition at line 326 of file blockIndicatorF3D.hh.

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

Member Function Documentation

getMax()

template<typename T >

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

overridevirtual

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

Implements olb::BlockIndicatorF3D< T >.

Definition at line 344 of file blockIndicatorF3D.hh.

{
  return _indicatorF.getMax();
}

getMin()

template<typename T >

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

overridevirtual

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

Implements olb::BlockIndicatorF3D< T >.

Definition at line 338 of file blockIndicatorF3D.hh.

{
  return _indicatorF.getMin();
}

operator()()

template<typename T >

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

overridevirtual

has to be implemented for 'every' derived class

Implements olb::GenericF< bool, int >.

Definition at line 332 of file blockIndicatorF3D.hh.

{
  return _indicatorF(output, input);
}

Member Data Documentation

_indicatorF

template<typename T >

BlockIndicatorF3D<T>& olb::BlockIndicatorIdentity3D< T >::_indicatorF

protected

Definition at line 191 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