Package etomica.association

Class AssociationHelperSingle

java.lang.Object

etomica.association.AssociationHelperSingle

All Implemented Interfaces:

IAssociationHelper

public class AssociationHelperSingle
extends java.lang.Object
implements IAssociationHelper

AssociationHelperSingle is capable of populating a list of atoms in an smer within a simulation with single-bonding (one bonding site per atom). AssociationHelperSingle verifies that each atom has (at most) one bond, and that the reverse bonding info is consistent (bond[A] = B, bond[B] = A). Each smer might be a monomer or a dimer.

Field Summary

Fields

Modifier and Type	Field	Description
protected AssociationManager	associationManager

Constructor Summary

Constructors

Constructor	Description
AssociationHelperSingle(AssociationManager associationManager)

Method Summary

Modifier and Type	Method	Description
boolean	populateList(AtomArrayList mySmerList, IAtom atom, boolean mightBeBroken)	Populates smerList with all atoms in the smer that contains atom.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

associationManager

protected final AssociationManager associationManager

Constructor Detail

AssociationHelperSingle

public AssociationHelperSingle(AssociationManager associationManager)

Method Detail

populateList

public boolean populateList(AtomArrayList mySmerList,
                            IAtom atom,
                            boolean mightBeBroken)

Description copied from interface: IAssociationHelper

Populates smerList with all atoms in the smer that contains atom. If mightBeBroken is false, an exception is throw if any invalid bonding is encountered (along with potentially useful information about the invalid bonding). If mightBeBroken is true, then populateList returns true if any invalid bonding is encountered. populateList returns false if invalid bonding is not encountered.

Specified by:

populateList in interface IAssociationHelper