ESyS-Particle  2.3.4
esys::lsm::ClosePackBlock< TmplClosePackIterator, TmplParticle > Class Template Reference

#include <ClosePackBlock.h>

Inheritance diagram for esys::lsm::ClosePackBlock< TmplClosePackIterator, TmplParticle >:
Collaboration diagram for esys::lsm::ClosePackBlock< TmplClosePackIterator, TmplParticle >:

Public Types

typedef ParticleCollection< TmplParticle >::Particle Particle
 
typedef TmplClosePackIterator ClosePackIterator
 
typedef ClosePackBlockGenerator< TmplClosePackIterator, ParticleBlockGenerator
 
- Public Types inherited from esys::lsm::ParticleCollection< TmplParticle >
typedef TmplParticle Particle
 
typedef boost::object_pool< ParticleParticlePool
 
typedef boost::shared_ptr< ParticlePoolParticlePoolPtr
 

Public Member Functions

 ClosePackBlock (unsigned int numX, unsigned int numY, unsigned int numZ, double radius=0.5, ClosePackOrientation orientation=DEFAULT_ORIENT)
 
virtual ~ClosePackBlock ()
 
double getRadius () const
 
- Public Member Functions inherited from esys::lsm::ParticleCollection< TmplParticle >
 ParticleCollection ()
 
 ParticleCollection (ParticlePoolPtr particlePoolPtr)
 
 ParticleCollection (const ParticleCollection &p)
 
ParticleCollectionoperator= (const ParticleCollection &p)
 
virtual ~ParticleCollection ()
 
int getNumParticles () const
 
BoundingBox getParticleBBox () const
 
ParticleIterator getParticleIterator ()
 
ParticleConstIterator getParticleIterator () const
 
void translateBy (const Vec3 &vec)
 
void rotate (const Vec3 &rotation, const Vec3 &posn)
 
void incrementIdBy (typename Particle::Id idIncr)
 
void insertRef (Particle &p)
 
ParticlecreateParticle (const Particle &p)
 

Protected Member Functions

void createParticles ()
 
- Protected Member Functions inherited from esys::lsm::ParticleCollection< TmplParticle >
void noCheckInsertRef (Particle &p)
 

Private Attributes

BlockGenerator m_generator
 

Member Typedef Documentation

◆ BlockGenerator

template<typename TmplClosePackIterator , typename TmplParticle >
typedef ClosePackBlockGenerator<TmplClosePackIterator, Particle> esys::lsm::ClosePackBlock< TmplClosePackIterator, TmplParticle >::BlockGenerator

◆ ClosePackIterator

template<typename TmplClosePackIterator , typename TmplParticle >
typedef TmplClosePackIterator esys::lsm::ClosePackBlock< TmplClosePackIterator, TmplParticle >::ClosePackIterator

◆ Particle

template<typename TmplClosePackIterator , typename TmplParticle >
typedef ParticleCollection<TmplParticle>::Particle esys::lsm::ClosePackBlock< TmplClosePackIterator, TmplParticle >::Particle

Constructor & Destructor Documentation

◆ ClosePackBlock()

template<typename TmplClosePackIterator , typename TmplParticle >
esys::lsm::ClosePackBlock< TmplClosePackIterator, TmplParticle >::ClosePackBlock ( unsigned int  numX,
unsigned int  numY,
unsigned int  numZ,
double  radius = 0.5,
ClosePackOrientation  orientation = DEFAULT_ORIENT 
)

References esys::lsm::ClosePackBlock< TmplClosePackIterator, TmplParticle >::createParticles().

Here is the call graph for this function:

◆ ~ClosePackBlock()

template<typename TmplClosePackIterator , typename TmplParticle >
esys::lsm::ClosePackBlock< TmplClosePackIterator, TmplParticle >::~ClosePackBlock
virtual

Member Function Documentation

◆ createParticles()

template<typename TmplClosePackIterator , typename TmplParticle >
void esys::lsm::ClosePackBlock< TmplClosePackIterator, TmplParticle >::createParticles
protected

Referenced by esys::lsm::ClosePackBlock< TmplClosePackIterator, TmplParticle >::ClosePackBlock().

Here is the caller graph for this function:

◆ getRadius()

template<typename TmplClosePackIterator , typename TmplParticle >
double esys::lsm::ClosePackBlock< TmplClosePackIterator, TmplParticle >::getRadius

Member Data Documentation

◆ m_generator

template<typename TmplClosePackIterator , typename TmplParticle >
BlockGenerator esys::lsm::ClosePackBlock< TmplClosePackIterator, TmplParticle >::m_generator
private

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