triqs.experimental.lattice.lattice.Superlattice

class triqs.experimental.lattice.lattice.Superlattice

Bases: object

Representation of a superlattice built on top of an underlying Bravais lattice.

A superlattice is defined by its unit vectors, expressed in the coordinates of the underlying lattice, and a set of cluster points that enumerate the underlying-lattice sites contained in one superlattice unit cell. It stores the transformation matrix from lattice to superlattice coordinates and is used to fold lattice functions onto the superlattice.

---

Dispatched C++ constructor(s).

[1] (sl_units: ndarray[int, 2], cluster_pts: ndarray[int, 2])

Construct a superlattice from its unit vectors and cluster points.

Parameters:

sl_unitsndarray[int, 2]

Unit vectors of the superlattice of shape (2, 2) or (3, 3), where sl_units[a, :] is the \(a\)-th unit vector in the coordinates of the underlying lattice.

cluster_ptsndarray[int, 2]

Cluster points, i.e. the underlying-lattice sites of one superlattice unit cell, given in lattice coordinates.

Attributes

dim	Get the dimension of the superlattice.
n_cluster_sites	Get the number of cluster sites in one superlattice unit cell.