netket.graph.Kagome

Contents

netket.graph.Kagome#

class netket.graph.Kagome[source]#

Bases:

Constructs a kagome lattice of a given spatial extent. Periodic boundary conditions can also be imposed. Sites are returned at the 3c Wyckoff positions.

Parameters:

  • extent – Number of unit cells along each direction, needs to be an array of length 2

  • pbc (bool | Sequence[bool]) – If True, the lattice will have periodic boundary conditions (PBC); if False, the lattice will have open boundary conditions (OBC). This parameter can also be a list of booleans with same length as the parameter length, in which case each dimension will have PBC/OBC depending on the corresponding entry of pbc.

  • point_group – point group object describing the symmetry of the lattice If not specified, uses the full hexagonal symmetry group.

  • kwargs – Additional keyword arguments are passed on to the constructor of netket.graph.Lattice.

Return type:

Lattice

Example

Construct a kagome lattice with 3 × 3 unit cells:

>>> from netket.graph import Kagome
>>> g = Kagome(extent=[3, 3])
>>> print(g.n_nodes)
27
Contents