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

BlockVarianceF3D returns the Variance in each component of f on a indicated subset calcutalted with Steiner translation theorem. More...

#include <blockStatisticF3D.h>

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

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

Public Member Functions
	BlockVarianceF3D (BlockF3D< W > &f, BlockIndicatorF3D< T > &indicatorF, Cuboid3D< T > &cuboid, T expectedValue)
bool	operator() (W output[], const int input[]) override
Public Member Functions inherited from olb::BlockSum3D< T, W >
	BlockSum3D (BlockF3D< W > &f, BlockIndicatorF3D< T > &indicatorF)
bool	operator() (W output[], const int input[]) override
Public Member Functions inherited from olb::BlockF3D< T >
	~BlockF3D () override
	virtual destructor for defined behaviour
virtual BlockStructureD< 3 > &	getBlockStructure () const
BlockF3D< T > &	operator- (BlockF3D< T > &rhs)
BlockF3D< T > &	operator+ (BlockF3D< T > &rhs)
BlockF3D< T > &	operator* (BlockF3D< T > &rhs)
BlockF3D< T > &	operator/ (BlockF3D< T > &rhs)
Public Member Functions inherited from olb::GenericF< T, 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
virtual bool	operator() (T output[], const int 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[], int input0)
bool	operator() (T output[], int input0, int input1)
bool	operator() (T output[], int input0, int input1, int input2)
bool	operator() (T output[], int input0, int input1, int input2, int input3)

Additional Inherited Members
Public Types inherited from olb::GenericF< T, int >
using	targetType
using	sourceType
Public Attributes inherited from olb::GenericF< T, int >
std::shared_ptr< GenericF< T, int > >	_ptrCalcC
	memory management, frees resouces (calcClass)
Protected Member Functions inherited from olb::BlockF3D< T >
	BlockF3D (BlockStructureD< 3 > &blockStructure, int targetDim)
Protected Member Functions inherited from olb::GenericF< T, int >
	GenericF (int targetDim, int sourceDim)
Protected Attributes inherited from olb::BlockF3D< T >
BlockStructureD< 3 > &	_blockStructure

Detailed Description

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

BlockVarianceF3D returns the Variance in each component of f on a indicated subset calcutalted with Steiner translation theorem.

Definition at line 38 of file blockStatisticF3D.h.

Constructor & Destructor Documentation

BlockVarianceF3D()

template<typename T , typename W >

olb::BlockVarianceF3D< T, W >::BlockVarianceF3D	(	BlockF3D< W > &	f,
		BlockIndicatorF3D< T > &	indicatorF,
		Cuboid3D< T > &	cuboid,
		T	expectedValue )

Definition at line 33 of file blockStatisticF3D.hh.

  : BlockSum3D<T,W>(f, indicatorF),
    _f(f),
    _indicatorF(indicatorF),
    _cuboid(cuboid),
    _expectedValue(expectedValue)
{
  this->getName() = "BlockVariance("+_f.getName()+")";
}

References olb::GenericF< T, S >::getName(), and olb::GenericF< T, int >::getName().

Here is the call graph for this function:

Member Function Documentation

operator()()

template<typename T , typename W >

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

override

Definition at line 47 of file blockStatisticF3D.hh.

{
  OLB_ASSERT(_f.getSourceDim() == _indicatorF.getSourceDim(),
             "functor source dimension equals indicator source dimension");
 
  std::size_t voxels(0);
 
  W outputTmp[_f.getTargetDim()];
  for(unsigned i=0; i<_f.getTargetDim(); ++i) {
    outputTmp[i] = W(0);
  }
  int inputTmp[_f.getSourceDim()];
 
  for (inputTmp[0] = 0; inputTmp[0] < _cuboid.getNx(); ++inputTmp[0]) {
    for (inputTmp[1] = 0; inputTmp[1] < _cuboid.getNy(); ++inputTmp[1]) {
      for (inputTmp[2] = 0; inputTmp[2] < _cuboid.getNz(); ++inputTmp[2]) {
        if (_indicatorF(inputTmp)) {
          _f(outputTmp,inputTmp);
          for (int i = 0; i < _f.getTargetDim(); ++i) {
            output[i] += util::pow(outputTmp[i] - _expectedValue, 2);
          }
          voxels += 1;
        }
      }
    }
  }
 
 
  output[_f.getTargetDim()] += voxels;
 
  return true;
}

References OLB_ASSERT, and olb::util::pow().

Here is the call graph for this function:

---

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

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