ESyS-Particle  2.3.4
esys::lsm::BoxPacker< TmplPackerBase > Class Template Referenceabstract

#include <BoxPacker.h>

Inheritance diagram for esys::lsm::BoxPacker< TmplPackerBase >:
Collaboration diagram for esys::lsm::BoxPacker< TmplPackerBase >:

Public Types

typedef TmplPackerBase Inherited
 
typedef Inherited::Particle Particle
 
typedef Inherited::NTable NTable
 
typedef Inherited::NTablePtr NTablePtr
 
typedef Inherited::ParticlePool ParticlePool
 
typedef Inherited::ParticlePoolPtr ParticlePoolPtr
 

Public Member Functions

 BoxPacker (ParticlePoolPtr particlePoolPtr, NTablePtr nTablePtr, const BoundingBox &bBox, const BoolVector &periodicDimensions, double tolerance)
 
virtual ~BoxPacker ()
 
virtual void generate ()=0
 
bool particleFitsInBBox (const Particle &particle) const
 
bool is2d () const
 
bool particleFitsInBBoxWithNeighbours (const Particle &particle) const
 
bool particleFitsWithNeighbours (const Particle &particle) const
 
double getTolerance () const
 
const BoundingBoxgetBBox () const
 
const BoolVectorgetPeriodicDimensions () const
 

Private Attributes

BoundingBox m_bBox
 
BoolVector m_periodicDimensions
 
double m_tolerance
 

Member Typedef Documentation

◆ Inherited

template<typename TmplPackerBase >
typedef TmplPackerBase esys::lsm::BoxPacker< TmplPackerBase >::Inherited

◆ NTable

template<typename TmplPackerBase >
typedef Inherited::NTable esys::lsm::BoxPacker< TmplPackerBase >::NTable

◆ NTablePtr

template<typename TmplPackerBase >
typedef Inherited::NTablePtr esys::lsm::BoxPacker< TmplPackerBase >::NTablePtr

◆ Particle

template<typename TmplPackerBase >
typedef Inherited::Particle esys::lsm::BoxPacker< TmplPackerBase >::Particle

◆ ParticlePool

template<typename TmplPackerBase >
typedef Inherited::ParticlePool esys::lsm::BoxPacker< TmplPackerBase >::ParticlePool

◆ ParticlePoolPtr

template<typename TmplPackerBase >
typedef Inherited::ParticlePoolPtr esys::lsm::BoxPacker< TmplPackerBase >::ParticlePoolPtr

Constructor & Destructor Documentation

◆ BoxPacker()

template<typename TmplPackerBase >
esys::lsm::BoxPacker< TmplPackerBase >::BoxPacker ( ParticlePoolPtr  particlePoolPtr,
NTablePtr  nTablePtr,
const BoundingBox bBox,
const BoolVector periodicDimensions,
double  tolerance 
)

◆ ~BoxPacker()

template<typename TmplPackerBase >
esys::lsm::BoxPacker< TmplPackerBase >::~BoxPacker
virtual

Member Function Documentation

◆ generate()

template<typename TmplPackerBase >
virtual void esys::lsm::BoxPacker< TmplPackerBase >::generate ( )
pure virtual

◆ getBBox()

template<typename TmplPackerBase >
const BoundingBox & esys::lsm::BoxPacker< TmplPackerBase >::getBBox

◆ getPeriodicDimensions()

template<typename TmplPackerBase >
const BoolVector & esys::lsm::BoxPacker< TmplPackerBase >::getPeriodicDimensions

◆ getTolerance()

template<typename TmplPackerBase >
double esys::lsm::BoxPacker< TmplPackerBase >::getTolerance

◆ is2d()

template<typename TmplPackerBase >
bool esys::lsm::BoxPacker< TmplPackerBase >::is2d

References getBBox().

Here is the call graph for this function:

◆ particleFitsInBBox()

template<typename TmplPackerBase >
bool esys::lsm::BoxPacker< TmplPackerBase >::particleFitsInBBox ( const Particle particle) const

◆ particleFitsInBBoxWithNeighbours()

template<typename TmplPackerBase >
bool esys::lsm::BoxPacker< TmplPackerBase >::particleFitsInBBoxWithNeighbours ( const Particle particle) const

◆ particleFitsWithNeighbours()

template<typename TmplPackerBase >
bool esys::lsm::BoxPacker< TmplPackerBase >::particleFitsWithNeighbours ( const Particle particle) const

References esys::lsm::bpu::iter().

Here is the call graph for this function:

Member Data Documentation

◆ m_bBox

template<typename TmplPackerBase >
BoundingBox esys::lsm::BoxPacker< TmplPackerBase >::m_bBox
private

◆ m_periodicDimensions

template<typename TmplPackerBase >
BoolVector esys::lsm::BoxPacker< TmplPackerBase >::m_periodicDimensions
private

◆ m_tolerance

template<typename TmplPackerBase >
double esys::lsm::BoxPacker< TmplPackerBase >::m_tolerance
private

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