esys::lsm::BondInteractionGroupPy Class Reference

#include <BondInteractionGroupPy.h>

Inheritance diagram for esys::lsm::BondInteractionGroupPy:

Collaboration diagram for esys::lsm::BondInteractionGroupPy:

Public Member Functions
	BondInteractionGroupPy (LsmMpiPy &lsm, const std::string &name)
void	createInteraction (int id1, int id2)
void	createInteractions (boost::python::object &iterable)
ParticleIdPairSetPy	getIdPairSet ()
Public Member Functions inherited from esys::lsm::InteractionGroupPy
	InteractionGroupPy (LsmMpiPy &lsmMpi, const std::string &name)
const std::string &	getName () const

Additional Inherited Members
Protected Member Functions inherited from esys::lsm::InteractionGroupPy
LsmMpiPy &	getLsm ()
const LsmMpiPy &	getLsm () const

Detailed Description

Bond interaction group, delegates to an LsmMpiPy object.

Constructor & Destructor Documentation

BondInteractionGroupPy()

esys::lsm::BondInteractionGroupPy::BondInteractionGroupPy	(	LsmMpiPy &	lsm,
		const std::string &	name
	)

Member Function Documentation

createInteraction()

void esys::lsm::BondInteractionGroupPy::createInteraction	(	int	id1,
		int	id2
	)

Creates a bond between particles with specified ID's.

Parameters

id1	Particle ID.
id2	Particle ID.

References createInteractions().

Referenced by esys::lsm::exportBondInteractionGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

createInteractions()

void esys::lsm::BondInteractionGroupPy::createInteractions

(

boost::python::object &

iterable

)

Creates bonds between specified pairs of particles.

Parameters

iterable

Sequence of particle ID pairs.

References esys::lsm::LsmMpiPy::createBonds(), esys::lsm::InteractionGroupPy::getLsm(), esys::lsm::InteractionGroupPy::getName(), esys::lsm::bpu::PythonIterIterator< TmplExtractType >::hasNext(), and esys::lsm::bpu::PythonIterIterator< TmplExtractType >::next().

Referenced by createInteraction(), and esys::lsm::exportBondInteractionGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

getIdPairSet()

ParticleIdPairSetPy esys::lsm::BondInteractionGroupPy::getIdPairSet

(

)

Return particle-id pairs indicating which particles are bonded to one another.

References esys::lsm::LsmMpiPy::getBondGroupIdPairs(), esys::lsm::InteractionGroupPy::getLsm(), and esys::lsm::InteractionGroupPy::getName().

Referenced by esys::lsm::exportBondInteractionGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Python/esys/lsm/BondInteractionGroupPy.h
• Python/esys/lsm/BondInteractionGroupPy.cpp