olb::SuperIndicatorF3D< T > Class Template Reference

Base indicator functor (discrete) More...

#include <superIndicatorBaseF3D.h>

Inheritance diagram for olb::SuperIndicatorF3D< T >:

Collaboration diagram for olb::SuperIndicatorF3D< T >:

Public Types
using	identity_functor_type = SuperIndicatorIdentity3D<T>
Public Types inherited from olb::SuperF3D< T, bool >
using	identity_functor_type
Public Types inherited from olb::GenericF< W, int >
using	targetType
using	sourceType

Public Member Functions
	SuperIndicatorF3D (SuperGeometry< T, 3 > &geometry)
BlockIndicatorF3D< T > &	getBlockIndicatorF (int iCloc)
	Get block indicator.
SuperGeometry< T, 3 > &	getSuperGeometry ()
	Get underlying super geometry.
bool	operator() (const int input[])
	Indicator specific function operator overload.
bool	operator() (int iC, int iX, int iY, int iZ)
	Indicator specific function operator overload.
void	cache ()
	Optional: initialize _cachedData for faster access.
Public Member Functions inherited from olb::SuperF3D< T, bool >
SuperF3D< T, W > &	operator- (SuperF3D< T, W > &rhs)
SuperF3D< T, W > &	operator+ (SuperF3D< T, W > &rhs)
SuperF3D< T, W > &	operator* (SuperF3D< T, W > &rhs)
SuperF3D< T, W > &	operator/ (SuperF3D< T, W > &rhs)
SuperStructure< T, 3 > &	getSuperStructure ()
int	getBlockFSize () const
BlockF3D< W > &	getBlockF (int iCloc)
bool	operator() (W output[], const int input[])
	has to be implemented for 'every' derived class
Public Member Functions inherited from olb::GenericF< W, 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() (W output[])
	wrapper that call the pure virtual operator() (T output[], const S input[]) from above
bool	operator() (W output[], int input0)
bool	operator() (W output[], int input0, int input1)
bool	operator() (W output[], int input0, int input1, int input2)
bool	operator() (W output[], int input0, int input1, int input2, int input3)

Protected Attributes
SuperGeometry< T, 3 > &	_superGeometry
std::unique_ptr< SuperData< 3, T, bool > >	_cachedData
Protected Attributes inherited from olb::SuperF3D< T, bool >
SuperStructure< T, 3 > &	_superStructure
std::vector< std::unique_ptr< BlockF3D< W > > >	_blockF
	Super functors may consist of several BlockF3D<W> derived functors.

Additional Inherited Members
Public Attributes inherited from olb::GenericF< W, int >
std::shared_ptr< GenericF< W, int > >	_ptrCalcC
	memory management, frees resouces (calcClass)
Static Public Attributes inherited from olb::SuperF3D< T, bool >
static constexpr bool	isSuper
static constexpr unsigned	d
Protected Member Functions inherited from olb::SuperF3D< T, bool >
	SuperF3D (SuperStructure< T, 3 > &superStructure, int targetDim)
Protected Member Functions inherited from olb::GenericF< W, int >
	GenericF (int targetDim, int sourceDim)

Detailed Description

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

Base indicator functor (discrete)

Provides Union, Without and Intersection arithmetic. Note: operator() must be overloaded by child classes.

Implementations should maintain BlockIndicatorF3D instances as required.

Definition at line 194 of file aliases.h.

Member Typedef Documentation

identity_functor_type

template<typename T >

using olb::SuperIndicatorF3D< T >::identity_functor_type = SuperIndicatorIdentity3D<T>

Definition at line 56 of file superIndicatorBaseF3D.h.

Constructor & Destructor Documentation

SuperIndicatorF3D()

template<typename T >

olb::SuperIndicatorF3D< T >::SuperIndicatorF3D

(

SuperGeometry< T, 3 > &

geometry

)

Definition at line 34 of file superIndicatorBaseF3D.hh.

  : SuperF3D<T, bool>(geometry, 1),
    _superGeometry(geometry)
{ }

Member Function Documentation

cache()

template<typename T >

void olb::SuperIndicatorF3D< T >::cache

(

)

Optional: initialize _cachedData for faster access.

Definition at line 82 of file superIndicatorBaseF3D.hh.

{
  _cachedData = std::unique_ptr<SuperData<3,T,bool>>(
                  new SuperData<3,T,bool>(*this));
  for (unsigned iC = 0; iC < this->_blockF.size(); ++iC) {
    getBlockIndicatorF(iC).setCache(_cachedData->getBlock(iC));
  }
}

getBlockIndicatorF()

template<typename T >

BlockIndicatorF3D< T > & olb::SuperIndicatorF3D< T >::getBlockIndicatorF

(

int

iCloc

)

Get block indicator.

Returns

_blockF[iCloc] cast as BlockIndicatorF3D<T>&

Definition at line 40 of file superIndicatorBaseF3D.hh.

{
  OLB_ASSERT(iCloc < int(this->_blockF.size()) && iCloc >= 0,
             "block functor index within bounds");
  // Note: The type system doesn't guarantee this operation to be valid
  //       as blockF may contain any implementation of the BlockF3D interface.
  return *static_cast<BlockIndicatorF3D<T>*>(this->_blockF[iCloc].get());
}

References OLB_ASSERT.

getSuperGeometry()

template<typename T >

SuperGeometry< T, 3 > & olb::SuperIndicatorF3D< T >::getSuperGeometry

(

)

Get underlying super geometry.

Returns

_superGeometry

Definition at line 50 of file superIndicatorBaseF3D.hh.

{
  return this->_superGeometry;
}

operator()() [1/2]

template<typename T >

bool olb::SuperIndicatorF3D< T >::operator()

(

const int

input[]

)

Indicator specific function operator overload.

The boolean return value of operator()(T output[], S input[]) describes the call's success and by convention must not describe the indicated domain.

Returns

Domain indicator i.e. true iff the input lies within the described domain.

Definition at line 56 of file superIndicatorBaseF3D.hh.

{
  bool output{};
  if (_cachedData) {
    output = _cachedData->getBlock(input[0]).get(input+1);
  }
  else {
    this->operator()(&output, input);
  }
  return output;
}

operator()() [2/2]

template<typename T >

bool olb::SuperIndicatorF3D< T >::operator()	(	int	iC,
		int	iX,
		int	iY,
		int	iZ )

Indicator specific function operator overload.

The boolean return value of operator()(T output[], S input[]) describes the call's success and by convention must not describe the indicated domain.

Returns

Domain indicator i.e. true iff the input lies within the described domain.

Definition at line 69 of file superIndicatorBaseF3D.hh.

{
  bool output{};
  if (_cachedData) {
    output = _cachedData->getBlock(iC).get({iX, iY, iZ});
  }
  else {
    this->operator()(&output, iC, iX, iY, iZ);
  }
  return output;
}

Member Data Documentation

_cachedData

template<typename T >

std::unique_ptr<SuperData<3,T,bool> > olb::SuperIndicatorF3D< T >::_cachedData

protected

Definition at line 52 of file superIndicatorBaseF3D.h.

_superGeometry

template<typename T >

SuperGeometry<T,3>& olb::SuperIndicatorF3D< T >::_superGeometry

protected

Definition at line 51 of file superIndicatorBaseF3D.h.

---

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

• src/functors/lattice/indicator/superIndicatorBaseF3D.h
• src/functors/lattice/integral/superLpNorm3D.h
• src/functors/lattice/superBaseF3D.h
• src/utilities/aliases.h
• src/functors/lattice/indicator/superIndicatorBaseF3D.hh