Package etomica.lattice

Class BravaisLatticeCrystal

java.lang.Object

etomica.lattice.BravaisLattice

etomica.lattice.BravaisLatticeCrystal

All Implemented Interfaces:

AbstractLattice<Vector>, SpaceLattice

Direct Known Subclasses:

LatticeCubicBcc, LatticeCubicDiamond, LatticeCubicFcc, LatticeHcp, LatticeHcp4, LatticeOrthorhombicHexagonal

public class BravaisLatticeCrystal
extends BravaisLattice

A lattice with sites given by the "atom" sites of a crystal. Sites of this lattice are instances of Vector. The dimension of a BravaisLatticeCrystal is one more than the dimension of the underlying Bravais lattice forming the crystal; the extra index specifies the basis atom at the site referenced by the other indices.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Basis	basis

Fields inherited from class etomica.lattice.BravaisLattice

primitive

Constructor Summary

Constructors

Constructor	Description
BravaisLatticeCrystal(Primitive primitive, Basis basis)	Constructs a lattice having sites given by the "atom" sites of the given crystal.

Method Summary

Modifier and Type	Method	Description
int	D()	Returns the spatial dimension + 1.
Basis	getBasis()
Vector	site(int[] index)	Returns a Vector instance giving the location of the referenced site.

Methods inherited from class etomica.lattice.BravaisLattice

getLatticeConstants, getPrimitive, getSpace, setPrimitive

Methods inherited from class java.lang.Object

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

Field Detail

basis

protected final Basis basis

Constructor Detail

BravaisLatticeCrystal

public BravaisLatticeCrystal(Primitive primitive,
                             Basis basis)

Constructs a lattice having sites given by the "atom" sites of the given crystal. Note: the positions defined by the Basis are specified in the coordinate system of the given primitive, which typically will not be the rectangular cartesian coordinates. This will cause the basis to in effect be rescaled when the primitive is resized.

Method Detail

D

public int D()

Returns the spatial dimension + 1. The extra index specifies the basis atom.

Specified by:

D in interface AbstractLattice<Vector>

Overrides:

D in class BravaisLattice

site

public Vector site(int[] index)

Returns a Vector instance giving the location of the referenced site. The first D-1 indices indicate the Bravais-lattice position, and the last index specifies the basis atom at the Bravais site. The same Vector instance is returned with each call.

Specified by:

site in interface AbstractLattice<Vector>

Specified by:

site in interface SpaceLattice

Overrides:

site in class BravaisLattice

getBasis

public Basis getBasis()