etomica.lattice

Class CellLattice

java.lang.Object

etomica.lattice.RectangularLattice

etomica.lattice.CellLattice

All Implemented Interfaces:

AbstractLattice, FiniteLattice, java.io.Serializable

public class CellLattice
extends RectangularLattice

A lattice of arbitrarily-sized rectangular cells, such that a point in space can be associated with one of the cells.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CellLattice.NeighborIterator Extends the SimpleLattice neighbor iterator to provide methods that specify the neighbor range in terms of a distance, rather than an index range.

Nested classes/interfaces inherited from class etomica.lattice.RectangularLattice

RectangularLattice.Iterator

Field Summary

Fields inherited from class etomica.lattice.RectangularLattice

D, jumpCount, siteFactory, sites, size

Constructor Summary

Constructors

Constructor and Description
CellLattice(ISpace space, IVector dimVector, SiteFactory siteFactory)

Method Summary

Modifier and Type	Method and Description
double[]	getCellSize() Returns the spatial dimensions of all cells in the lattice, such that a cell in the lattice will have a size in each direction as given by the corresponding value in the returned array.
IVector	getDimensions() Returns the array that specifies the spatial dimensions of the lattice of cells.
void	setDimensions(IVector d)
java.lang.Object	site(IVector r) Returns the cell in which the given point lies.

Methods inherited from class etomica.lattice.RectangularLattice

arrayIndex, D, getSize, increment, latticeIndex, latticeIndex, setSize, site, sites

Methods inherited from class java.lang.Object

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

Constructor Detail

CellLattice

public CellLattice(ISpace space,
                   IVector dimVector,
                   SiteFactory siteFactory)

Parameters:

dimensions - the spatial dimensions of the lattice, such that the total space occupied by the lattice cells a rectangular box with each side of length dimensions.x(i)/size[i] for side i. The dimensions at any time are given by the array passed here, so any changes to the array external to this class will result in a change in the dimensions of this lattice (this is useful in resizing the lattice to the dimensions of a box, by giving a reference to box.boundary().dimension() here). The dimensions array reference is final and cannot be changed . The lattice dimension D is given by dimensions.length.

siteFactory - makes the sites of the lattice

Method Detail

site

public java.lang.Object site(IVector r)

Returns the cell in which the given point lies. An ArrayIndexOutOfBounds exception is thrown if the point lies outside the bounds of the lattice (less than zero or greater than dimensions). The dimension of the vector is assumed to be consistent with the dimension D of the lattice (i.e., r.D() == this.D()) but this is not checked.

getDimensions

public IVector getDimensions()

Returns the array that specifies the spatial dimensions of the lattice of cells.

setDimensions

public void setDimensions(IVector d)

getCellSize

public double[] getCellSize()

Returns the spatial dimensions of all cells in the lattice, such that a cell in the lattice will have a size in each direction as given by the corresponding value in the returned array. Value is computed on-the-fly using current value of dimensions and size.