olb::BlockIndicatorBoundaryNeighbor3D< T > Class Template Reference

Block indicator identifying neighbors of boundary cells. More...

#include <blockIndicatorF3D.h>

Inheritance diagram for olb::BlockIndicatorBoundaryNeighbor3D< T >:

Collaboration diagram for olb::BlockIndicatorBoundaryNeighbor3D< T >:

Public Member Functions
	BlockIndicatorBoundaryNeighbor3D (BlockIndicatorF3D< T > &indicatorF, int overlap)
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
BlockIndicatorF3D< T > &	_indicatorF
int	_overlap
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>
class olb::BlockIndicatorBoundaryNeighbor3D< T >

Block indicator identifying neighbors of boundary cells.

Definition at line 181 of file blockIndicatorF3D.h.

Constructor & Destructor Documentation

BlockIndicatorBoundaryNeighbor3D()

template<typename T >

olb::BlockIndicatorBoundaryNeighbor3D< T >::BlockIndicatorBoundaryNeighbor3D	(	BlockIndicatorF3D< T > &	indicatorF,
		int	overlap )

Definition at line 299 of file blockIndicatorF3D.hh.

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

Member Function Documentation

getMax()

template<typename T >

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

overridevirtual

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

Implements olb::BlockIndicatorF3D< T >.

Definition at line 335 of file blockIndicatorF3D.hh.

{
  return _indicatorF.getMax() + _overlap;
}

getMin()

template<typename T >

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

overridevirtual

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

Implements olb::BlockIndicatorF3D< T >.

Definition at line 329 of file blockIndicatorF3D.hh.

{
  return _indicatorF.getMin() - _overlap;
}

operator()()

template<typename T >

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

override

Definition at line 306 of file blockIndicatorF3D.hh.

{
  // check if current position is not solid
  if ( this->getBlockGeometry().getMaterial(input[0],input[1],input[2]) != 0 ) {
    // check all neighbors if they are part of boundary via indicator
    for ( int iXo = -_overlap; iXo <= _overlap; ++iXo ) {
      for ( int iYo = -_overlap; iYo <= _overlap; ++iYo ) {
        for ( int iZo = -_overlap; iZo <= _overlap; ++iZo ) {
          const int neighborPos[3] = {iXo + input[0], iYo + input[1], iZo + input[2]};
          bool partOfBoundary[1] = {false};
          // material-indicator to check if part of boundary
          _indicatorF( partOfBoundary, neighborPos );
          if ( partOfBoundary[0] ) {
            return true;
          }
        }
      }
    }
  }
  return false;
}

Member Data Documentation

_indicatorF

template<typename T >

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

protected

Definition at line 183 of file blockIndicatorF3D.h.

_overlap

template<typename T >

int olb::BlockIndicatorBoundaryNeighbor3D< T >::_overlap

protected

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