ASubLattice Class Reference

Abstract base class for sublattices. More...

#include <ASubLattice.h>

Inheritance diagram for ASubLattice:

Collaboration diagram for ASubLattice:

Public Types
typedef std::pair< int, int >	ParticleIdPair
typedef std::vector< ParticleIdPair >	ParticleIdPairVector
typedef std::vector< int >	IdVector

Public Member Functions
virtual	~ASubLattice ()
void	setNTSize (int)
virtual void	setParticleType (const std::string &particleType)
virtual const std::string &	getParticleType () const
virtual void	setTimeStepSize (double dt)=0
virtual vector< int >	getCommCoords () const =0
virtual vector< int >	getCommDims () const =0
virtual void	receiveParticles ()=0
virtual void	receiveConnections ()=0
virtual void	addWall ()=0
virtual void	addElasticWIG ()=0
virtual void	addBondedWIG ()=0
virtual void	addDirBondedWIG ()=0
virtual void	addViscWIG ()=0
virtual void	addTaggedElasticWIG ()=0
virtual void	initNeighborTable (const Vec3 &, const Vec3 &)=0
virtual void	initNeighborTable (const Vec3 &, const Vec3 &, const vector< bool > &)=0
virtual void	addPairIG ()=0
virtual void	addTaggedPairIG ()=0
virtual void	addTriMesh ()=0
virtual void	addTriMeshIG ()=0
virtual void	addBondedTriMeshIG ()=0
virtual void	addMesh2D ()=0
virtual void	addMesh2DIG ()=0
virtual void	addBondedMesh2DIG ()=0
virtual void	addSingleIG ()=0
virtual void	addBondedIG ()=0
virtual void	addCappedBondedIG ()=0
virtual void	addShortBondedIG ()=0
virtual void	addRotBondedIG ()=0
virtual void	addRotThermBondedIG ()=0
virtual void	addDamping ()=0
virtual void	setExIG ()=0
virtual void	initComplex ()
virtual void	removeIG ()=0
virtual void	getWallPos ()=0
virtual void	getWallForce ()=0
virtual void	addSphereBody ()=0
virtual void	addESphereBodyIG ()=0
virtual void	getSphereBodyPos ()=0
virtual void	getSphereBodyForce ()=0
virtual const MPI_Comm &	getWorkerComm () const =0
virtual void	rebuildParticleArray ()=0
virtual void	rebuildInteractions ()=0
virtual void	searchNeighbors ()=0
virtual void	checkNeighbors ()=0
virtual void	updateInteractions ()=0
virtual int	getNumParticles ()=0
virtual std::pair< double, int >	findParticleNearestTo (const Vec3 &pt)=0
virtual std::pair< int, Vec3 >	getParticlePosn (int particleId)=0
virtual void	oneStep ()=0
virtual void	exchangePos ()=0
virtual void	moveParticleTo ()=0
virtual void	moveTaggedParticlesBy ()=0
virtual void	moveSingleParticleTo (int particleId, const Vec3 &posn)=0
virtual void	moveWallBy ()=0
virtual void	moveSphereBodyBy ()=0
virtual void	setWallNormal ()=0
virtual void	applyForceToWall ()=0
virtual void	setVelocityOfWall ()=0
virtual void	setParticleVelocity ()=0
virtual void	setParticleDensity ()=0
virtual void	setTaggedParticleVel ()=0
virtual void	setParticleAngularVelocity ()
virtual void	setParticleNonDynamic ()=0
virtual void	setParticleNonRot ()=0
virtual void	tagParticleNearestTo ()=0
virtual void	moveSingleNode ()=0
virtual void	moveTaggedNodes ()=0
virtual void	translateMeshBy (const std::string &meshName, const Vec3 &translation)=0
virtual void	setTimer (MpiWTimers &timers)=0
virtual void	do2dCalculations (bool do2d)=0
virtual void	countParticles ()=0
virtual void	addScalarParticleField ()=0
virtual void	addVectorParticleField ()=0
virtual void	addScalarInteractionField ()=0
virtual void	addScalarHistoryInteractionField ()=0
virtual void	addVectorInteractionField ()=0
virtual void	addVectorTriangleField ()=0
virtual void	addScalarTriangleField ()=0
virtual void	sendFieldData ()=0
virtual void	addVectorWallField ()=0
virtual void	printStruct ()=0
virtual void	printData ()=0
virtual void	printTimes ()=0
virtual void	getMeshNodeRef ()=0
virtual void	getMeshFaceRef ()=0
virtual void	getMesh2DStress ()=0
virtual void	getTriMeshForce ()=0
virtual void	getParticleData (const IdVector &particleIdVector)=0
virtual void	loadCheckPointData (std::istream &)
Public Member Functions inherited from esys::lsm::CheckPointable
	CheckPointable ()
virtual	~CheckPointable ()
virtual void	saveCheckPointData (std::ostream &oStream)=0
virtual void	saveSnapShotData (std::ostream &oStream)

Private Attributes
std::string	m_particleType

Detailed Description

Abstract base class for sublattices.

Member Typedef Documentation

