Package etomica.spin.heisenberg

Class PotentialCalculationMeanField

java.lang.Object

etomica.spin.heisenberg.PotentialCalculationMeanField

All Implemented Interfaces:

AtomLeafAgentManager.AgentSource<Vector>, PotentialCalculation

public class PotentialCalculationMeanField
extends java.lang.Object
implements PotentialCalculation, AtomLeafAgentManager.AgentSource<Vector>

Potential Calculation for mean field

Field Summary

Fields

Modifier and Type	Field	Description
protected double	J2
protected AtomLeafAgentManager<Vector>	leafAgentManager
protected Space	space

Constructor Summary

Constructors

Constructor	Description
PotentialCalculationMeanField(Space space, double J, Box box)

Method Summary

Modifier and Type	Method	Description
void	doCalculation(IAtomList atoms, IPotentialAtomic potential)	Method giving the specific calculation performed by this class.
AtomLeafAgentManager<Vector>	getAgentManager()
Vector	makeAgent(IAtom a, Box agentBox)	Returns an agent for the given Atom.
void	releaseAgent(Vector 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.
void	reset()

Methods inherited from class java.lang.Object

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

Field Detail

J2

protected final double J2

space

protected final Space space

leafAgentManager

protected AtomLeafAgentManager<Vector> leafAgentManager

Constructor Detail

PotentialCalculationMeanField

public PotentialCalculationMeanField(Space space,
                                     double J,
                                     Box box)

Method Detail

doCalculation

public void doCalculation(IAtomList atoms,
                          IPotentialAtomic potential)

Description copied from interface: PotentialCalculation

Method giving the specific calculation performed by this class.

Specified by:

doCalculation in interface PotentialCalculation

Parameters:

atoms - IAtomSet the atom sets for which the calculation is performed.

potential - The potential used to apply the action defined by this class.

reset

public void reset()

getAgentManager

public AtomLeafAgentManager<Vector> getAgentManager()

makeAgent

public Vector makeAgent(IAtom a,
                        Box agentBox)

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<Vector>

agentBox - TODO

releaseAgent

public void releaseAgent(Vector agent,
                         IAtom atom,
                         Box agentBox)

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<Vector>