kwant.lattice.
TranslationalSymmetry
(*periods)¶Bases: kwant.builder.Symmetry
A translational symmetry defined in real space.
Group elements of this symmetry are integer tuples of appropriate length.
Parameters:  p0, p1, p2, ... : sequences of real numbers


Notes
This symmetry automatically chooses the fundamental domain for each new
SiteFamily it encounters. If this site family does not correspond to a
Bravais lattice, or if it does not have a commensurate period, an error is
produced. A certain flexibility in choice of the fundamental domain can be
achieved by calling manually the add_site_family
method and providing it
the other_vectors parameter.
The fundamental domain for hoppings are all hoppings (a, b)
with site
a in fundamental domain of sites.
Methods
act
(element, a, b=None)¶add_site_family
(fam, other_vectors=None)¶Select a fundamental domain for site family and cache associated data.
Parameters:  fam : SiteFamily
other_vectors : list of lists of integers


Raises:  KeyError
ValueError

in_fd
(site)¶Tell whether site
lies within the fundamental domain.
reversed
()¶Return a reversed copy of the symmetry.
The resulting symmetry has all the period vectors opposite to the original and an identical fundamental domain.
to_fd
(a, b=None)¶which
(site)¶Attributes
num_directions
¶