IdVector

typedef std::vector<int> ASubLattice::IdVector

ParticleIdPair

typedef std::pair<int,int> ASubLattice::ParticleIdPair

ParticleIdPairVector

typedef std::vector<ParticleIdPair> ASubLattice::ParticleIdPairVector

Constructor & Destructor Documentation

~ASubLattice()

ASubLattice::~ASubLattice ( )

virtual

Member Function Documentation

addBondedIG()

virtual void ASubLattice::addBondedIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addBondedMesh2DIG()

virtual void ASubLattice::addBondedMesh2DIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addBondedTriMeshIG()

virtual void ASubLattice::addBondedTriMeshIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addBondedWIG()

virtual void ASubLattice::addBondedWIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addCappedBondedIG()

virtual void ASubLattice::addCappedBondedIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addDamping()

virtual void ASubLattice::addDamping ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addDirBondedWIG()

virtual void ASubLattice::addDirBondedWIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addElasticWIG()

virtual void ASubLattice::addElasticWIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addESphereBodyIG()

virtual void ASubLattice::addESphereBodyIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addMesh2D()

virtual void ASubLattice::addMesh2D ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addMesh2DIG()

virtual void ASubLattice::addMesh2DIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addPairIG()

virtual void ASubLattice::addPairIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addRotBondedIG()

virtual void ASubLattice::addRotBondedIG ( )

pure virtual

Implemented in TSubLattice< T >, and TRotSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addRotThermBondedIG()

virtual void ASubLattice::addRotThermBondedIG ( )

pure virtual

Implemented in TSubLattice< T >, and TRotSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addScalarHistoryInteractionField()

virtual void ASubLattice::addScalarHistoryInteractionField ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addScalarInteractionField()

virtual void ASubLattice::addScalarInteractionField ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addScalarParticleField()

virtual void ASubLattice::addScalarParticleField ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addScalarTriangleField()

virtual void ASubLattice::addScalarTriangleField ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addShortBondedIG()

virtual void ASubLattice::addShortBondedIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addSingleIG()

virtual void ASubLattice::addSingleIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addSphereBody()

virtual void ASubLattice::addSphereBody ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addTaggedElasticWIG()

virtual void ASubLattice::addTaggedElasticWIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addTaggedPairIG()

virtual void ASubLattice::addTaggedPairIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addTriMesh()

virtual void ASubLattice::addTriMesh ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addTriMeshIG()

virtual void ASubLattice::addTriMeshIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addVectorInteractionField()

virtual void ASubLattice::addVectorInteractionField ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addVectorParticleField()

virtual void ASubLattice::addVectorParticleField ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addVectorTriangleField()

virtual void ASubLattice::addVectorTriangleField ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addVectorWallField()

virtual void ASubLattice::addVectorWallField ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addViscWIG()

virtual void ASubLattice::addViscWIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

addWall()

virtual void ASubLattice::addWall ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

applyForceToWall()

virtual void ASubLattice::applyForceToWall ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

checkNeighbors()

virtual void ASubLattice::checkNeighbors ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

countParticles()

virtual void ASubLattice::countParticles ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

do2dCalculations()

virtual void ASubLattice::do2dCalculations ( bool  do2d )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::do2dCalculations().

Here is the caller graph for this function:

exchangePos()

virtual void ASubLattice::exchangePos ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

findParticleNearestTo()

virtual std::pair<double, int> ASubLattice::findParticleNearestTo ( const Vec3 &  pt )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::findParticleNearestToPoint().

Here is the caller graph for this function:

getCommCoords()

virtual vector<int> ASubLattice::getCommCoords ( ) const

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::initLattice(), and CSubLatticeControler::initLatticeCirc().

Here is the caller graph for this function:

getCommDims()

virtual vector<int> ASubLattice::getCommDims ( ) const

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::initLattice(), and CSubLatticeControler::initLatticeCirc().

Here is the caller graph for this function:

getMesh2DStress()

virtual void ASubLattice::getMesh2DStress ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

getMeshFaceRef()

virtual void ASubLattice::getMeshFaceRef ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

getMeshNodeRef()

virtual void ASubLattice::getMeshNodeRef ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

getNumParticles()

virtual int ASubLattice::getNumParticles ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::getNumParticles().

Here is the caller graph for this function:

getParticleData()

virtual void ASubLattice::getParticleData ( const IdVector &  particleIdVector )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::getIdParticleData().

Here is the caller graph for this function:

getParticlePosn()

virtual std::pair<int, Vec3> ASubLattice::getParticlePosn ( int  particleId )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::getParticlePosn().

Here is the caller graph for this function:

getParticleType()

virtual const std::string& ASubLattice::getParticleType ( ) const

inlinevirtual

References m_particleType.

getSphereBodyForce()

virtual void ASubLattice::getSphereBodyForce ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

getSphereBodyPos()

virtual void ASubLattice::getSphereBodyPos ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

getTriMeshForce()

virtual void ASubLattice::getTriMeshForce ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

getWallForce()

virtual void ASubLattice::getWallForce ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

getWallPos()

