Package etomica.integrator

Class IntegratorHard.Agent

java.lang.Object

etomica.integrator.IntegratorHard.Agent

Enclosing class:

IntegratorHard

public static class IntegratorHard.Agent
extends java.lang.Object

Agent defined by this integrator. Holds information about the time to next collision (considering only atoms uplist of the atom), the collisionPartner (atom that this one will be colliding with), and a handle to the potential governing the interactions of this atom and its collision partner (this is kept for convenience, so it won't have to be determined again when the collision is processed).

Field Summary

Fields

Modifier and Type	Field	Description
IAtomKinetic	atom
protected AtomSetSinglet	atomSetSinglet
IAtomKinetic	collisionPartner
PotentialHard	collisionPotential
TreeLinker	eventLinker
protected IntegratorHard	integrator
protected double	nullCollisionTime
protected PotentialHard	nullPotential

Constructor Summary

Constructors

Constructor	Description
Agent(IAtomKinetic a, IntegratorHard integrator)

Method Summary

Modifier and Type	Method	Description
IAtomKinetic	atom()
IAtomKinetic	collisionPartner()
double	collisionTime()	Accessor method for the time to next collision of this atom
void	decrementCollisionTime(double interval)	Decreases the recorded time to collision of this atom This action is performed when the atom is advanced without a collision
void	resetCollision()	resets collision potential and partner.
void	resetCollisionFull()	resets time, potential and partner.
void	setCollision(double time, IAtomKinetic partner, PotentialHard p)	Sets parameters associated with next two-body collision of this atom with another atom.
void	setNullPotential(PotentialHard newNullPotential)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

integrator

protected final IntegratorHard integrator

atom

public IAtomKinetic atom

collisionPartner

public IAtomKinetic collisionPartner

collisionPotential

public PotentialHard collisionPotential

eventLinker

public TreeLinker eventLinker

nullPotential

protected PotentialHard nullPotential

atomSetSinglet

protected AtomSetSinglet atomSetSinglet

nullCollisionTime

protected double nullCollisionTime

Constructor Detail

Agent

public Agent(IAtomKinetic a,
             IntegratorHard integrator)

Method Detail

setNullPotential

public void setNullPotential(PotentialHard newNullPotential)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

atom

public final IAtomKinetic atom()

collisionPartner

public final IAtomKinetic collisionPartner()

resetCollision

public void resetCollision()

resets collision potential and partner. If a null potnetial is in use, the time is reset to the null potential collision time. caller should remove eventLinker from the tree if needed before calling this method.

resetCollisionFull

public void resetCollisionFull()

resets time, potential and partner. caller should remove eventLinker from the tree if needed before calling this method.

setCollision

public final void setCollision(double time,
                               IAtomKinetic partner,
                               PotentialHard p)

Sets parameters associated with next two-body collision of this atom with another atom.

Parameters:

time - time to collision of this agent's atom with an atom uplist of it

partner - the atom this one will collide with next

p - the potential for interactions between this atom and its collision partner

decrementCollisionTime

public final void decrementCollisionTime(double interval)

Decreases the recorded time to collision of this atom This action is performed when the atom is advanced without a collision

collisionTime

public final double collisionTime()

Accessor method for the time to next collision of this atom