voronoi_number

Lattice.voronoi_number(

self: Lattice,

pos: Annotated[numpy.typing.ArrayLike, numpy.float64, '[3, 1]'],

) → int

Return the number of lattice points that pos is equally as close to as the origin

Parameters:

pos (array_like, shape=(3,)) – The position to check, in Cartesian coordinates.

Returns:

n – If n is 0, then pos is within the Voronoi cell and the origin is the nearest lattice site. If n is -1, then pos is outside the Voronoi cell and there is a lattice site closer than the origin. If n is in [1, 7], then pos is equally as close to n lattice sites as the origin.

Return type:

int