kwant.builder.BuilderLead

class kwant.builder.BuilderLead(builder, interface)

Bases: kwant.builder.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.

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).

The given order of interface sites is preserved throughout finalization.

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()

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

The order of interface sites is kept during finalization.