Package etomica.nbr.site

Class NeighborSiteManager

java.lang.Object

etomica.nbr.site.NeighborSiteManager

All Implemented Interfaces:

AtomLeafAgentManager.AgentSource<AtomSite>, BoxCellManager

public class NeighborSiteManager
extends java.lang.Object
implements BoxCellManager, AtomLeafAgentManager.AgentSource<AtomSite>

Neighbor manager for system in which there is an unchanging, one-to-one correspondence between atoms and lattice cells. Each leaf atom is assigned to its own cell at the beginning of the simulation, and the cell-atom assignment doesn't change through the course of the simulation. Atom neighbors are determined by the structure and neighbor definition associated with the cell lattice, and do not change through the simulation.

The expected use for this neighbor structure is in modeling of lattice systems such as the Ising model in which the coordinate represents something other than the spatial position of the atom; can also be applied to diffusionless crystalline solids, such as the valence-force field model, single-occupancy crystals, and perhaps high-density unconstrained crystals.

Constructor Summary

Constructors

Constructor	Description
NeighborSiteManager(Box box, int nCells)	Constructs manager for neighbor cells in the given box.

Method Summary

Modifier and Type	Method	Description
void	assignCellAll()	Should not be called, because cell assignments are made as atoms are created.
CellLattice	getLattice()	Returns the lattice used to define the neighbor structure.
AtomSite	getSite(IAtom atom)
AtomSite	makeAgent(IAtom atom, Box agentBox)	Returns an agent for the given Atom.
void	releaseAgent(AtomSite 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

NeighborSiteManager

public NeighborSiteManager(Box box,
                           int nCells)

Constructs manager for neighbor cells in the given box. The number of cells in each dimension is given by nCells. Position definition for each atom is that given by its type (it is set to null in this class).

Method Detail

getLattice

public CellLattice getLattice()

Returns the lattice used to define the neighbor structure.

Specified by:

getLattice in interface BoxCellManager

assignCellAll

public void assignCellAll()

Should not be called, because cell assignments are made as atoms are created.

Specified by:

assignCellAll in interface BoxCellManager

Throws:

java.lang.RuntimeException - if invoked

getSite

public AtomSite getSite(IAtom atom)

makeAgent

public AtomSite makeAgent(IAtom atom,
                          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<AtomSite>

agentBox - TODO

releaseAgent

public void releaseAgent(AtomSite 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<AtomSite>