Package etomica.lattice

Class RectangularLatticeNbrIteratorSquare

java.lang.Object

etomica.lattice.RectangularLatticeNbrIterator

etomica.lattice.RectangularLatticeNbrIteratorSquare

All Implemented Interfaces:

SiteIterator

Direct Known Subclasses:

CellLattice.NeighborIterator

public class RectangularLatticeNbrIteratorSquare
extends RectangularLatticeNbrIterator

Iterates over neighbors of a site, where neighbors are defined as those sites lying in a rectangular region centered on the site.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	furthestNeighborDelta
protected int	halfNeighborCount
protected int[]	range

Fields inherited from class etomica.lattice.RectangularLatticeNbrIterator

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

Constructor Summary

Constructors

Constructor	Description
RectangularLatticeNbrIteratorSquare(int D)

Method Summary

Modifier and Type	Method	Description
int[]	getRange()	Returns (a copy of) the array specifying the neighbor range.
static void	main(java.lang.String[] args)	Method to test the neighbor iterator.
void	setLattice(FiniteLattice newLattice)	Sets the lattice from which the iterates are given.
void	setRange(int[] newRange)	Sets the range used to define the neighboring sites.
protected void	updateNeighborList()	Method called on reset if any calls were previously made to setLattice, setSite, setRange, or setDirection.

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, setPeriodicity, setSite, size, unset

Field Detail

range

protected final int[] range

furthestNeighborDelta

protected int furthestNeighborDelta

halfNeighborCount

protected int halfNeighborCount

Constructor Detail

RectangularLatticeNbrIteratorSquare

public RectangularLatticeNbrIteratorSquare(int D)

Parameters:

D -

Method Detail

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 -

updateNeighborList

protected void updateNeighborList()

Method called on reset if any calls were previously made to setLattice, setSite, setRange, or setDirection.

Specified by:

updateNeighborList in class RectangularLatticeNbrIterator

setLattice

public void setLattice(FiniteLattice newLattice)

Description copied from class: RectangularLatticeNbrIterator

Sets the lattice from which the iterates are given. Dimension of lattice must be the same as that specified to constructor. Also, size of lattice must be compatible with range of neighbor interactions.

Specified by:

setLattice in interface SiteIterator

Overrides:

setLattice in class RectangularLatticeNbrIterator

getRange

public int[] getRange()

Returns (a copy of) the array specifying the neighbor range.

setRange

public void setRange(int[] newRange)

Sets the range used to define the neighboring sites. Each of the values in newRange is used to determine the size of the neighbor box in the corresponding dimension: (edge length) = 2*value + 1, as the value describes the neighbor distance in each direction (e.g., left and right) from the Non-negative values (including zero) are acceptable, to a maximum of (lattice dimension - 1)/2, beyond which the neighbor distances extend beyond the size of the lattice. An IllegalArgumentException is thrown if any index is outside its acceptable range. A copy of the newRange array is made, so it may be re-used elsewhere after calling this method.