ESyS-Particle  2.3.4
Classes | Public Types | Public Member Functions | Protected Member Functions | Private Types | Private Attributes | List of all members
esys::lsm::CartesianGrid< TmplValue > Class Template Reference

#include <CartesianGrid.h>

Inheritance diagram for esys::lsm::CartesianGrid< TmplValue >:
Inheritance graph
[legend]
Collaboration diagram for esys::lsm::CartesianGrid< TmplValue >:
Collaboration graph
[legend]

Classes

class  Cell
 
class  TCellIterator
 
class  ValueConstIterator
 
class  ValueIterator
 
class  VecIndexIterator
 

Public Types

typedef TmplValue value_type
 
typedef value_type & reference
 
typedef const value_type & const_reference
 
typedef value_type * pointer
 
typedef TCellIterator< CartesianGrid *, Cell &, Cell > CellIterator
 
typedef TCellIterator< const CartesianGrid *, const Cell &, Cell > CellConstIterator
 
typedef std::vector< pointer > ValueVector
 

Public Member Functions

 CartesianGrid (const BoundingBox &bBox, double gridSpacing)
 
const Vec3L & getDimensions () const
 
const BoundingBox & getBBox () const
 
const Vec3 & getMinPt () const
 
int getScalarIndex (int xIdx, int yIdx, int zIdx) const
 
Vec3L getVecIndex (const Vec3 &pt) const
 
Vec3 getPos (const Vec3L &index) const
 
int getScalarIndex (const Vec3L &index) const
 
int getScalarIndex (const Vec3 &pt) const
 
const Vec3L & getMinVecIndex () const
 
const Vec3L & getMaxVecIndex () const
 
void insert (const Vec3 &pos, const_reference data)
 
const Cell & getCell (int scalarIndex) const
 
Cell & getCell (int scalarIndex)
 
const Cell & getCell (const Vec3 &pos) const
 
Cell & getCell (const Vec3 &pos)
 
CellIterator getCellIterator (const Vec3 &pos, double radius)
 
CellConstIterator getCellIterator (const Vec3 &pos, double radius) const
 
CellIterator getCellIterator (const Vec3 &pos)
 
CellConstIterator getCellIterator (const Vec3 &pos) const
 
CellIterator getCellIterator ()
 
CellConstIterator getCellIterator () const
 
ValueIterator getValueIterator ()
 
ValueConstIterator getValueIterator () const
 
size_t size () const
 
double getGridSpacing () const
 
void clear ()
 

Protected Member Functions

void insertRef (const Vec3 &pos, reference data)
 
void initialise (const BoundingBox &bBox, double gridSpacing)
 

Private Types

typedef std::vector< Cell > CellVector
 
typedef boost::object_pool< value_type > Pool
 
typedef boost::shared_ptr< Pool > PoolPtr
 

Private Attributes

BoundingBox m_bBox
 
double m_gridSpacing
 
Vec3L m_dimensions
 
Vec3L m_minIndex
 
Vec3L m_maxIndex
 
CellVector m_cellVector
 
PoolPtr m_valuePoolPtr
 
ValueVector m_valueVector
 

Member Typedef Documentation

◆ CellConstIterator

template<typename TmplValue >
typedef TCellIterator<const CartesianGrid *, const Cell &, Cell> esys::lsm::CartesianGrid< TmplValue >::CellConstIterator

◆ CellIterator

template<typename TmplValue >
typedef TCellIterator<CartesianGrid *, Cell &, Cell> esys::lsm::CartesianGrid< TmplValue >::CellIterator

◆ CellVector

template<typename TmplValue >
typedef std::vector<Cell> esys::lsm::CartesianGrid< TmplValue >::CellVector
private

◆ const_reference

template<typename TmplValue >
typedef const value_type& esys::lsm::CartesianGrid< TmplValue >::const_reference

◆ pointer

template<typename TmplValue >
typedef value_type* esys::lsm::CartesianGrid< TmplValue >::pointer

◆ Pool

template<typename TmplValue >
typedef boost::object_pool<value_type> esys::lsm::CartesianGrid< TmplValue >::Pool
private

