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

SuperAverage3D returns the average in each component of f on a indicated subset. More...

#include <superAverage3D.h>

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

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

Public Member Functions
	SuperAverage3D (FunctorPtr< SuperF3D< T, W > > &&f, FunctorPtr< SuperIndicatorF3D< T > > &&indicatorF)
	Constructor for determining the average of f on a indicated subset.
	SuperAverage3D (FunctorPtr< SuperF3D< T, W > > &&f, SuperGeometry< T, 3 > &superGeometry, const int material)
	Constructor for determining the average of f on a given material.
bool	operator() (W output[], const int input[]) override
	Global average operator.
Public Member Functions inherited from olb::SuperF3D< T, T >
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)

Additional Inherited Members
Public Types inherited from olb::SuperF3D< T, T >
using	identity_functor_type
Public Types inherited from olb::GenericF< W, int >
using	targetType
using	sourceType
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, T >
static constexpr bool	isSuper
static constexpr unsigned	d
Protected Member Functions inherited from olb::SuperF3D< T, T >
	SuperF3D (SuperStructure< T, 3 > &superStructure, int targetDim)
Protected Member Functions inherited from olb::GenericF< W, int >
	GenericF (int targetDim, int sourceDim)
Protected Attributes inherited from olb::SuperF3D< T, T >
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::SuperAverage3D< T, W >

SuperAverage3D returns the average in each component of f on a indicated subset.

Definition at line 37 of file superAverage3D.h.

Constructor & Destructor Documentation

SuperAverage3D() [1/2]

template<typename T , typename W >

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

Constructor for determining the average of f on a indicated subset.

Parameters

f	functor of which the average is to be determined
indicatorF	indicator describing the subset on which to evaluate f

Definition at line 34 of file superAverage3D.hh.

  : SuperF3D<T,W>(f->getSuperStructure(), f->getTargetDim()+1),
    _f(std::move(f)),
    _indicatorF(std::move(indicatorF))
{
  this->getName() = "Average("+_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 BlockAverage3D<T,W>(_f->getBlockF(iC),
                                _indicatorF->getBlockIndicatorF(iC))
      );
    }
  }
}

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

Here is the call graph for this function:

SuperAverage3D() [2/2]

template<typename T , typename W >

olb::SuperAverage3D< T, W >::SuperAverage3D	(	FunctorPtr< SuperF3D< T, W > > &&	f,
		SuperGeometry< T, 3 > &	superGeometry,
		const int	material )

Constructor for determining the average of f on a given material.

Parameters

f	functor of which the average is to be determined
superGeometry	super geometry for constructing material indicator
material	number of the relevant material

Definition at line 56 of file superAverage3D.hh.

  : SuperAverage3D(
      std::forward<decltype(f)>(f),
      superGeometry.getMaterialIndicator(material))
{ }

Member Function Documentation

operator()()

template<typename T , typename W >

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

overridevirtual

Global average operator.

Note: While this functor exposes BlockAverage3D functors if possible, a call to this function will not use them but calculate the global average by summing all components and voxel counts. Calling BlockAverage3D in this situation would unnecessarily complicate this as we would have to weight the aggregated averages according to their share in the global average.

Implements olb::GenericF< W, int >.

Definition at line 65 of file superAverage3D.hh.

{
  _f->getSuperStructure().communicate();
  auto& geometry = _f->getSuperStructure().getCuboidDecomposition();
  LoadBalancer<T>&     load     = _f->getSuperStructure().getLoadBalancer();
 
  for (int i = 0; i < _f->getTargetDim(); ++i) {
    output[i] = W(0);
  }
 
  W outputTmp[_f->getTargetDim()];
  int inputTmp[_f->getSourceDim()];
  std::size_t voxels(0);
  std::vector<util::KahanSummator<W>> summators(_f->getTargetDim(), util::KahanSummator<W>());
 
  for (int iC = 0; iC < load.size(); ++iC) {
    const Cuboid3D<T>& cuboid = geometry.get(load.glob(iC));
    inputTmp[0] = load.glob(iC);
    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 (_indicatorF(inputTmp)) {
            _f(outputTmp,inputTmp);
            for (int i = 0; i < _f->getTargetDim(); ++i) {
              summators[i].add(outputTmp[i]);
            }
            voxels += 1;
          }
        }
      }
    }
  }
 
  for (int i = 0; i < _f->getTargetDim(); ++i) {
    output[i] = summators[i].getSum();
  }
 
#ifdef PARALLEL_MODE_MPI
  for (int i = 0; i < _f->getTargetDim(); ++i) {
    singleton::mpi().reduceAndBcast(output[i], MPI_SUM);
  }
  singleton::mpi().reduceAndBcast(voxels, MPI_SUM);
#endif
 
  output[_f->getTargetDim()] = voxels;
  for (int i = 0; i < _f->getTargetDim(); ++i) {
    output[i] /= output[_f->getTargetDim()];
  }
 
  return true;
}

References olb::SuperStructure< T, D >::communicate(), olb::Cuboid< T, D >::getNx(), olb::Cuboid< T, D >::getNy(), olb::Cuboid< T, D >::getNz(), olb::SuperF3D< T, U >::getSuperStructure(), olb::LoadBalancer< T >::glob(), olb::singleton::mpi(), olb::singleton::MpiManager::reduceAndBcast(), and olb::LoadBalancer< T >::size().

Here is the call graph for this function:

---

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

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