linear_site_index

SiteIndexConverter.linear_site_index(

self: SiteIndexConverter,

integral_site_coordinate: IntegralSiteCoordinate,

) → int

Given the IntegralSiteCoordinate of a site, retrieve its corresponding linear index. By default, if SiteIndexConverter.never_bring_within() has not been called, the IntegralSiteCoordinate is brought within the superlattice using superlattice translations.