ppmd.utility.lattice module

Tools to create numpy arrays containing lattices

ppmd.utility.lattice.cubic_lattice(n, e)

Create a cubic lattice of points centred on the origin. Dimension is determined by the length of the passed tuples.

Parameters
  • n – (n0, n1, n2 …) Number of points in each dimension

  • e – (e0, e1, e2, …) Extent of domain in each dimension

Returns

Numpy array of points.

ppmd.utility.lattice.fcc(n, e)

Create an FCC lattice, centred on the origin. Dimension is fixed at three. This function generates a lattice by using a base image consisting of a corner atom and three atoms in the centres of the adjacent faces.

Assumes n0, n1, n2 are greater than 1.

Parameters
  • n – (n0, n1, n2) Number of unit images in each dimension.

  • e – (e0, e1, e2) Extent of domain in each dimension.

Returns

Numpy array of points.

ppmd.utility.lattice.nested_iterator(low, high)