Package etomica.atom

Interface AtomLeafAgentManager.AgentSource<E>

All Known Implementing Classes:

ActionMinimizeEnergy, AssociationManager, AtomTestChainLength, AtomTestChainLength, AtomTestLiquidAtomic, ChainEquilibriumSim, ChargeAgentSourceTIP4PWater, ColorSchemeCollectiveAgent, ColorSchemeCoordination, ColorSchemeNeighbor, ColorSchemeNeighborCell, ColorSchemeOverlap, ColorSchemeRadical, ColorSchemeRandom, ColorSchemeScaledOverlap, ColorSchemeSmer, CoordinateDefinition.SiteSource, CriterionPositionWall, CriterionSimple, DisplayBoxCanvas3DGlass, DisplayBoxCanvasG3DSys, DisplayBoxCanvasG3DSys.OrientedAgentSource, FreeRadicalPolymerizationSim, HSNPT.ActionSummer, IntegratorDimerRT, IntegratorDroplet, IntegratorFixedWall, IntegratorGear4, IntegratorHard, IntegratorHardMDMC, IntegratorHardPiston, IntegratorImageHarmonicMD, IntegratorImageMultistepMD, IntegratorMD.VectorSource, IntegratorMDHarmonicMC, IntegratorRigidIterative, IntegratorVelocityVerlet, IntegratorVelocityVerletSAM, IntegratorVerlet, InteractionTracker, MCMoveVolumeAssociated, MeterChainLength, MeterDipoleMoment, MeterMappedAveraging, MeterMappedAveraging3Pair, MeterMappedAveragingCorrelation, MeterMappedAveragingFreeEnergy, MeterMappedAveragingPair, MeterMappedAveragingPairExcess, MeterMappedAveragingSum, MeterMappedAveragingVSum, MeterMappedAveragingVSum3Pair, MeterMappedAveragingVSumPair, MeterMappedRdf, MeterMeanField, MinimizationTIP4P.ChargeAgentSourceRPM, NeighborCellManager, NeighborListManager, NeighborListManager.AtomPotential1ListSource, NeighborListManagerColloid, NeighborListManagerSlanty, NeighborSiteManager, P1Tether, P2HardBondedList, P2SquareWellRobust, PotentialCalculationMeanField, ReactionEquilibrium

Enclosing class:

AtomLeafAgentManager<E>

public static interface AtomLeafAgentManager.AgentSource<E>

Interface for an object that wants an agent associated with each Atom in a Box.

Method Summary

Modifier and Type	Method	Description
E	makeAgent(IAtom a, Box agentBox)	Returns an agent for the given Atom.
void	releaseAgent(E agent, IAtom atom, Box agentBox)	This informs the agent source that the agent is going away and that the agent source should disconnect the agent from other elements.

Method Detail

makeAgent

E makeAgent(IAtom a,
            Box agentBox)

Returns an agent for the given Atom. The agentBox is provided for convenience for agent sources that handle multiple boxes.

Parameters:

agentBox - TODO

releaseAgent

void releaseAgent(E agent,
                  IAtom atom,
                  Box agentBox)

This informs the agent source that the agent is going away and that the agent source should disconnect the agent from other elements. The agentBox is provided for convenience for agent sources that handle multiple boxes.