esys::lsm::ParticleGenerator Class Reference

#include <ParticleGenerator.h>

Inheritance diagram for esys::lsm::ParticleGenerator:

Collaboration diagram for esys::lsm::ParticleGenerator:

Public Types
typedef CircularNeighbourTable< SimpleParticle >	NTable
typedef boost::object_pool< SimpleParticle >	ParticlePool

Public Member Functions
	ParticleGenerator (NTable &nTable, ParticlePool &particlePool)
virtual	~ParticleGenerator ()
virtual void	generate ()=0

Protected Member Functions
	ParticleGenerator ()
NTable &	getNTable ()
const NTable &	getNTable () const
ParticlePool &	getParticlePool ()
const ParticlePool &	getParticlePool () const

Private Attributes
NTable *	m_pNTable
ParticlePool *	m_pParticlePool

Member Typedef Documentation

NTable

typedef CircularNeighbourTable<SimpleParticle> esys::lsm::ParticleGenerator::NTable

ParticlePool

typedef boost::object_pool<SimpleParticle> esys::lsm::ParticleGenerator::ParticlePool

Constructor & Destructor Documentation

ParticleGenerator() [1/2]

esys::lsm::ParticleGenerator::ParticleGenerator	(	NTable &	nTable,
		ParticlePool &	particlePool
	)

~ParticleGenerator()

esys::lsm::ParticleGenerator::~ParticleGenerator ( )

virtual

ParticleGenerator() [2/2]

esys::lsm::ParticleGenerator::ParticleGenerator ( )

protected

Member Function Documentation

generate()

virtual void esys::lsm::ParticleGenerator::generate ( )

pure virtual

Implemented in esys::lsm::BlockGenerator, esys::lsm::SphereBlockGenerator, esys::lsm::RegularBlockGenerator, and esys::lsm::RandomBlockGenerator.

getNTable() [1/2]

ParticleGenerator::NTable & esys::lsm::ParticleGenerator::getNTable ( )

protected

References m_pNTable.

Referenced by esys::lsm::SphereBlockGenerator::checkAFit(), esys::lsm::SphereBlockGenerator::getClosestNeighbors(), esys::lsm::RandomBlockGenerator::getClosestNeighbors(), esys::lsm::BlockGenerator::getNextId(), esys::lsm::SphereBlockGenerator::getNextId(), esys::lsm::SphereBlockGenerator::insertParticle(), esys::lsm::BlockGenerator::insertParticle(), and esys::lsm::BlockGenerator::particleFitsWithNeighbours().

Here is the caller graph for this function:

getNTable() [2/2]

const ParticleGenerator::NTable & esys::lsm::ParticleGenerator::getNTable ( ) const

protected

References m_pNTable.

getParticlePool() [1/2]

ParticleGenerator::ParticlePool & esys::lsm::ParticleGenerator::getParticlePool ( )

protected

References m_pParticlePool.

Referenced by esys::lsm::SphereBlockGenerator::insertParticle(), and esys::lsm::BlockGenerator::insertParticle().

Here is the caller graph for this function:

getParticlePool() [2/2]

const ParticleGenerator::ParticlePool & esys::lsm::ParticleGenerator::getParticlePool ( ) const

protected

References m_pParticlePool.

Member Data Documentation

m_pNTable

NTable* esys::lsm::ParticleGenerator::m_pNTable

private

Referenced by getNTable().

m_pParticlePool

ParticlePool* esys::lsm::ParticleGenerator::m_pParticlePool

private

Referenced by getParticlePool().

---

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

• Geometry/ParticleGenerator.h
• Geometry/ParticleGenerator.cpp