Package etomica.lattice

Class LatticeCubicSimple

java.lang.Object

etomica.lattice.BravaisLattice

etomica.lattice.LatticeCubicSimple

All Implemented Interfaces:

AbstractLattice<Vector>, CubicLattice, SpaceLattice

public class LatticeCubicSimple
extends BravaisLattice
implements CubicLattice

A simple cubic lattice, with one site per cubic unit cell.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
LatticeCubicSimple(Space space)	Simple 3D cubic lattice with a unit lattice constant.
LatticeCubicSimple(Space space, double latticeConstant)	Makes a simple cubic lattice of a spatial dimension given by the first argument, and with the given lattice constant.

Method Summary

Modifier and Type	Method	Description
int	getBasisSize()	Returns 1.
double	getLatticeConstant()	Accesses the size of the unit cell, the length of each edge of a single cell.
void	scaleBy(double scaleFactor)	Rescales the lattice by the given factor.
void	setLatticeConstant(double latticeConstant)	The lattice constant is the size of the cubic primitive vectors.
java.lang.String	toString()	Returns "Simple cubic".

Methods inherited from interface etomica.lattice.AbstractLattice

D

Methods inherited from class etomica.lattice.BravaisLattice

D, getLatticeConstants, getPrimitive, getSpace, setPrimitive, site

Methods inherited from class java.lang.Object

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

Methods inherited from interface etomica.lattice.SpaceLattice

getLatticeConstants, getSpace, site

Constructor Detail

LatticeCubicSimple

public LatticeCubicSimple(Space space)

Simple 3D cubic lattice with a unit lattice constant.

LatticeCubicSimple

public LatticeCubicSimple(Space space,
                          double latticeConstant)

Makes a simple cubic lattice of a spatial dimension given by the first argument, and with the given lattice constant.

Parameters:

space - : space of lattice; values of 2D or 3D are expected, 1D might also work

latticeConstant - spacing between adjacent lattice sites

Method Detail

setLatticeConstant

public void setLatticeConstant(double latticeConstant)

The lattice constant is the size of the cubic primitive vectors.

Specified by:

setLatticeConstant in interface CubicLattice

Parameters:

latticeConstant - the unit cell size

getLatticeConstant

public double getLatticeConstant()

Description copied from interface: CubicLattice

Accesses the size of the unit cell, the length of each edge of a single cell.

Specified by:

getLatticeConstant in interface CubicLattice

scaleBy

public void scaleBy(double scaleFactor)

Rescales the lattice by the given factor. Multiplies the lattice constant by the given value.

getBasisSize

public int getBasisSize()

Returns 1.

toString

public java.lang.String toString()

Returns "Simple cubic".

Overrides:

toString in class java.lang.Object