ESyS-Particle  2.3.2
esys::lsm::CLatticeParam Class Reference

#include <LatticeParam.h>

Collaboration diagram for esys::lsm::CLatticeParam:

Public Types

typedef std::vector< unsigned int > ProcessDims

Public Member Functions

 CLatticeParam (const std::string &particleType, double nrange, double alpha, const ProcessDims &dims=ProcessDims(3, 0))
void setSearchRange (double nr, double a)
void setParticleType (const std::string &pt)
void packInto (AMPIBuffer *) const
double nrange () const
double alpha () const
const ProcessDimsprocessDims () const
const std::string & particle_type () const

Static Public Member Functions

static CLatticeParam extractLatticeParam (AMPIBuffer *pBuff)

Protected Attributes

std::string m_particle_type
double m_alpha
 pair creation cutoff
double m_nrange
 searchrange
ProcessDims m_dims

Friends

std::ostream & operator<< (std::ostream &oStream, const CLatticeParam &prms)

Detailed Description

Parameters for the sublattice.

Member Typedef Documentation

typedef std::vector<unsigned int> esys::lsm::CLatticeParam::ProcessDims

Constructor & Destructor Documentation

esys::lsm::CLatticeParam::CLatticeParam ( const std::string &  particleType,
double  nrange,
double  alpha,
const ProcessDims dims = ProcessDims(3, 0) 
)

References m_alpha, m_dims, m_nrange, and m_particle_type.

Referenced by extractLatticeParam().

Here is the caller graph for this function:

Member Function Documentation

double esys::lsm::CLatticeParam::alpha ( ) const
inline

References m_alpha.

Referenced by extractLatticeParam(), and TSubLattice< T >::TSubLattice().

Here is the caller graph for this function:

CLatticeParam esys::lsm::CLatticeParam::extractLatticeParam ( AMPIBuffer pBuff)
static

References alpha(), CLatticeParam(), nrange(), AMPIBuffer::pop_double(), AMPIBuffer::pop_int(), and AMPIBuffer::pop_string().

Here is the call graph for this function:

double esys::lsm::CLatticeParam::nrange ( ) const
inline

References m_nrange.

Referenced by extractLatticeParam(), and TSubLattice< T >::TSubLattice().

Here is the caller graph for this function:

void esys::lsm::CLatticeParam::packInto ( AMPIBuffer B) const

References AMPIBuffer::append(), m_alpha, m_dims, m_nrange, and m_particle_type.

Referenced by CLatticeMaster::makeLattice().

Here is the call graph for this function:

Here is the caller graph for this function:

const std::string& esys::lsm::CLatticeParam::particle_type ( ) const
inline

References m_particle_type.

Referenced by CSubLatticeControler::makeLattice().

Here is the caller graph for this function:

const ProcessDims& esys::lsm::CLatticeParam::processDims ( ) const
inline

References m_dims.

Referenced by TSubLattice< T >::TSubLattice().

Here is the caller graph for this function:

void esys::lsm::CLatticeParam::setParticleType ( const std::string &  pt)
inline

References m_particle_type.

void esys::lsm::CLatticeParam::setSearchRange ( double  nr,
double  a 
)
inline

References m_alpha, and m_nrange.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  oStream,
const CLatticeParam prms 
)
friend

Member Data Documentation

double esys::lsm::CLatticeParam::m_alpha
protected

pair creation cutoff

Referenced by alpha(), CLatticeParam(), esys::lsm::operator<<(), packInto(), and setSearchRange().

ProcessDims esys::lsm::CLatticeParam::m_dims
protected
double esys::lsm::CLatticeParam::m_nrange
protected
std::string esys::lsm::CLatticeParam::m_particle_type
protected

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