◆ PoolPtr

template<typename TmplValue >
typedef boost::shared_ptr<Pool> esys::lsm::CartesianGrid< TmplValue >::PoolPtr
private

◆ reference

template<typename TmplValue >
typedef value_type& esys::lsm::CartesianGrid< TmplValue >::reference

◆ value_type

template<typename TmplValue >
typedef TmplValue esys::lsm::CartesianGrid< TmplValue >::value_type

◆ ValueVector

template<typename TmplValue >
typedef std::vector<pointer> esys::lsm::CartesianGrid< TmplValue >::ValueVector

Constructor & Destructor Documentation

◆ CartesianGrid()

template<typename TmplValue >
esys::lsm::CartesianGrid< TmplValue >::CartesianGrid ( const BoundingBox &  bBox,
double  gridSpacing 
)
inline

Member Function Documentation

◆ clear()

template<typename TmplValue >
void esys::lsm::CartesianGrid< TmplValue >::clear ( )
inline

◆ getBBox()

template<typename TmplValue >
const BoundingBox& esys::lsm::CartesianGrid< TmplValue >::getBBox ( ) const
inline

Referenced by esys::lsm::CartesianGrid< Tensor >::getMinPt().

Here is the caller graph for this function:

◆ getCell() [1/4]

template<typename TmplValue >
Cell& esys::lsm::CartesianGrid< TmplValue >::getCell ( const Vec3 &  pos)
inline

◆ getCell() [2/4]

template<typename TmplValue >
const Cell& esys::lsm::CartesianGrid< TmplValue >::getCell ( const Vec3 &  pos) const
inline

◆ getCell() [3/4]

template<typename TmplValue >
Cell& esys::lsm::CartesianGrid< TmplValue >::getCell ( int  scalarIndex)
inline

◆ getCell() [4/4]

template<typename TmplValue >
const Cell& esys::lsm::CartesianGrid< TmplValue >::getCell ( int  scalarIndex) const
inline

Referenced by esys::lsm::CartesianGrid< Tensor >::getCell(), esys::lsm::CartesianGrid< Tensor >::initialise(), and esys::lsm::CartesianGrid< Tensor >::insertRef().

Here is the caller graph for this function:

◆ getCellIterator() [1/6]

template<typename TmplValue >
CellIterator esys::lsm::CartesianGrid< TmplValue >::getCellIterator ( )
inline

Referenced by esys::lsm::CartesianGrid< Tensor >::clear(), and esys::lsm::CartesianGrid< Tensor >::getCellIterator().

Here is the caller graph for this function:

◆ getCellIterator() [2/6]

template<typename TmplValue >
CellConstIterator esys::lsm::CartesianGrid< TmplValue >::getCellIterator ( ) const
inline

◆ getCellIterator() [3/6]

template<typename TmplValue >
CellIterator esys::lsm::CartesianGrid< TmplValue >::getCellIterator ( const Vec3 &  pos)
inline

◆ getCellIterator() [4/6]

template<typename TmplValue >
CellConstIterator esys::lsm::CartesianGrid< TmplValue >::getCellIterator ( const Vec3 &  pos) const
inline

◆ getCellIterator() [5/6]

template<typename TmplValue >
CellIterator esys::lsm::CartesianGrid< TmplValue >::getCellIterator ( const Vec3 &  pos,
double  radius 
)
inline

Referenced by esys::lsm::InteractionToStressConverter::calcDevRegularGrid(), esys::lsm::InteractionToStressConverter::calcTensorRegularGrid(), esys::lsm::InteractionToStressConverter::writeFlatStructured(), esys::lsm::InteractionToStressConverter::writeVtkStructuredXml(), and esys::lsm::InteractionToStressConverter::writeVtkUnstructuredXmlGridInformation().

Here is the caller graph for this function:

◆ getCellIterator() [6/6]

template<typename TmplValue >
CellConstIterator esys::lsm::CartesianGrid< TmplValue >::getCellIterator ( const Vec3 &  pos,
double  radius 
) const
inline

