Package etomica.lattice

Class BravaisLattice

java.lang.Object

etomica.lattice.BravaisLattice

All Implemented Interfaces:

AbstractLattice<Vector>, SpaceLattice, java.io.Serializable

Direct Known Subclasses:

BravaisLatticeCrystal, LatticeCubicSimple

public class BravaisLattice
extends java.lang.Object
implements SpaceLattice, java.io.Serializable

Arbitrary-dimension Bravais Lattice, in which the sites are instances of etomica.space.Vector, with positions given as linear combinations of a set of primitive vectors.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Primitive	primitive

Constructor Summary

Constructors

Constructor	Description
BravaisLattice(Primitive primitive)

Method Summary

Modifier and Type	Method	Description
int	D()	Dimension of the lattice.
double[]	getLatticeConstants()
Primitive	getPrimitive()	Returns the primitive object used to construct this lattice.
Space	getSpace()
void	setPrimitive(Primitive primitive)	Sets the primitive for this lattice to the one given, and updates the site positions.
Vector	site(int[] index)	Calculates and returns a vector that is the spatial position given by adding together the primitive vectors, each multiplied by the corresponding integer index given by the array argument.

Methods inherited from class java.lang.Object

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

Field Detail

primitive

protected Primitive primitive

Constructor Detail

BravaisLattice

public BravaisLattice(Primitive primitive)

Method Detail

D

public 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<Vector>

getSpace

public Space getSpace()

Specified by:

getSpace in interface SpaceLattice

site

public Vector site(int[] index)

Calculates and returns a vector that is the spatial position given by adding together the primitive vectors, each multiplied by the corresponding integer index given by the array argument. The returned object is an instance of Vector, and the same instance is returned with every call. The returned vector is configured on-the-fly from the the lattice primitive and the given index. Index may comprise any integer values (positive, negative, or zero).

Specified by:

site in interface AbstractLattice<Vector>

Specified by:

site in interface SpaceLattice

setPrimitive

public void setPrimitive(Primitive primitive)

Sets the primitive for this lattice to the one given, and updates the site positions.

getPrimitive

public Primitive getPrimitive()

Returns the primitive object used to construct this lattice. The returned object is not a clone, and changes to it will affect the lattice.

getLatticeConstants

public double[] getLatticeConstants()

Specified by:

getLatticeConstants in interface SpaceLattice