olb::SuperData< D, T, U > Class Template Reference

#include <superData.h>

Inheritance diagram for olb::SuperData< D, T, U >:

Collaboration diagram for olb::SuperData< D, T, U >:

Public Types
using	block_t = ConcretizableBlockData<D,T,U>
Public Types inherited from olb::SuperStructure< T, D >
using	value_t = T

Public Member Functions
	SuperData (CuboidGeometry< T, D > &cuboidGeometry, LoadBalancer< T > &loadBalancer, int overlap=2, int size=1)
virtual	~SuperData ()=default
	SuperData (SuperF< D, T, U > &rhs)
const BlockData< D, T, U > &	getBlock (int iC) const
BlockData< D, T, U > &	getBlock (int iC)
template<typename BLOCK = BlockData<D,T,U>>
BLOCK &	getBlock (int iC)
template<typename BLOCK = BlockData<D,T,U>>
const BLOCK &	getBlock (int iC) const
void	communicate () override
	Communicate overlaps.
int	getDataSize () const
	Read only access to the dim of the data of the super structure.
int	getDataTypeSize () const
	Read only access to the data type dim of the data of the super structure.
Public Member Functions inherited from olb::SuperStructure< T, D >
virtual	~SuperStructure ()
	Virtual Destructor for inheritance.
	SuperStructure (CuboidGeometry< T, D > &cuboidGeometry, LoadBalancer< T > &loadBalancer, int overlap=2)
	Construction of a super structure.
	SuperStructure (int overlap=1)
	Default Constructor for empty SuperStructure.
CuboidGeometry< T, D > &	getCuboidGeometry ()
	Read and write access to cuboid geometry.
CuboidGeometry< T, D > const &	getCuboidGeometry () const
	Read only access to cuboid geometry.
int	getOverlap ()
	Read and write access to the overlap.
int	getOverlap () const
	Read only access to the overlap.
LoadBalancer< T > &	getLoadBalancer ()
	Read and write access to the load balancer.
LoadBalancer< T > const &	getLoadBalancer () const
	Read only access to the load balancer.
template<typename F >
void	forCorePhysLocations (F f) const
	Iterate over discrete physical locations.
template<typename F >
void	forCorePhysLocations (PhysR< T, D > min, PhysR< T, D > max, F f) const
	Iterate over discrete physical locations between min and max.
template<typename F >
void	forCoreSpatialLocations (F f) const
	Iterate over spatial locations NOTE: Based on physical locations (as opposed to its blockStructure version)
template<typename F >
void	forCoreSpatialLocations (PhysR< T, D > min, PhysR< T, D > max, F f) const
	Iterate over spatial locations between min and max NOTE: Based on physical locations (as opposed to its blockStructure version)

Static Public Attributes
static constexpr unsigned	d = D

Protected Attributes
const std::size_t	_size
	Dimension of the data field.
std::vector< std::unique_ptr< BlockData< D, T, U > > >	_block
	Vector of BlockData.
std::unique_ptr< SuperCommunicator< T, SuperData > >	_communicator
	Inter-block communicator.
Protected Attributes inherited from olb::SuperStructure< T, D >
CuboidGeometry< T, D > &	_cuboidGeometry
	The grid structure is stored here.
LoadBalancer< T > &	_loadBalancer
	Distribution of the cuboids of the cuboid structure.
int	_overlap
	Size of ghost cell layer (must be greater than 1 and greater_overlapBC, default =1)
OstreamManager	clout
	class specific output stream

Detailed Description

template<unsigned D, typename T, typename U>
class olb::SuperData< D, T, U >

Definition at line 45 of file superData.h.

Member Typedef Documentation

block_t

template<unsigned D, typename T , typename U >

using olb::SuperData< D, T, U >::block_t = ConcretizableBlockData<D,T,U>

Definition at line 57 of file superData.h.

Constructor & Destructor Documentation

SuperData() [1/2]

template<unsigned D, typename T , typename U >

olb::SuperData< D, T, U >::SuperData	(	CuboidGeometry< T, D > &	cuboidGeometry,
		LoadBalancer< T > &	loadBalancer,
		int	overlap = 2,
		int	size = 1 )

Definition at line 40 of file superData.hh.

  : SuperStructure<T,D>(cuboidGeometry, loadBalancer, overlap),
    _size(size)
{
  auto& load = this->getLoadBalancer();
  for (int iC=0; iC < load.size(); ++iC) {
    _block.emplace_back(
      new BlockData<D,T,U>(cuboidGeometry.get(load.glob(iC)), overlap, size));
  }
 
  if (overlap >= 1) {
    _communicator = std::make_unique<SuperCommunicator<T,SuperData>>(*this);
    _communicator->template requestField<typename BlockData<D,T,U>::DUMMY_FIELD>();
    _communicator->requestOverlap(overlap);
    _communicator->exchangeRequests();
  }
}