◆ getDimensions()

template<typename TmplValue >
const Vec3L& esys::lsm::CartesianGrid< TmplValue >::getDimensions ( ) const
inline

◆ getGridSpacing()

template<typename TmplValue >
double esys::lsm::CartesianGrid< TmplValue >::getGridSpacing ( ) const
inline

Referenced by esys::lsm::CartesianGrid< TmplValue >::Cell::getBox().

Here is the caller graph for this function:

◆ getMaxVecIndex()

template<typename TmplValue >
const Vec3L& esys::lsm::CartesianGrid< TmplValue >::getMaxVecIndex ( ) const
inline

Referenced by esys::lsm::CartesianGrid< Tensor >::getCellIterator(), esys::lsm::CartesianGrid< Tensor >::getVecIndex(), esys::lsm::CartesianGrid< Tensor >::initialise(), and esys::lsm::InteractionToStressConverter::writeVtkStructuredXml().

Here is the caller graph for this function:

◆ getMinPt()

template<typename TmplValue >
const Vec3& esys::lsm::CartesianGrid< TmplValue >::getMinPt ( ) const
inline

Referenced by esys::lsm::CartesianGrid< Tensor >::getPos(), and esys::lsm::CartesianGrid< Tensor >::getVecIndex().

Here is the caller graph for this function:

◆ getMinVecIndex()

template<typename TmplValue >
const Vec3L& esys::lsm::CartesianGrid< TmplValue >::getMinVecIndex ( ) const
inline

Referenced by esys::lsm::CartesianGrid< Tensor >::getCellIterator(), esys::lsm::CartesianGrid< Tensor >::getVecIndex(), esys::lsm::CartesianGrid< Tensor >::initialise(), and esys::lsm::InteractionToStressConverter::writeVtkStructuredXml().

Here is the caller graph for this function:

◆ getPos()

template<typename TmplValue >
Vec3 esys::lsm::CartesianGrid< TmplValue >::getPos ( const Vec3L &  index) const
inline

Referenced by esys::lsm::CartesianGrid< Tensor >::initialise().

Here is the caller graph for this function:

◆ getScalarIndex() [1/3]

template<typename TmplValue >
int esys::lsm::CartesianGrid< TmplValue >::getScalarIndex ( const Vec3 &  pt) const
inline

◆ getScalarIndex() [2/3]

template<typename TmplValue >
int esys::lsm::CartesianGrid< TmplValue >::getScalarIndex ( const Vec3L &  index) const
inline

◆ getScalarIndex() [3/3]

template<typename TmplValue >
int esys::lsm::CartesianGrid< TmplValue >::getScalarIndex ( int  xIdx,
int  yIdx,
int  zIdx 
) const
inline

Referenced by esys::lsm::CartesianGrid< Tensor >::getCell(), esys::lsm::CartesianGrid< Tensor >::getScalarIndex(), and esys::lsm::CartesianGrid< Tensor >::initialise().

Here is the caller graph for this function:

◆ getValueIterator() [1/2]

template<typename TmplValue >
ValueIterator esys::lsm::CartesianGrid< TmplValue >::getValueIterator ( )
inline

Referenced by esys::lsm::InteractionToStressConverter::getMaxRadius().

Here is the caller graph for this function:

◆ getValueIterator() [2/2]

template<typename TmplValue >
ValueConstIterator esys::lsm::CartesianGrid< TmplValue >::getValueIterator ( ) const
inline

◆ getVecIndex()

template<typename TmplValue >
Vec3L esys::lsm::CartesianGrid< TmplValue >::getVecIndex ( const Vec3 &  pt) const
inline

Referenced by esys::lsm::CartesianGrid< Tensor >::getCellIterator(), and esys::lsm::CartesianGrid< Tensor >::getScalarIndex().

Here is the caller graph for this function:

◆ initialise()

template<typename TmplValue >
void esys::lsm::CartesianGrid< TmplValue >::initialise ( const BoundingBox &  bBox,
double  gridSpacing 
)
inlineprotected

Referenced by esys::lsm::CartesianGrid< Tensor >::CartesianGrid().

