Package etomica.lattice

Class RectangularLatticeNbrIteratorAdjacent

java.lang.Object

etomica.lattice.RectangularLatticeNbrIterator

etomica.lattice.RectangularLatticeNbrIteratorAdjacent

All Implemented Interfaces:

SiteIterator

public class RectangularLatticeNbrIteratorAdjacent
extends RectangularLatticeNbrIterator

Iterates over the neighbors of a site, where neighbors are those sites immediately adjacent to it in each direction; this does not include sites diagonal to the site. In D dimensions, there are 2D such neighbors. The neighbor definition may or may not be defined as obeying periodicity, as desired.

See Also:

Serialized Form

Field Summary

Fields inherited from class etomica.lattice.RectangularLatticeNbrIterator

cursor, D, doDown, doUp, isPeriodic, lattice, needNeighborUpdate, neighborCount, neighbors

Constructor Summary

Constructors

Constructor	Description
RectangularLatticeNbrIteratorAdjacent(int D)

Method Summary

Modifier and Type	Method	Description
static void	main(java.lang.String[] args)	Method to test the neighbor iterator.
protected void	updateNeighborList()

Methods inherited from class java.lang.Object

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

Methods inherited from class etomica.lattice.RectangularLatticeNbrIterator

D, getDirection, getLattice, hasNext, next, nextIndex, peek, reset, setDirection, setLattice, setPeriodicity, setSite, size, unset

Constructor Detail

RectangularLatticeNbrIteratorAdjacent

public RectangularLatticeNbrIteratorAdjacent(int D)

Parameters:

D -

Method Detail

updateNeighborList

protected void updateNeighborList()

Specified by:

updateNeighborList in class RectangularLatticeNbrIterator

main

public static void main(java.lang.String[] args)

Method to test the neighbor iterator. Constructs a lattice with sites defined to hold a color. Configures iterator, loops over neighbor sites and defines up/down neighbors to have colors yellow and blue, respectively. Then puts up a window with the lattice drawn as an array of squares, with central site colored red and with neighbor sites identified by their colors. 3-D lattice is shown with a set of slices through the planes in the 3rd dimension.

Parameters:

args -