kwant.system.SiteArray

class kwant.system.SiteArray(family, tags)[source]

Bases: collections.abc.Sequence

An array of sites, members of a SiteFamily.

Parameters
  • family (an instance of SiteFamily) – The ‘type’ of the sites.

  • tags (a sequence of python objects) – Sequence of unique identifiers of the sites within the site array family, typically vectors of integers.

Raises

ValueError – If tags are not proper tags for family.

Methods

count(value) → integer – return number of occurrences of value[source]
index(value[, start[, stop]]) → integer – return first index of value.[source]

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

positions()[source]

Real space position of the site.

This relies on family having a pos method (see SiteFamily).

Previous topic

kwant.system.Site

Next topic

kwant.system.SiteFamily

This Page