ESyS-Particle  2.3.4
AParallelParticleArray Class Referenceabstract

abstract base class for parallel particle storage array More...

#include <pp_array.h>

Collaboration diagram for AParallelParticleArray:

Public Member Functions

 AParallelParticleArray (TML_Comm *comm, const std::vector< unsigned int > &dims)
 
 AParallelParticleArray (TML_Comm *comm, const std::vector< unsigned int > &dims, const std::vector< bool > &circ)
 
virtual ~AParallelParticleArray ()
 
TML_CartComm getComm () const
 
int getTimeStamp ()
 return time stamp of last rebuild More...
 
virtual set< int > getBoundarySlabIds (int, int) const =0
 
virtual set< int > get2ndSlabIds (int, int) const =0
 
virtual bool isInInner (const Vec3 &)=0
 

Protected Attributes

TML_CartComm m_comm
 
int m_timestamp
 

Detailed Description

abstract base class for parallel particle storage array

Constructor & Destructor Documentation

◆ AParallelParticleArray() [1/2]

AParallelParticleArray::AParallelParticleArray ( TML_Comm comm,
const std::vector< unsigned int > &  dims 
)

Constructor, assuming no circular boundary conditions. Just sets up the cartesian communicator

Parameters
commthe communicator
dimsthe dimensions of the process space

◆ AParallelParticleArray() [2/2]

AParallelParticleArray::AParallelParticleArray ( TML_Comm comm,
const std::vector< unsigned int > &  dims,
const std::vector< bool > &  circ 
)

Constructor with given circular boundary conditions. Just sets up the cartesian communicator

Parameters
commthe communicator
dimsthe dimensions of the process space
circthe circular boundary conditions

◆ ~AParallelParticleArray()

virtual AParallelParticleArray::~AParallelParticleArray ( )
inlinevirtual

Member Function Documentation

◆ get2ndSlabIds()

virtual set<int> AParallelParticleArray::get2ndSlabIds ( int  ,
int   
) const
pure virtual

◆ getBoundarySlabIds()

virtual set<int> AParallelParticleArray::getBoundarySlabIds ( int  ,
int   
) const
pure virtual

◆ getComm()

TML_CartComm AParallelParticleArray::getComm ( ) const
inline

References m_comm.

◆ getTimeStamp()

int AParallelParticleArray::getTimeStamp ( )
inline

return time stamp of last rebuild

References m_timestamp.

◆ isInInner()

virtual bool AParallelParticleArray::isInInner ( const Vec3 )
pure virtual

Member Data Documentation

◆ m_comm

TML_CartComm AParallelParticleArray::m_comm
protected

Referenced by getComm().

◆ m_timestamp

int AParallelParticleArray::m_timestamp
protected

Referenced by getTimeStamp().


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