Package etomica.lattice

Interface SpaceLattice

All Superinterfaces:

AbstractLattice<Vector>

All Known Subinterfaces:

CubicLattice

All Known Implementing Classes:

BravaisLattice, BravaisLatticeCrystal, ConfigurationLattice.MyLattice, LatticeCubicBcc, LatticeCubicDiamond, LatticeCubicFcc, LatticeCubicSimple, LatticeHcp, LatticeHcp4, LatticeOrthorhombicHexagonal

public interface SpaceLattice
extends AbstractLattice<Vector>

Marker interface indicating that AbstractLattice.site(int[]) returns an IVector instance. No specification is made here regarding whether repeated calls will return the same IVector instance. However, repeated calls with the same int[] argument should return vectors that are equal to each other (assuming that the lattice is not modified between calls).

Method Summary

Modifier and Type	Method	Description
double[]	getLatticeConstants()
Space	getSpace()
Vector	site(int[] index)	Returns the site specified by the given index.

Methods inherited from interface etomica.lattice.AbstractLattice

D

Method Detail

site

Vector site(int[] index)

Description copied from interface: AbstractLattice

Returns the site specified by the given index. The number of integers in the index array must be equal to D, the lattice dimension. No specification is made here regarding the identity of the instance returned by this method. Thus repeated calls may return different object instances, or the same instance, regardless of the argument. The concrete implementations of this class should provide this specification.

Specified by:

site in interface AbstractLattice<Vector>

getSpace

Space getSpace()

getLatticeConstants

double[] getLatticeConstants()