Package etomica.lattice

Class CellLattice.NeighborIterator

java.lang.Object

etomica.lattice.RectangularLatticeNbrIterator

etomica.lattice.RectangularLatticeNbrIteratorSquare

etomica.lattice.CellLattice.NeighborIterator

All Implemented Interfaces:

SiteIterator

Enclosing class:

CellLattice

public static class CellLattice.NeighborIterator
extends RectangularLatticeNbrIteratorSquare

Extends the SimpleLattice neighbor iterator to provide methods that specify the neighbor range in terms of a distance, rather than an index range.

See Also:

Serialized Form

Field Summary

Fields inherited from class etomica.lattice.RectangularLatticeNbrIterator

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

Fields inherited from class etomica.lattice.RectangularLatticeNbrIteratorSquare

furthestNeighborDelta, halfNeighborCount, range

Constructor Summary

Constructors

Constructor	Description
NeighborIterator(int D, double range)

Method Summary

Modifier and Type	Method	Description
void	checkDimensions()	Checks whether lattice dimensions have changed, and updates integer neighbor range if they have.
double	getNeighborDistance()
void	reset()	Resets the iterator to loop through its iterates again.
void	setLattice(FiniteLattice lattice)	Sets the lattice from which the iterates are given.
void	setNeighborDistance(double newNeighborDistance)	Defines neighbors to be all cells that are within the given distance from a central cell.

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

Methods inherited from class etomica.lattice.RectangularLatticeNbrIteratorSquare

getRange, main, setRange, updateNeighborList

Constructor Detail

NeighborIterator

public NeighborIterator(int D,
                        double range)

Method Detail

setLattice

public void setLattice(FiniteLattice lattice)

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 RectangularLatticeNbrIteratorSquare

getNeighborDistance

public double getNeighborDistance()

setNeighborDistance

public void setNeighborDistance(double newNeighborDistance)

Defines neighbors to be all cells that are within the given distance from a central cell. Specifically, the integer range in direction j is 1 + (int)(neighborDistance/cellSize[j]).

reset

public void reset()

Description copied from class: RectangularLatticeNbrIterator

Resets the iterator to loop through its iterates again. This must be done after any call to setRange, setDirection, or setSite.

Specified by:

reset in interface SiteIterator

Overrides:

reset in class RectangularLatticeNbrIterator

checkDimensions

public void checkDimensions()

Checks whether lattice dimensions have changed, and updates integer neighbor range if they have.