Package etomica.lattice.crystal

Class PrimitiveGeneral

java.lang.Object

etomica.lattice.crystal.Primitive

etomica.lattice.crystal.PrimitiveGeneral

public class PrimitiveGeneral
extends Primitive

Primitive defined simply by its vectors. Cannot be modified by setting size or angle.

See Also:

Serialized Form

Field Summary

Fields inherited from class etomica.lattice.crystal.Primitive

angle, D, idx, latticeVectors, rightAngle, size, space

Constructor Summary

Constructors

Constructor	Description
PrimitiveGeneral(Space space, Vector[] primitiveVectors)

Method Summary

Modifier and Type	Method	Description
Primitive	copy()	Returns a new, identical instance of this primitive.
int[]	latticeIndex(Vector r)	Returns the index which would give the unit cell containing the given point if the index were passed to a the site method of a sufficiently large lattice that uses this primitive.
int[]	latticeIndex(Vector r, int[] dimensions)	Same as latticeIndex(Space.Vector), but gives index for periodic system with number of unit cells in each direction as given by the dimensions array.
Primitive	makeReciprocal()	Method defining and constructing reciprocal primitive;
void	scaleSize(double scale)	Scales (multiplies) the size of each primitive vector by the given value.
protected void	update()
Polytope	wignerSeitzCell()	Returns the Wigner-Seitz cell specified by this primitive.

Methods inherited from class java.lang.Object

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

Methods inherited from class etomica.lattice.crystal.Primitive

getSize, getSpace, setAngles, setSize, unitCell, vectors

Constructor Detail

PrimitiveGeneral

public PrimitiveGeneral(Space space,
                        Vector[] primitiveVectors)

Method Detail

copy

public Primitive copy()

Description copied from class: Primitive

Returns a new, identical instance of this primitive.

Specified by:

copy in class Primitive

latticeIndex

public int[] latticeIndex(Vector r)

Description copied from class: Primitive

Returns the index which would give the unit cell containing the given point if the index were passed to a the site method of a sufficiently large lattice that uses this primitive.

Specified by:

latticeIndex in class Primitive

latticeIndex

public int[] latticeIndex(Vector r,
                          int[] dimensions)

Description copied from class: Primitive

Same as latticeIndex(Space.Vector), but gives index for periodic system with number of unit cells in each direction as given by the dimensions array. If lattice index corresponds to a cell outside the range of dimensions, index of image in central cells is returned.

Specified by:

latticeIndex in class Primitive

makeReciprocal

public Primitive makeReciprocal()

Description copied from class: Primitive

Method defining and constructing reciprocal primitive;

Specified by:

makeReciprocal in class Primitive

scaleSize

public void scaleSize(double scale)

Description copied from class: Primitive

Scales (multiplies) the size of each primitive vector by the given value.

Specified by:

scaleSize in class Primitive

update

protected void update()

Specified by:

update in class Primitive

wignerSeitzCell

public Polytope wignerSeitzCell()

Description copied from class: Primitive

Returns the Wigner-Seitz cell specified by this primitive. The returned cell does not remain tied to the primitive, and will not be updated with changes to the primitive.

Specified by:

wignerSeitzCell in class Primitive