olb::BlockReduction2D2D< T > Class Template Reference

BlockReduction2D2D interpolates the data of a SuperF2D functor in a given resolution. More...

#include <blockReduction2D2D.h>

Inheritance diagram for olb::BlockReduction2D2D< T >:

Collaboration diagram for olb::BlockReduction2D2D< T >:

Public Member Functions
	BlockReduction2D2D (FunctorPtr< SuperF2D< T > > &&f, int resolution=600, BlockDataSyncMode mode=BlockDataSyncMode::ReduceAndBcast)
Vector< T, 2 >	getPhysR (const int &iX, const int &iY) const
	Transform lattice coordinates to their physical location.
HyperplaneLattice3D< T >	getPlaneDiscretizationIn3D () const
	Returns embedding of the discretized plane in 3D space.
void	initialize ()
	Initialize rank-local list of points to be stored in _blockData.
void	update ()
	Updates and writes the data to _blockData using _rankLocalSubplane.
BlockStructureD< 2 > &	getBlockStructure () override
	Overload of virtual function from class BlockF2D.
Public Member Functions inherited from olb::BlockDataF2D< T, T >
	BlockDataF2D (BlockData< 2, T, T > &blockData)
	Constructor.
	BlockDataF2D (BlockF2D< T > &f)
	to store functor data, constuctor creates _blockData with functor data
	~BlockDataF2D ()
BlockData< 2, T, T > &	getBlockData ()
	returns _blockData
bool	operator() (T output[], const int input[]) override
	access to _blockData via its get()
