olb::SuperLocalAverage3D< T, W > Class Template Reference

Averages given functor inside the local sphere. More...

#include <superLocalAverage3D.h>

Inheritance diagram for olb::SuperLocalAverage3D< T, W >:

Collaboration diagram for olb::SuperLocalAverage3D< T, W >:

Public Member Functions
	SuperLocalAverage3D (FunctorPtr< SuperF3D< T > > &&f, FunctorPtr< SuperIndicatorF3D< T > > &&indicatorF, T radius)
	Primary constructor.
bool	operator() (W output[], const int input[]) override
	Returns average of functor _f evaluated on all cells both inside a sphere of _radius around input and indicated by _indicatorF.
Public Member Functions inherited from olb::SuperF3D< T, W >
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[])
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)

Additional Inherited Members
Public Types inherited from olb::SuperF3D< T, W >
using	identity_functor_type = SuperIdentity3D<T,W>
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, W >
static constexpr bool	isSuper = true
static constexpr unsigned	d = 3
Protected Member Functions inherited from olb::SuperF3D< T, W >
	SuperF3D (SuperStructure< T, 3 > &superStructure, int targetDim)
Protected Member Functions inherited from olb::GenericF< T, S >
	GenericF (int targetDim, int sourceDim)
Protected Attributes inherited from olb::SuperF3D< T, W >
SuperStructure< T, 3 > &	_superStructure
std::vector< std::unique_ptr< BlockF3D< W > > >	_blockF
	Super functors may consist of several BlockF3D<W> derived functors.

Detailed Description

template<typename T, typename W = T>
class olb::SuperLocalAverage3D< T, W >

Averages given functor inside the local sphere.

Definition at line 36 of file superLocalAverage3D.h.

Constructor & Destructor Documentation

SuperLocalAverage3D()

template<typename T , typename W >

olb::SuperLocalAverage3D< T, W >::SuperLocalAverage3D	(	FunctorPtr< SuperF3D< T > > &&	f,
		FunctorPtr< SuperIndicatorF3D< T > > &&	indicatorF,
		T	radius )

Primary constructor.

Parameters

f	Functor to be locally averaged
indicatorF	Indicator describing relevant cells
radius	Radius of the locality sphere

Definition at line 35 of file superLocalAverage3D.hh.

  : SuperF3D<T,W>(f->getSuperStructure(), f->getTargetDim()),
    _f(std::move(f)),
    _indicatorF(std::move(indicatorF)),
    _radius(radius)
{
  this->getName() = "LocalAverage(" + _f->getName() + ")";
 
  LoadBalancer<T>& load = _f->getSuperStructure().getLoadBalancer();
 
  if ( _f->getBlockFSize()          == load.size() &&
       _indicatorF->getBlockFSize() == load.size() ) {
    for (int iC = 0; iC < load.size(); ++iC) {
      this->_blockF.emplace_back(
        new BlockLocalAverage3D<T,W>(_f->getBlockF(iC),
                                     _indicatorF->getBlockIndicatorF(iC),
                                     _radius)
      );
    }
  }
}

References olb::SuperF3D< T, W >::_blockF, olb::GenericF< T, S >::getName(), and olb::LoadBalancer< T >::size().

Here is the call graph for this function:

Member Function Documentation

operator()()

template<typename T , typename W >

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

override

Returns average of functor _f evaluated on all cells both inside a sphere of _radius around input and indicated by _indicatorF.

Definition at line 61 of file superLocalAverage3D.hh.

{
  const auto& geometry = this->getSuperStructure().getCuboidGeometry();
  const auto& load     = this->getSuperStructure().getLoadBalancer();
 
  for (int i = 0; i < this->getTargetDim(); ++i) {
    output[i] = 0.;
  }
 
  if (!_indicatorF(input)) {
    return true;
  }
 
  T centerOfSphere[3];
  geometry.getPhysR(centerOfSphere, input);
  IndicatorSphere3D<T> analyticalSphere(centerOfSphere, _radius);
  SuperIndicatorFfromIndicatorF3D<T> latticeSphere(
    analyticalSphere,
    _indicatorF->getSuperGeometry());
 
  std::size_t voxels(0);
  int inputTmp[4];
 
  for (int iC = 0; iC < load.size(); ++iC) {
    inputTmp[0] = load.glob(iC);
    const auto& cuboid = geometry.get(inputTmp[0]);
 
    for (inputTmp[1] = 0; inputTmp[1] < cuboid.getNx(); ++inputTmp[1]) {
      for (inputTmp[2] = 0; inputTmp[2] < cuboid.getNy(); ++inputTmp[2]) {
        for (inputTmp[3] = 0; inputTmp[3] < cuboid.getNz(); ++inputTmp[3]) {
          if (latticeSphere(inputTmp) && _indicatorF(inputTmp)) {
            T outputTmp[_f->getTargetDim()];
            _f(outputTmp, inputTmp);
            for (int i = 0; i < this->getTargetDim(); ++i) {
              output[i] += outputTmp[i];
            }
            voxels += 1;
          }
        }
      }
    }
  }
 
#ifdef PARALLEL_MODE_MPI
  singleton::mpi().reduceAndBcast(voxels, MPI_SUM);
#endif
 
  if (voxels > 0) {
    for (int i = 0; i < this->getTargetDim(); ++i) {
#ifdef PARALLEL_MODE_MPI
      singleton::mpi().reduceAndBcast(output[i], MPI_SUM);
#endif
      output[i] /= voxels;
    }
  }
 
  return true;
}

References olb::singleton::mpi(), and olb::singleton::MpiManager::reduceAndBcast().

Here is the call graph for this function:

---

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

• src/functors/lattice/superLocalAverage3D.h
• src/functors/lattice/superLocalAverage3D.hh