olb::SuperF3D< T, U > Class Template Reference

represents all functors that operate on a SuperStructure<T,3> in general More...

#include <superBaseF3D.h>

Inheritance diagram for olb::SuperF3D< T, U >:

Collaboration diagram for olb::SuperF3D< T, U >:

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

Public Member Functions
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)

Static Public Attributes
static constexpr bool	isSuper = true
static constexpr unsigned	d = 3

Protected Member Functions
	SuperF3D (SuperStructure< T, 3 > &superStructure, int targetDim)
Protected Member Functions inherited from olb::GenericF< W, int >
	GenericF (int targetDim, int sourceDim)

Protected Attributes
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)

Detailed Description

template<typename T, typename U>
class olb::SuperF3D< T, U >

represents all functors that operate on a SuperStructure<T,3> in general

Definition at line 184 of file aliases.h.

Member Typedef Documentation

identity_functor_type

template<typename T , typename U >

using olb::SuperF3D< T, U >::identity_functor_type = SuperIdentity3D<T,W>

Definition at line 68 of file superBaseF3D.h.

Constructor & Destructor Documentation

SuperF3D()

template<typename T , typename W >

olb::SuperF3D< T, W >::SuperF3D ( SuperStructure< T, 3 > & superStructure, int targetDim )

protected

Definition at line 34 of file superBaseF3D.hh.

  : GenericF<W,int>(targetDim,4), _superStructure(superStructure) { }

Member Function Documentation

getBlockF()

template<typename T , typename W >

BlockF3D< W > & olb::SuperF3D< T, W >::getBlockF

(

int

iCloc

)

Returns

SuperF3D<T,W>::_blockF[iCloc]

Definition at line 52 of file superBaseF3D.hh.

{
  OLB_ASSERT(iCloc < int(_blockF.size()) && iCloc >= 0,
             "block functor index outside bounds");
  return *(_blockF[iCloc]);
}

References OLB_ASSERT.

Here is the caller graph for this function:

getBlockFSize()

template<typename T , typename W >

int olb::SuperF3D< T, W >::getBlockFSize

(

)

const

Returns

Size of SuperF3D<T,W>::_blockF vector

Definition at line 44 of file superBaseF3D.hh.

{
  OLB_ASSERT(_blockF.size() < INT32_MAX,
             "cast from std::size_t to int unsafe");
  return _blockF.size();
}

References OLB_ASSERT.

getSuperStructure()

template<typename T , typename W >

SuperStructure< T, 3 > & olb::SuperF3D< T, W >::getSuperStructure

(

)

Returns

SuperF3D<T,W>::_superStructure

Definition at line 38 of file superBaseF3D.hh.

{
  return _superStructure;
}

Here is the caller graph for this function:

operator()()

template<typename T , typename W >

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

virtual

has to be implemented for 'every' derived class

Implements olb::GenericF< W, int >.

Reimplemented in olb::SuperIdentity3D< T, W >, olb::SuperIdentity3D< T, T >, olb::SuperIdentity3D< T, W >, olb::SuperIdentityOnSuperIndicatorF3D< T, W >, olb::SuperIntegral3D< T, W >, olb::SuperLocalAverage3D< T, W >, olb::SuperLpNorm3D< T, W, P >, olb::SuperMax3D< T, W >, olb::SuperMin3D< T, W >, olb::SuperStdDeviationF3D< T, W >, olb::SuperSum3D< T, W >, olb::SuperSum3D< T, T >, olb::SuperTypecastF3D< T, W, W2 >, olb::SuperVarianceF3D< T, W >, and olb::SuperVarianceF3D< T, T >.

Definition at line 60 of file superBaseF3D.hh.

{
 
  LoadBalancer<T>& load = _superStructure.getLoadBalancer();
 
  if (load.isLocal(input[0])) {
    const int loc = load.loc(input[0]);
 
    return this->getBlockF(loc)(output, &input[1]);
  }
  else {
    return false;
  }
 
}

References olb::LoadBalancer< T >::isLocal(), and olb::LoadBalancer< T >::loc().

Here is the call graph for this function:

operator*()

template<typename T , typename W >

SuperF3D< T, W > & olb::SuperF3D< T, W >::operator*

(

SuperF3D< T, W > &

rhs

)

Definition at line 239 of file superCalcF3D.hh.

{
  auto tmp = std::make_shared< SuperCalcMultiplication3D<T,W> >(*this,rhs);
  this->_ptrCalcC = tmp;
  return *tmp;
}

operator+()

template<typename T , typename W >

SuperF3D< T, W > & olb::SuperF3D< T, W >::operator+

(

SuperF3D< T, W > &

rhs

)

Definition at line 223 of file superCalcF3D.hh.

{
  auto tmp = std::make_shared< SuperCalcPlus3D<T,W> >(*this,rhs);
  this->_ptrCalcC = tmp;
  return *tmp;
}

operator-()

template<typename T , typename W >

SuperF3D< T, W > & olb::SuperF3D< T, W >::operator-

(

SuperF3D< T, W > &

rhs

)

Definition at line 231 of file superCalcF3D.hh.

{
  auto tmp = std::make_shared< SuperCalcMinus3D<T,W> >(*this,rhs);
  this->_ptrCalcC = tmp;
  return *tmp;
}

operator/()

template<typename T , typename W >

SuperF3D< T, W > & olb::SuperF3D< T, W >::operator/

(

SuperF3D< T, W > &

rhs

)

Definition at line 247 of file superCalcF3D.hh.

{
  auto tmp = std::make_shared< SuperCalcDivision3D<T,W> >(*this,rhs);
  this->_ptrCalcC = tmp;
  return *tmp;
}

Member Data Documentation

_blockF

template<typename T , typename U >

std::vector<std::unique_ptr<BlockF3D<W> > > olb::SuperF3D< T, U >::_blockF

protected

Super functors may consist of several BlockF3D<W> derived functors.

By convention: If block level functors are used at all they should number exactly LoadBalancer<T>::size per process.

Definition at line 66 of file superBaseF3D.h.

_superStructure

template<typename T , typename U >

SuperStructure<T,3>& olb::SuperF3D< T, U >::_superStructure

protected

Definition at line 60 of file superBaseF3D.h.

d

template<typename T , typename U >

unsigned olb::SuperF3D< T, U >::d = 3

staticconstexpr

Definition at line 70 of file superBaseF3D.h.

isSuper

template<typename T , typename U >

bool olb::SuperF3D< T, U >::isSuper = true

staticconstexpr

Definition at line 69 of file superBaseF3D.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/superBaseF3D.hh
• src/functors/lattice/superCalcF3D.hh