kwant.builder.Lead

class kwant.builder.Lead

Bases: object

Abstract base class for leads that can be attached to a Builder.

To attach a lead to a builder, append it to the builder’s leads instance variable. See the documentation of kwant.builder for the concrete classes of leads derived from this one.

interface

Type:

sequence of sites

Methods

abstract finalized()

Return a finalized version of the lead.

Return type:

finalized_lead

Notes

The finalized lead must be an object that can be used as a lead in a kwant.system.FiniteSystem, i.e. an instance of kwant.system.InfiniteSystem. Typically it will be a finalized builder: kwant.builder.InfiniteSystem.

The order of sites for the finalized lead must be the one specified in interface.