BasicInteraction Class Reference

Class to represent the common part of a pair interaction, i.e. the IDs of the particles and the interaction tag. More...

#include <BasicInteraction.h>

Inheritance diagram for BasicInteraction:

Public Types
typedef int	Id
typedef int	Tag

Public Member Functions
	BasicInteraction (Id id1, Id id2, Tag tag=0)
Id	first () const
Id	second () const
Id	getP1Id () const
Id	getP2Id () const
Tag	getTag () const
template<typename TmplVisitor >
void	visit (TmplVisitor &visitor) const

Private Attributes
Id	m_p1
Id	m_p2
Tag	m_tag

Friends
class	BILess
std::ostream &	operator<< (std::ostream &, const BasicInteraction &)

Detailed Description

Class to represent the common part of a pair interaction, i.e. the IDs of the particles and the interaction tag.

Author

Steffen Abe

Member Typedef Documentation

Id

typedef int BasicInteraction::Id

Tag

typedef int BasicInteraction::Tag

Constructor & Destructor Documentation

BasicInteraction()

BasicInteraction::BasicInteraction	(	Id	id1,
		Id	id2,
		Tag	tag = 0
	)

Member Function Documentation

first()

Id BasicInteraction::first ( ) const

inline

References m_p1.

Referenced by esys::lsm::exportTaggedIdConnection(), getP1Id(), esys::lsm::GougeConfig< TmplGrainRandomBoxPacker, TmplParticleRandomBoxPacker, TmplConnection >::GeoConnectionWriter::visitBasicInteraction(), esys::lsm::GeoInteractionWriter::visitBasicInteraction(), and esys::lsm::ParticleDataVisitor::writeParticleIndexConnections().

Here is the caller graph for this function:

getP1Id()

Id BasicInteraction::getP1Id ( ) const

inline

References first().

Referenced by esys::lsm::TaggedIdConnectionPyPickleSuite::getinitargs().

Here is the call graph for this function:

Here is the caller graph for this function:

getP2Id()

Id BasicInteraction::getP2Id ( ) const

inline

References second().

Referenced by esys::lsm::TaggedIdConnectionPyPickleSuite::getinitargs().

Here is the call graph for this function:

Here is the caller graph for this function:

getTag()

Tag BasicInteraction::getTag ( ) const

inline

References m_tag.

Referenced by esys::lsm::exportTaggedIdConnection(), esys::lsm::TaggedIdConnectionPyPickleSuite::getinitargs(), and esys::lsm::ParticleDataVisitor::writeConnectionTags().

Here is the caller graph for this function:

second()

Id BasicInteraction::second ( ) const

inline

References m_p2.

Referenced by esys::lsm::exportTaggedIdConnection(), getP2Id(), esys::lsm::GougeConfig< TmplGrainRandomBoxPacker, TmplParticleRandomBoxPacker, TmplConnection >::GeoConnectionWriter::visitBasicInteraction(), esys::lsm::GeoInteractionWriter::visitBasicInteraction(), and esys::lsm::ParticleDataVisitor::writeParticleIndexConnections().

Here is the caller graph for this function:

visit()

template<typename TmplVisitor >

void BasicInteraction::visit ( TmplVisitor &  visitor ) const

inline

Friends And Related Function Documentation

BILess

friend class BILess

friend

operator<<

std::ostream& operator<< ( std::ostream &  , const BasicInteraction &    )

friend

Member Data Documentation

m_p1

Id BasicInteraction::m_p1

private

Referenced by first(), BILess::operator()(), and operator<<().

m_p2

Id BasicInteraction::m_p2

private

Referenced by BILess::operator()(), operator<<(), and second().

m_tag

Tag BasicInteraction::m_tag

private

Referenced by getTag(), and operator<<().

---

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

• Geometry/BasicInteraction.h
• Geometry/BasicInteraction.cpp