Package etomica.lattice

Class RectangularLattice

java.lang.Object

etomica.lattice.RectangularLattice

All Implemented Interfaces:

AbstractLattice<T>, FiniteLattice

Direct Known Subclasses:

CellLattice

public class RectangularLattice
extends java.lang.Object
implements FiniteLattice

Basic implementation of the AbstractLattice interface, providing construction and access of sites for a lattice of arbitrary dimension. Lattice is retangular in the sense that the size in one dimension does not depend on the index in another dimension (e.g., it cannot be triangular).

RectangularLatticeNbrIterator defines a configurable neighbor iterator that returns the sites it defines as neighbors of a given site.

See Also:

RectangularLatticeNbrIterator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RectangularLattice.Iterator	Iterates over all sites of the lattice.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	d
protected int[]	jumpCount
protected SiteFactory	siteFactory
protected java.lang.Object[]	sites
protected int[]	size

Constructor Summary

Constructors

Constructor	Description
RectangularLattice(int D, SiteFactory siteFactory)	Constructs a lattice of the given dimension (D) with sites made from the given factory.

Method Summary

Modifier and Type	Method	Description
int	arrayIndex(int[] index)	Returns the index in the 1-d array for the site corresponding to the given lattice index.
int	D()	Dimension of the lattice.
int[][]	getDownNeighbors()
int[]	getSize()	Returns an array with elements giving the maximum number of index values in each dimension.
int[][]	getUpNeighbors()
protected void	increment(int[] idx)
int[]	latticeIndex(int index)	Returns the lattice index given the 1-d array index; reverses the effect of arrayIndex method.
void	latticeIndex(int index, int[] latticeIndex)
void	setNeighborRange(double neighborRange)
void	setPeriodicity(boolean[] periodicity)
void	setSize(int[] newSize)	Sets the number lattice size (specified via the largest index in each dimension), and rebuilds the all sites using the site factory.
java.lang.Object	site(int[] index)	Returns the instance of the object associated with the given index.
java.lang.Object[]	sites()	Returns an array containing all the sites in the lattice.

Methods inherited from class java.lang.Object

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

Field Detail

size

protected final int[] size

jumpCount

protected final int[] jumpCount

d

protected final int d

sites

protected java.lang.Object[] sites

siteFactory

protected SiteFactory siteFactory

Constructor Detail

RectangularLattice

public RectangularLattice(int D,
                          SiteFactory siteFactory)

Constructs a lattice of the given dimension (D) with sites made from the given factory. Upon construction, lattice contains no sites; these are created when setSize is invoked.

Method Detail

setPeriodicity

public void setPeriodicity(boolean[] periodicity)

getUpNeighbors

public int[][] getUpNeighbors()

getDownNeighbors

public int[][] getDownNeighbors()

D

public final int D()

Description copied from interface: AbstractLattice

Dimension of the lattice. The value of D describes the number of integers needed to specify a site (via the site method).

Specified by:

D in interface AbstractLattice<T>

sites

public java.lang.Object[] sites()

Description copied from interface: FiniteLattice

Returns an array containing all the sites in the lattice.

Specified by:

sites in interface FiniteLattice

site

public java.lang.Object site(int[] index)

Returns the instance of the object associated with the given index. Repeated calls with the same index will return the same instance, and calls with different indexes will return different instances.

Specified by:

site in interface AbstractLattice<T>

arrayIndex

public final int arrayIndex(int[] index)

Returns the index in the 1-d array for the site corresponding to the given lattice index.

latticeIndex

public int[] latticeIndex(int index)

Returns the lattice index given the 1-d array index; reverses the effect of arrayIndex method.

latticeIndex

public void latticeIndex(int index,
                         int[] latticeIndex)

getSize

public final int[] getSize()

Description copied from interface: FiniteLattice

Returns an array with elements giving the maximum number of index values in each dimension. If size[i] = k, then permissible values of index[i] are in the range (0, k-1) inclusive, where index is the index array given to the site method of AbstractLattice.

Specified by:

getSize in interface FiniteLattice

setSize

public void setSize(int[] newSize)

Sets the number lattice size (specified via the largest index in each dimension), and rebuilds the all sites using the site factory.

Specified by:

setSize in interface FiniteLattice

Parameters:

newSize - array giving the number of index values in each dimension

Throws:

java.lang.IllegalArgumentException - if length of given array is not equal to D

increment

protected void increment(int[] idx)

setNeighborRange

public void setNeighborRange(double neighborRange)