kwant.builder.BuilderLead

kwant.builder.BuilderLead#

class kwant.builder.BuilderLead(builder, interface, padding=None)[source]#

Bases: Lead

A lead made from a Builder with a spatial symmetry.

Parameters:

  • builder (Builder) – The tight-binding system of a lead. It has to possess appropriate symmetry, and it may not contain hoppings between further than neighboring images of the fundamental domain.

  • interface (sequence of Site instances) – Sequence of sites in the scattering region to which the lead is attached.

builder[source]#

The tight-binding system of a lead.

Type:

Builder

interface[source]#

A sorted list of interface sites.

Type:

list of Site instances

padding[source]#

A sorted list of sites that originate from the lead, have the same onsite Hamiltonian, and are connected by the same hoppings as the lead sites.

Type:

list of Site instances

Notes

The hopping from the scattering region to the lead is assumed to be equal to the hopping from a lead unit cell to the next one in the direction of the symmetry vector (i.e. the lead is ‘leaving’ the system and starts with a hopping).

Every system has an attribute leads, which stores a list of BuilderLead objects with all the information about the leads that are attached.

Methods

finalized()[source]#

Return a kwant.builder.InfiniteSystem corresponding to the compressed lead.

The order of interface sites is kept during finalization.

Contents