leads¶
Lead interface for scattering models
The only way to create leads is using the Model.attach_lead()
method.
The classes represented here are the final product of that process, listed
in Model.leads
.

class
Lead
(impl: _pybinding.Lead, index, lattice)¶ Describes a single lead connected to a
Model
Leads can only be created using
Model.attach_lead()
and accessed usingModel.leads
.
calc_bands
(start=3.141592653589793, end=3.141592653589793, step=0.05)¶ Calculate the band structure of an infinite lead
Parameters:  start, end : float
Points in reciprocal space which form the path for the band calculation.
 step : float
Calculation step length in reciprocal space units. Lower
step
values will return more detailed results.
Returns: Bands

plot
(lead_length=6, **kwargs)¶ Plot the sites, hoppings and periodic boundaries of the lead
Parameters:  lead_length : int
Number of times to repeat the lead’s periodic boundaries.
 **kwargs
Additional plot arguments as specified in
structure_plot_properties()
.

plot_bands
(start=3.141592653589793, end=3.141592653589793, step=0.05, **kwargs)¶ Plot the band structure of an infinite lead
Parameters:  start, end : float
Points in reciprocal space which form the path for the band calculation.
 step : float
Calculation step length in reciprocal space units. Lower
step
values will return more detailed results. **kwargs
Forwarded to
Bands.plot()
.

plot_contact
(line_width=1.6, arrow_length=0.5, shade_width=0.3, shade_color='#d40a0c')¶ Plot the shape and direction of the lead contact region
Parameters:  line_width : float
Width of the line representing the lead contact.
 arrow_length : float
Size of the direction arrow as a fraction of the contact line length.
 shade_width : float
Width of the shaded area as a fraction of the arrow length.
 shade_color : str
Color of the shaded area.

h0
¶ Unit cell Hamiltonian as
csr_matrix

h1
¶ Hamiltonian which connects who unit cells,
csr_matrix

indices
¶ Main system indices (1d array) to which this lead is connected
