Ctrl+K

netket.graph.KitaevHoneycomb

Contents

netket.graph.KitaevHoneycomb#

class netket.graph.KitaevHoneycomb[source]#

Bases:

Constructs a honeycomb lattice of a given spatial extent.

Nearest-neighbour edges are coloured according to direction (cf. Kitaev, https://doi.org/10.1016/j.aop.2005.10.005). Periodic boundary conditions can also be imposed. Sites are returned at the 2b Wyckoff positions.

Parameters:

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

  • pbc (Union[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.

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

Return type:

Lattice

Example

Construct a Kitaev honeycomb lattice with 3 × 3 unit cells:

>>> from netket.graph import Honeycomb
>>> g = KitaevHoneycomb(extent=[3, 3])
>>> print(g.n_nodes)
18
>>> print(len(g.edges(filter_color=2)))
9
Contents