Package etomica.action

Class ActionMinimizeEnergy

java.lang.Object

etomica.action.ActionMinimizeEnergy

All Implemented Interfaces:

IAction, AtomLeafAgentManager.AgentSource<ActionMinimizeEnergy.MyForceTorque>

public class ActionMinimizeEnergy
extends java.lang.Object
implements IAction, AtomLeafAgentManager.AgentSource<ActionMinimizeEnergy.MyForceTorque>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ActionMinimizeEnergy.MyForceTorque

Field Summary

Fields

Modifier and Type	Field	Description
protected AtomLeafAgentManager<ActionMinimizeEnergy.MyForceTorque>	agentManager
protected Box	box
protected IteratorDirective	id
protected int	maxSteps
protected PotentialCalculationTorqueSum	pc
protected PotentialMaster	potentialMaster
protected Space	space
protected double	tolerance

Constructor Summary

Constructors

Constructor	Description
ActionMinimizeEnergy(Space space, int maxSteps, PotentialMaster potentialMaster, Box box)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed()	Completes the action defined by the class implementing this interface.
Box	getBox()
double	getTolerance()
ActionMinimizeEnergy.MyForceTorque	makeAgent(IAtom atom, Box box)	Returns an agent for the given Atom.
void	releaseAgent(ActionMinimizeEnergy.MyForceTorque agent, IAtom atom, Box box)	This informs the agent source that the agent is going away and that the agent source should disconnect the agent from other elements.
void	setTolerance(double newTolerance)
protected void	takeStep(Vector[] direction, Vector[] rotationDirection, double stepSize)

Methods inherited from class java.lang.Object

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

Field Detail

maxSteps

protected final int maxSteps

box

protected final Box box

potentialMaster

protected final PotentialMaster potentialMaster

pc

protected final PotentialCalculationTorqueSum pc

agentManager

protected final AtomLeafAgentManager<ActionMinimizeEnergy.MyForceTorque> agentManager

space

protected final Space space

id

protected final IteratorDirective id

tolerance

protected double tolerance

Constructor Detail

ActionMinimizeEnergy

public ActionMinimizeEnergy(Space space,
                            int maxSteps,
                            PotentialMaster potentialMaster,
                            Box box)

Method Detail

getTolerance

public double getTolerance()

setTolerance

public void setTolerance(double newTolerance)

takeStep

protected void takeStep(Vector[] direction,
                        Vector[] rotationDirection,
                        double stepSize)

actionPerformed

public void actionPerformed()

Description copied from interface: IAction

Completes the action defined by the class implementing this interface.

Specified by:

actionPerformed in interface IAction

getBox

public Box getBox()

releaseAgent

public void releaseAgent(ActionMinimizeEnergy.MyForceTorque agent,
                         IAtom atom,
                         Box box)

Description copied from interface: AtomLeafAgentManager.AgentSource

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.

Specified by:

releaseAgent in interface AtomLeafAgentManager.AgentSource<ActionMinimizeEnergy.MyForceTorque>

makeAgent

public ActionMinimizeEnergy.MyForceTorque makeAgent(IAtom atom,
                                                    Box box)

Description copied from interface: AtomLeafAgentManager.AgentSource

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

Specified by:

makeAgent in interface AtomLeafAgentManager.AgentSource<ActionMinimizeEnergy.MyForceTorque>

box - TODO