References olb::SuperData< D, T, U >::_block, olb::SuperData< D, T, U >::_communicator, and olb::SuperStructure< T, D >::getLoadBalancer().

Here is the call graph for this function:

~SuperData()

template<unsigned D, typename T , typename U >

virtual olb::SuperData< D, T, U >::~SuperData ( )

virtualdefault

SuperData() [2/2]

template<unsigned D, typename T , typename U >

olb::SuperData< D, T, U >::SuperData

(

SuperF< D, T, U > &

rhs

)

Definition at line 61 of file superData.hh.

  : SuperData(rhs.getSuperStructure().getCuboidGeometry(),
              rhs.getSuperStructure().getLoadBalancer(),
              rhs.getSuperStructure().getOverlap(),
              rhs.getTargetDim())
{
  auto& load = this->getLoadBalancer();
 
  int input[D+1];
  U output[rhs.getTargetDim()];
 
  for (int iC=0; iC < load.size(); ++iC) {
    auto& block = getBlock(iC);
    input[0] = load.glob(iC);
    block.forCoreSpatialLocations([&](LatticeR<D> latticeR) {
      for (unsigned iD=0; iD < D; ++iD) {
        input[1+iD] = latticeR[iD];
      }
      rhs(output, input);
      for (unsigned iD=0; iD < rhs.getTargetDim(); ++iD) {
        block.get(latticeR,iD) = output[iD];
      }
    });
  }
}

Member Function Documentation

communicate()

template<unsigned D, typename T , typename U >

void olb::SuperData< D, T, U >::communicate ( )

overridevirtual

Communicate overlaps.

Reimplemented from olb::SuperStructure< T, D >.

Definition at line 114 of file superData.hh.

{
  if (_communicator) {
    _communicator->communicate();
  }
}

getBlock() [1/4]

template<unsigned D, typename T , typename U >

BlockData< D, T, U > & olb::SuperData< D, T, U >::getBlock

(

int

iC

)

Definition at line 94 of file superData.hh.

{
  return *_block[iC];
}

getBlock() [2/4]

template<unsigned D, typename T , typename U >

template<typename BLOCK >

BLOCK & olb::SuperData< D, T, U >::getBlock

(

int

iC

)

Definition at line 101 of file superData.hh.

{
  return *_block[iC];
}

getBlock() [3/4]

template<unsigned D, typename T , typename U >

const BlockData< D, T, U > & olb::SuperData< D, T, U >::getBlock

(

int

iC

)

const

Definition at line 88 of file superData.hh.

{
  return *_block[iC];
}

Here is the caller graph for this function:

getBlock() [4/4]

template<unsigned D, typename T , typename U >

template<typename BLOCK >

const BLOCK & olb::SuperData< D, T, U >::getBlock

(

int

iC

)

const

Definition at line 108 of file superData.hh.

{
  return *_block[iC];
}

getDataSize()

template<unsigned D, typename T , typename U >

int olb::SuperData< D, T, U >::getDataSize

(

)

const

Read only access to the dim of the data of the super structure.

Definition at line 122 of file superData.hh.

{
  return _size;
}

getDataTypeSize()

template<unsigned D, typename T , typename U >

int olb::SuperData< D, T, U >::getDataTypeSize

(

)

const

Read only access to the data type dim of the data of the super structure.

Definition at line 128 of file superData.hh.

{
  return sizeof(U);
}

Member Data Documentation

_block

template<unsigned D, typename T , typename U >

std::vector<std::unique_ptr<BlockData<D,T,U> > > olb::SuperData< D, T, U >::_block

protected

Vector of BlockData.

Definition at line 50 of file superData.h.

_communicator

template<unsigned D, typename T , typename U >

std::unique_ptr<SuperCommunicator<T,SuperData> > olb::SuperData< D, T, U >::_communicator

protected

Inter-block communicator.

Definition at line 52 of file superData.h.

_size

template<unsigned D, typename T , typename U >

const std::size_t olb::SuperData< D, T, U >::_size

protected

Dimension of the data field.

Definition at line 48 of file superData.h.

d

template<unsigned D, typename T , typename U >

constexpr unsigned olb::SuperData< D, T, U >::d = D

staticconstexpr

Definition at line 55 of file superData.h.

---

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

• src/core/superData.h
• src/core/superData.hh