olb::SuperLpNorm3D< T, W, P > Class Template Reference

Functor that returns the Lp norm over omega of the the euklid norm of the input functor. More...

#include <superLpNorm3D.h>

Inheritance diagram for olb::SuperLpNorm3D< T, W, P >:

Collaboration diagram for olb::SuperLpNorm3D< T, W, P >:

Public Member Functions
	SuperLpNorm3D (FunctorPtr< SuperF3D< T, W > > &&f, FunctorPtr< SuperIndicatorF3D< T > > &&indicatorF)
	SuperLpNorm3D (FunctorPtr< SuperF3D< T, W > > &&f, SuperGeometry< T, 3 > &, FunctorPtr< SuperIndicatorF3D< T > > &&indicatorF)
	Legacy constructor accepting super geometry reference.
	SuperLpNorm3D (FunctorPtr< SuperF3D< T, W > > &&f, SuperGeometry< T, 3 > &geometry, std::vector< int > materials)
	SuperLpNorm3D (FunctorPtr< SuperF3D< T, W > > &&f, SuperGeometry< T, 3 > &geometry, int material)
bool	operator() (W output[], const int input[]) override
	has to be implemented for 'every' derived class
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)
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, W >
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, W >
static constexpr bool	isSuper
static constexpr unsigned	d
Protected Member Functions inherited from olb::SuperF3D< T, W >
	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, 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, int P>
class olb::SuperLpNorm3D< T, W, P >

Functor that returns the Lp norm over omega of the the euklid norm of the input functor.

Maintains block level BlockLpNorm3D functors as required.

P == 0: inf norm P >= 1: p norm

Definition at line 46 of file superLpNorm3D.h.

Constructor & Destructor Documentation

SuperLpNorm3D() [1/4]

template<typename T , typename W , int P>

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

Parameters

f	(non-)owning pointer or reference to SuperF3D<T,W>
indicatorF	(non-)owning pointer or reference to SuperIndicatorF3D<T>. Describes the subset to be integrated.

Definition at line 38 of file superLpNorm3D.hh.

  : SuperF3D<T,W>(f->getSuperStructure(),1),
    _f(std::move(f)),
    _indicatorF(std::move(indicatorF))
{
  OLB_ASSERT(_f->getSourceDim() == _indicatorF->getSourceDim(),
             "functor source dimension equals indicator source dimension");
 
  this->getName() = "L" + std::to_string(P) + "Norm(" + _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 BlockLpNorm3D<T,W,P>(_f->getBlockF(iC),
                                 _indicatorF->getBlockIndicatorF(iC))
      );
    }
  }
}

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

Here is the call graph for this function:

SuperLpNorm3D() [2/4]

template<typename T , typename W , int P>

olb::SuperLpNorm3D< T, W, P >::SuperLpNorm3D	(	FunctorPtr< SuperF3D< T, W > > &&	f,
		SuperGeometry< T, 3 > &	geometry,
		FunctorPtr< SuperIndicatorF3D< T > > &&	indicatorF )

Legacy constructor accepting super geometry reference.

Parameters

f	(non-)owning pointer or reference to SuperF3D<T,W>
indicatorF	(non-)owning pointer or reference to SuperIndicatorF3D<T>. Describes the subset to be integrated.

Definition at line 63 of file superLpNorm3D.hh.

  : SuperLpNorm3D(std::forward<decltype(f)>(f),
                  std::forward<decltype(indicatorF)>(indicatorF))
{ }

SuperLpNorm3D() [3/4]

template<typename T , typename W , int P>

olb::SuperLpNorm3D< T, W, P >::SuperLpNorm3D	(	FunctorPtr< SuperF3D< T, W > > &&	f,
		SuperGeometry< T, 3 > &	geometry,
		std::vector< int >	materials )

Parameters

f	(non-)owning pointer or reference to SuperF3D<T,W>
geometry	super geometry required to construct SuperIndicatorMaterial3D using materials
materials	vector of material numbers to be included in the Lp norm

Definition at line 71 of file superLpNorm3D.hh.

  : SuperLpNorm3D(std::forward<decltype(f)>(f),
                  geometry.getMaterialIndicator(std::move(materials)))
{ }

SuperLpNorm3D() [4/4]

template<typename T , typename W , int P>

olb::SuperLpNorm3D< T, W, P >::SuperLpNorm3D	(	FunctorPtr< SuperF3D< T, W > > &&	f,
		SuperGeometry< T, 3 > &	geometry,
		int	material )

Parameters

f	(non-)owning pointer or reference to SuperF3D<T,W>
geometry	super geometry required to construct SuperIndicatorMaterial3D using material
material	single material number to be included in the Lp norm

Definition at line 79 of file superLpNorm3D.hh.

  : SuperLpNorm3D(std::forward<decltype(f)>(f),
                  geometry.getMaterialIndicator(material))
{ }

Member Function Documentation

operator()()

template<typename T , typename W , int P>

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

overridevirtual

has to be implemented for 'every' derived class

Reimplemented from olb::SuperF3D< T, W >.

Definition at line 87 of file superLpNorm3D.hh.

{
  _f->getSuperStructure().communicate();
  CuboidGeometry3D<T>& cGeometry = _f->getSuperStructure().getCuboidGeometry();
  LoadBalancer<T>&     load      = _f->getSuperStructure().getLoadBalancer();
 
  output[0] = W(0);
  W outputTmp[_f->getTargetDim()];
  int inputTmp[_f->getSourceDim()];
 
  for (int iC = 0; iC < load.size(); ++iC) {
    Cuboid3D<T>& cuboid = cGeometry.get(load.glob(iC));
 
    const int nX = cuboid.getNx();
    const int nY = cuboid.getNy();
    const int nZ = cuboid.getNz();
    const T weight = util::pow(cuboid.getDeltaR(), 3);
 
    inputTmp[0] = load.glob(iC);
 
    for (inputTmp[1] = 0; inputTmp[1] < nX; ++inputTmp[1]) {
      for (inputTmp[2] = 0; inputTmp[2] < nY; ++inputTmp[2]) {
        for (inputTmp[3] = 0; inputTmp[3] < nZ; ++inputTmp[3]) {
          if (_indicatorF(inputTmp)) {
            _f(outputTmp, inputTmp);
            for (int iDim = 0; iDim < _f->getTargetDim(); ++iDim) {
              output[0] = LpNormImpl<T,W,P>()(output[0], outputTmp[iDim], weight);
            }
          }
        }
      }
    }
  }
 
#ifdef PARALLEL_MODE_MPI
  if (P == 0) {
    singleton::mpi().reduceAndBcast(output[0], MPI_MAX);
  }
  else {
    singleton::mpi().reduceAndBcast(output[0], MPI_SUM);
  }
#endif
 
  output[0] = LpNormImpl<T,W,P>().enclose(output[0]);
 
  return true;
}

References olb::SuperStructure< T, D >::communicate(), olb::LpNormImpl< T, W, P >::enclose(), olb::CuboidGeometry3D< T >::get(), olb::Cuboid3D< T >::getDeltaR(), olb::Cuboid3D< T >::getNx(), olb::Cuboid3D< T >::getNy(), olb::Cuboid3D< T >::getNz(), olb::SuperF3D< T, W >::getSuperStructure(), olb::LoadBalancer< T >::glob(), olb::singleton::mpi(), olb::util::pow(), 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/integral/superLpNorm3D.h
• src/functors/lattice/integral/superLpNorm3D.hh