Public Member Functions inherited from olb::BlockF2D< T >
void	setBlockStructure (BlockStructureD< 2 > *blockStructure)
BlockF2D< T > &	operator- (BlockF2D< T > &rhs)
BlockF2D< T > &	operator+ (BlockF2D< T > &rhs)
BlockF2D< T > &	operator* (BlockF2D< T > &rhs)
BlockF2D< T > &	operator/ (BlockF2D< 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::BlockDataF2D< T, T >
	BlockDataF2D (int nx, int ny, int size=1)
Protected Member Functions inherited from olb::BlockF2D< T >
	BlockF2D (BlockStructureD< 2 > &blockStructure, int targetDim)
	BlockF2D (int targetDim)
Protected Member Functions inherited from olb::GenericF< T, int >
	GenericF (int targetDim, int sourceDim)
Protected Attributes inherited from olb::BlockDataF2D< T, T >
BlockData< 2, T, T > *	_blockData
bool	_owning
Protected Attributes inherited from olb::BlockF2D< T >
BlockStructureD< 2 > *	_blockStructure

Detailed Description

template<typename T>
class olb::BlockReduction2D2D< T >

BlockReduction2D2D interpolates the data of a SuperF2D functor in a given resolution.

This is primarily used for exporting GIF images via BlockGifWriter.

Definition at line 47 of file blockReduction2D2D.h.

Constructor & Destructor Documentation

BlockReduction2D2D()

template<typename T >

olb::BlockReduction2D2D< T >::BlockReduction2D2D	(	FunctorPtr< SuperF2D< T > > &&	f,
		int	resolution = 600,
		BlockDataSyncMode	mode = BlockDataSyncMode::ReduceAndBcast )

Definition at line 68 of file blockReduction2D2D.hh.

  : BlockDataF2D<T,T>(f->getSuperStructure().getCuboidGeometry().getMotherCuboid().getNx(),
                      f->getSuperStructure().getCuboidGeometry().getMotherCuboid().getNy(),
                      f->getTargetDim()),
    _f(std::move(f)),
    _origin(_f->getSuperStructure().getCuboidGeometry().getMotherCuboid().getOrigin()),
    _h(_f->getSuperStructure().getCuboidGeometry().getMinDeltaR()),
    _nx(_f->getSuperStructure().getCuboidGeometry().getMotherCuboid().getNx()),
    _ny(_f->getSuperStructure().getCuboidGeometry().getMotherCuboid().getNy()),
    _syncMode(mode)
{
  this->getName() = "planeReduction(" + _f->getName() + ")";
 
  _origin[0] -= 10*std::numeric_limits<T>::epsilon();
  _origin[1] -= 10*std::numeric_limits<T>::epsilon();
 
  // changes _h, _nx, _ny to match resolution
  updateToWantedResolution(resolution);
  // intialize list of relevant rank local points
  initialize();
  // first update of data
  update();
}

References olb::GenericF< T, int >::getName(), olb::BlockReduction2D2D< T >::initialize(), and olb::BlockReduction2D2D< T >::update().

Here is the call graph for this function:

Member Function Documentation

getBlockStructure()

template<typename T >

BlockStructureD< 2 > & olb::BlockReduction2D2D< T >::getBlockStructure ( )

overridevirtual

Overload of virtual function from class BlockF2D.

Reimplemented from olb::BlockF2D< T >.

Definition at line 193 of file blockReduction2D2D.hh.

{
  return *this->_blockData;
}

getPhysR()

template<typename T >

Vector< T, 2 > olb::BlockReduction2D2D< T >::getPhysR	(	const int &	iX,
		const int &	iY ) const

Transform lattice coordinates to their physical location.

Definition at line 94 of file blockReduction2D2D.hh.

{
  return Vector<T,2> {
    _origin[0] + T(iX) * _h,
    _origin[1] + T(iY) * _h
  };
}

getPlaneDiscretizationIn3D()

template<typename T >

HyperplaneLattice3D< T > olb::BlockReduction2D2D< T >::getPlaneDiscretizationIn3D

(

)

const

Returns embedding of the discretized plane in 3D space.

i.e. span vectors are X, Y unit vectors. Origin, spacing and resolution is exposed.

Required for dimension agnostic implementation of GnuplotHeatMap<T>

Definition at line 103 of file blockReduction2D2D.hh.

{
  return HyperplaneLattice3D<T>(
           Hyperplane3D<T>()
           .originAt({_origin[0], _origin[1], 0})
           .spannedBy({1,0,0}, {0,1,0}),
           _h, _nx, _ny);
}

Here is the caller graph for this function:

initialize()

template<typename T >

void olb::BlockReduction2D2D< T >::initialize

(

)

Initialize rank-local list of points to be stored in _blockData.

Definition at line 113 of file blockReduction2D2D.hh.

{
  const CuboidGeometry2D<T>& geometry = _f->getSuperStructure().getCuboidGeometry();
  LoadBalancer<T>&           load     = _f->getSuperStructure().getLoadBalancer();
 
  _rankLocalSubplane.clear();
 
  for ( int iX = 0; iX < _nx; ++iX ) {
    for ( int iY = 0; iY < _ny; ++iY ) {
      const Vector<T,2> physR = getPhysR(iX, iY);
 
      // Schedule plane point for storage if its physical position intersects the
      // mother cuboid and the cuboid of the nearest lattice position is local to
      // the current rank:
      int iC;
      if ( geometry.getC(physR, iC) ) {
        if ( load.isLocal(iC) ) {
          _rankLocalSubplane.emplace_back(iX, iY, iC);
        }
      }
    }
  }
}

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

Here is the call graph for this function:

Here is the caller graph for this function:

update()

template<typename T >

void olb::BlockReduction2D2D< T >::update

(

)

Updates and writes the data to _blockData using _rankLocalSubplane.

Definition at line 138 of file blockReduction2D2D.hh.

{
  _f->getSuperStructure().communicate();
 
  AnalyticalFfromSuperF2D<T> analyticalF(*_f);
 
#ifdef PARALLEL_MODE_MPI
  std::unique_ptr<BlockData<2,T,T>> localBlockData(
    new BlockData<2,T,T>({{_nx, _ny}, 0}, this->getTargetDim()));
#endif
 
  for ( std::tuple<int,int,int>& pos : _rankLocalSubplane ) {
    const int& iX = std::get<0>(pos);
    const int& iY = std::get<1>(pos);
    const Vector<T,2> physR = getPhysR(iX, iY);
 
    for ( int iSize = 0; iSize < _f->getTargetDim(); ++iSize ) {
      this->_blockData->get({iX, iY}, iSize) = T();
    }
 
    T output[_f->getTargetDim()];
    const T input[2] { physR[0], physR[1] };
 
    if (analyticalF(output, input)) {
      for ( int iSize = 0; iSize < _f->getTargetDim(); ++iSize ) {
#ifdef PARALLEL_MODE_MPI
        localBlockData->get({iX, iY}, iSize) += output[iSize];
#else
        this->_blockData->get({iX, iY}, iSize) += output[iSize];
#endif
      }
    }
  }
 
#ifdef PARALLEL_MODE_MPI
  switch ( _syncMode ) {
  case BlockDataSyncMode::ReduceAndBcast:
    singleton::mpi().reduce(*localBlockData, this->getBlockData(), MPI_SUM);
    singleton::mpi().bCast(this->getBlockData());
    break;
  case BlockDataSyncMode::ReduceOnly:
    singleton::mpi().reduce(*localBlockData, this->getBlockData(), MPI_SUM);
    break;
  case BlockDataSyncMode::None:
    if (this->_owning) {
      delete this->_blockData;
    }
    this->_blockData = localBlockData.release();
    this->_owning = true;
    break;
  }
#endif
}

References olb::singleton::MpiManager::bCast(), olb::singleton::mpi(), olb::None, olb::singleton::MpiManager::reduce(), olb::ReduceAndBcast, and olb::ReduceOnly.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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