From e8e4f31617412a4d30f877f6b14b67ac804b745b Mon Sep 17 00:00:00 2001
From: Christoph Groth <christoph.groth@cea.fr>
Date: Mon, 3 Feb 2014 18:25:47 +0100
Subject: [PATCH] document how to manually attach leads
---
kwant/builder.py | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/kwant/builder.py b/kwant/builder.py
index bd86c25..74153e1 100644
--- a/kwant/builder.py
+++ b/kwant/builder.py
@@ -378,9 +378,14 @@ class HermConjOfFunc(object):
class Lead(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 `~Builder.leads`
+ instance variable. See the documentation of `kwant.builder` for the
+ concrete classes of leads derived from this one.
+
Attributes
----------
interface : sequence of sites
+
"""
__metaclass__ = abc.ABCMeta
@@ -565,6 +570,9 @@ class Builder(object):
tags which are sequences of integers. It *makes sense* only when these
sites live on a regular lattice, like the ones provided by `kwant.lattice`.
+ Attaching a lead manually (without the use of `~Builder.attach_lead`)
+ amounts to creating a `Lead` object and appending it to this list.
+
``builder0 += builder1`` adds all the sites, hoppings, and leads of
``builder1`` to ``builder0``. Sites and hoppings present in both systems
are overwritten by those in ``builder1``. The leads of ``builder1`` are
@@ -576,6 +584,11 @@ class Builder(object):
they must satisfy the same symmetry. There is (currently) no check and
wrong results will be the consequence of a misbehaving function.
+ Attributes
+ ----------
+ leads : list of `Lead` instances
+ The leads that are attached to the system.
+
Examples
--------
Define a site.
@@ -594,6 +607,11 @@ class Builder(object):
>>> del builder[site3]
+ Detach the last lead. (This does not remove the sites that were added to
+ the scattering region by `~Builder.attach_lead`.)
+
+ >>> del builder.leads[-1]
+
"""
def __init__(self, symmetry=None):
--
GitLab