virtual void ASubLattice::getWallPos ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

getWorkerComm()

virtual const MPI_Comm& ASubLattice::getWorkerComm ( ) const

pure virtual

Implemented in TSubLattice< T >.

initComplex()

void ASubLattice::initComplex ( )

virtual

Default implementation for complex init. Just prints an error message.

References console, Console::Critical(), CVarMPIBuffer::receiveBroadcast(), CMPIBarrier::wait(), and Console::XDebug().

Referenced by CSubLatticeControler::run().

Here is the call graph for this function:

Here is the caller graph for this function:

initNeighborTable() [1/2]

virtual void ASubLattice::initNeighborTable ( const Vec3 &  , const Vec3 &    )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::initLattice(), and CSubLatticeControler::initLatticeCirc().

Here is the caller graph for this function:

initNeighborTable() [2/2]

virtual void ASubLattice::initNeighborTable ( const Vec3 &  , const Vec3 &  , const vector< bool > &    )

pure virtual

Implemented in TSubLattice< T >.

loadCheckPointData()

virtual void ASubLattice::loadCheckPointData ( std::istream &  )

inlinevirtual

Implements esys::lsm::CheckPointable.

Reimplemented in TSubLattice< T >.

Referenced by CSubLatticeControler::loadCheckPointData().

Here is the caller graph for this function:

moveParticleTo()

virtual void ASubLattice::moveParticleTo ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

moveSingleNode()

virtual void ASubLattice::moveSingleNode ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

moveSingleParticleTo()

virtual void ASubLattice::moveSingleParticleTo ( int  particleId, const Vec3 &  posn  )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::moveSingleParticle().

Here is the caller graph for this function:

moveSphereBodyBy()

virtual void ASubLattice::moveSphereBodyBy ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

moveTaggedNodes()

virtual void ASubLattice::moveTaggedNodes ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

moveTaggedParticlesBy()

virtual void ASubLattice::moveTaggedParticlesBy ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

moveWallBy()

virtual void ASubLattice::moveWallBy ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

oneStep()

virtual void ASubLattice::oneStep ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

printData()

virtual void ASubLattice::printData ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

printStruct()

virtual void ASubLattice::printStruct ( )

pure virtual

Implemented in TSubLattice< T >.

printTimes()

virtual void ASubLattice::printTimes ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

rebuildInteractions()

virtual void ASubLattice::rebuildInteractions ( )

pure virtual

Implemented in TSubLattice< T >.

rebuildParticleArray()

virtual void ASubLattice::rebuildParticleArray ( )

pure virtual

Implemented in TSubLattice< T >.

receiveConnections()

virtual void ASubLattice::receiveConnections ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

receiveParticles()

virtual void ASubLattice::receiveParticles ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

removeIG()

virtual void ASubLattice::removeIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

searchNeighbors()

virtual void ASubLattice::searchNeighbors ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::searchNeighbors().

Here is the caller graph for this function:

sendFieldData()

virtual void ASubLattice::sendFieldData ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

setExIG()

virtual void ASubLattice::setExIG ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

setNTSize()

void ASubLattice::setNTSize

(

int

size

)

Adjust the size of the neighbor table

Parameters

size

the size

setParticleAngularVelocity()

virtual void ASubLattice::setParticleAngularVelocity ( )

inlinevirtual

Reimplemented in TRotSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

setParticleDensity()

virtual void ASubLattice::setParticleDensity ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

setParticleNonDynamic()

virtual void ASubLattice::setParticleNonDynamic ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

setParticleNonRot()

virtual void ASubLattice::setParticleNonRot ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

setParticleType()

virtual void ASubLattice::setParticleType ( const std::string &  particleType )

inlinevirtual

References m_particleType.

setParticleVelocity()

virtual void ASubLattice::setParticleVelocity ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

setTaggedParticleVel()

virtual void ASubLattice::setTaggedParticleVel ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

setTimer()

virtual void ASubLattice::setTimer ( MpiWTimers &  timers )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::makeLattice().

Here is the caller graph for this function:

setTimeStepSize()

virtual void ASubLattice::setTimeStepSize ( double  dt )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::setTimeStepSize().

Here is the caller graph for this function:

setVelocityOfWall()

virtual void ASubLattice::setVelocityOfWall ( )

pure virtual

Implemented in TSubLattice< T >.

setWallNormal()

virtual void ASubLattice::setWallNormal ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

tagParticleNearestTo()

virtual void ASubLattice::tagParticleNearestTo ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

translateMeshBy()

virtual void ASubLattice::translateMeshBy ( const std::string &  meshName, const Vec3 &  translation  )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::translateMeshBy().

Here is the caller graph for this function:

updateInteractions()

virtual void ASubLattice::updateInteractions ( )

pure virtual

Implemented in TSubLattice< T >.

Referenced by CSubLatticeControler::run().

Here is the caller graph for this function:

Member Data Documentation

m_particleType

std::string ASubLattice::m_particleType

private

Referenced by getParticleType(), and setParticleType().

---

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

• Parallel/ASubLattice.h
• Parallel/ASubLattice.cpp