Here is the caller graph for this function:

◆ insert()

template<typename TmplValue >
void esys::lsm::CartesianGrid< TmplValue >::insert ( const Vec3 &  pos,
const_reference  data 
)
inline

Referenced by esys::lsm::InteractionToStressConverter::calcDevRegularGrid(), esys::lsm::InteractionToStressConverter::calcTensorIrregularGrid(), and esys::lsm::InteractionToStressConverter::calcTensorRegularGrid().

Here is the caller graph for this function:

◆ insertRef()

template<typename TmplValue >
void esys::lsm::CartesianGrid< TmplValue >::insertRef ( const Vec3 &  pos,
reference  data 
)
inlineprotected

Referenced by esys::lsm::CartesianGrid< Tensor >::insert().

Here is the caller graph for this function:

◆ size()

template<typename TmplValue >
size_t esys::lsm::CartesianGrid< TmplValue >::size ( ) const
inline

Referenced by esys::lsm::InteractionToStressConverter::getDevRegularGrid(), esys::lsm::InteractionToStressConverter::getTensorIrregularGrid(), and esys::lsm::InteractionToStressConverter::getTensorRegularGrid().

Here is the caller graph for this function:

Member Data Documentation

◆ m_bBox

template<typename TmplValue >
BoundingBox esys::lsm::CartesianGrid< TmplValue >::m_bBox
private

Referenced by esys::lsm::CartesianGrid< Tensor >::getBBox(), and esys::lsm::CartesianGrid< Tensor >::initialise().

◆ m_cellVector

template<typename TmplValue >
CellVector esys::lsm::CartesianGrid< TmplValue >::m_cellVector
private

Referenced by esys::lsm::CartesianGrid< Tensor >::getCell(), and esys::lsm::CartesianGrid< Tensor >::initialise().

◆ m_dimensions

template<typename TmplValue >
Vec3L esys::lsm::CartesianGrid< TmplValue >::m_dimensions
private

Referenced by esys::lsm::CartesianGrid< Tensor >::getDimensions(), esys::lsm::CartesianGrid< Tensor >::getScalarIndex(), and esys::lsm::CartesianGrid< Tensor >::initialise().

◆ m_gridSpacing

template<typename TmplValue >
double esys::lsm::CartesianGrid< TmplValue >::m_gridSpacing
private

Referenced by esys::lsm::CartesianGrid< Tensor >::getGridSpacing(), esys::lsm::CartesianGrid< Tensor >::getPos(), esys::lsm::CartesianGrid< Tensor >::getVecIndex(), and esys::lsm::CartesianGrid< Tensor >::initialise().

◆ m_maxIndex

template<typename TmplValue >
Vec3L esys::lsm::CartesianGrid< TmplValue >::m_maxIndex
private

Referenced by esys::lsm::CartesianGrid< Tensor >::getMaxVecIndex(), and esys::lsm::CartesianGrid< Tensor >::initialise().

◆ m_minIndex

template<typename TmplValue >
Vec3L esys::lsm::CartesianGrid< TmplValue >::m_minIndex
private

Referenced by esys::lsm::CartesianGrid< Tensor >::getMinVecIndex(), and esys::lsm::CartesianGrid< Tensor >::initialise().

◆ m_valuePoolPtr

template<typename TmplValue >
PoolPtr esys::lsm::CartesianGrid< TmplValue >::m_valuePoolPtr
private

Referenced by esys::lsm::CartesianGrid< Tensor >::clear(), and esys::lsm::CartesianGrid< Tensor >::insert().

◆ m_valueVector

template<typename TmplValue >
ValueVector esys::lsm::CartesianGrid< TmplValue >::m_valueVector
private

Referenced by esys::lsm::CartesianGrid< Tensor >::clear(), esys::lsm::CartesianGrid< Tensor >::getValueIterator(), esys::lsm::CartesianGrid< Tensor >::initialise(), esys::lsm::CartesianGrid< Tensor >::insertRef(), and esys::lsm::CartesianGrid< Tensor >::size().

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