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 ProcessDims &	processDims () 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 More...
double	m_nrange
	searchrange More...
ProcessDims	m_dims

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

Detailed Description

Parameters for the sublattice.

Member Typedef Documentation

ProcessDims

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

Constructor & Destructor Documentation

CLatticeParam()

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

alpha()

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:

extractLatticeParam()

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:

nrange()

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:

packInto()

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:

particle_type()

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:

processDims()

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

inline

References m_dims.

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

Here is the caller graph for this function:

setParticleType()

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

inline

References m_particle_type.

setSearchRange()

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

inline

References m_alpha, and m_nrange.

Friends And Related Function Documentation

operator<<

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

friend

Member Data Documentation

m_alpha

double esys::lsm::CLatticeParam::m_alpha

protected

pair creation cutoff

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

m_dims

ProcessDims esys::lsm::CLatticeParam::m_dims

protected

Referenced by CLatticeParam(), packInto(), and processDims().

m_nrange

double esys::lsm::CLatticeParam::m_nrange

protected

searchrange

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

m_particle_type

std::string esys::lsm::CLatticeParam::m_particle_type

protected

Referenced by CLatticeParam(), esys::lsm::operator<<(), packInto(), particle_type(), and setParticleType().

---

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

• Parallel/LatticeParam.h
• Parallel/LatticeParam.cpp