olb::SuperIndicatorIdentity3D< T > Class Template Reference

Indicator identity functor. More...

#include <superIndicatorF3D.h>

Inheritance diagram for olb::SuperIndicatorIdentity3D< T >:

Collaboration diagram for olb::SuperIndicatorIdentity3D< T >:

Public Member Functions
	SuperIndicatorIdentity3D (FunctorPtr< SuperIndicatorF3D< T > > &&indicatorF)
bool	operator() (bool output[], const int input[]) override
Public Member Functions inherited from olb::SuperIndicatorF3D< T >
	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, bool > &	operator- (SuperF3D< T, bool > &rhs)
SuperF3D< T, bool > &	operator+ (SuperF3D< T, bool > &rhs)
SuperF3D< T, bool > &	operator* (SuperF3D< T, bool > &rhs)
SuperF3D< T, bool > &	operator/ (SuperF3D< T, bool > &rhs)
SuperStructure< T, 3 > &	getSuperStructure ()
int	getBlockFSize () const
BlockF3D< bool > &	getBlockF (int iCloc)
bool	operator() (bool output[], const int input[])
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
FunctorPtr< SuperIndicatorF3D< T > >	_indicatorF
Protected Attributes inherited from olb::SuperIndicatorF3D< T >
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< bool > > >	_blockF
	Super functors may consist of several BlockF3D<W> derived functors.

Additional Inherited Members
Public Types inherited from olb::SuperIndicatorF3D< T >
using	identity_functor_type = SuperIndicatorIdentity3D<T>
Public Types inherited from olb::SuperF3D< T, bool >
using	identity_functor_type
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)
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< T, S >
	GenericF (int targetDim, int sourceDim)

Detailed Description

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

Indicator identity functor.

Proxies a given indicator functor for simplified memory management. i.e. mixing non-owning indicator references and owning indicator pointers in functor compositions.

Definition at line 120 of file superIndicatorF3D.h.

Constructor & Destructor Documentation

SuperIndicatorIdentity3D()

template<typename T >

olb::SuperIndicatorIdentity3D< T >::SuperIndicatorIdentity3D

(

FunctorPtr< SuperIndicatorF3D< T > > &&

indicatorF

)

Definition at line 166 of file superIndicatorF3D.hh.

  : SuperIndicatorF3D<T>(indicatorF->getSuperGeometry()),
    _indicatorF(std::move(indicatorF))
{
  this->getName() = _indicatorF->getName();
 
  for (int iC = 0; iC < _indicatorF->getBlockFSize(); ++iC) {
    this->_blockF.emplace_back(
      new BlockIndicatorIdentity3D<T>(_indicatorF->getBlockIndicatorF(iC)));
  }
}

References olb::SuperF3D< T, bool >::_blockF, olb::SuperIndicatorIdentity3D< T >::_indicatorF, and olb::GenericF< T, S >::getName().

Here is the call graph for this function:

Member Function Documentation

operator()()

template<typename T >

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

override

Definition at line 179 of file superIndicatorF3D.hh.

{
  return _indicatorF(output, input);
}

Member Data Documentation

_indicatorF

template<typename T >

FunctorPtr<SuperIndicatorF3D<T> > olb::SuperIndicatorIdentity3D< T >::_indicatorF

protected

Definition at line 122 of file superIndicatorF3D.h.

---

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

• src/functors/lattice/indicator/superIndicatorBaseF3D.h
• src/functors/lattice/indicator/superIndicatorF3D.h
• src/functors/lattice/indicator/superIndicatorF3D.hh