Skip to content

Commit

Permalink
update website
Browse files Browse the repository at this point in the history
  • Loading branch information
liborsold committed Sep 26, 2024
1 parent 3b40894 commit 056b6f8
Show file tree
Hide file tree
Showing 21 changed files with 902 additions and 26 deletions.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/modules.doctree
Binary file not shown.
Binary file added docs/build/doctrees/theory.doctree
Binary file not shown.
1 change: 1 addition & 0 deletions docs/build/html/_sources/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Navigation
.. toctree::
:maxdepth: 3

theory
modules
classes

Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/_sources/modules.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
API
===
Modules
============

.. autosummary::
:toctree: generated
Expand Down
157 changes: 157 additions & 0 deletions docs/build/html/_sources/theory.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
Theory
======================

The *retarded Green's function*

.. math::
\mathbf{G}^{\mathrm{R}}=[E \mathbf{I}-\mathbf{H}-\mathbf{\Sigma}]^{-1}
is a function of energy :math:`E` multiplied by the identity matrix :math:`\mathbf{I}`. The Hamiltonian :math:`\mathbf{H}` and self-energy :math:`\mathbf{\Sigma}` matrices are to be defined by the physical model.

Along with the *advanced Green's function*

.. math::
\mathbf{G}^{\mathrm{A}} = \left[ \mathbf{G}^{\mathrm{R}} \right]^\dagger
they provide the *spectral function*

.. math::
\mathbf{A}=i\left[\mathbf{G}^{\mathrm{R}}-\mathbf{G}^{\mathrm{A}}\right]
and are used to solve for the *"electron occupation" Green's function*

.. math::
\mathbf{G}^{\mathrm{n}}=\mathbf{G}^{\mathrm{R}} \mathbf{\Sigma}^{\mathrm{in}} \mathbf{G}^{\mathrm{A}}
which gives the *density matrix*

.. math::
\hat{\rho} = \mathbf{G}^{\mathrm{n}} / 2\pi .
The in-scattering term :math:`\mathbf{\Sigma}^{\mathrm{in}}` is also defined by the physical model.


Both, the self-energy :math:`\mathbf{\Sigma}` and the in-scattering term :math:`\mathbf{\Sigma}^{\mathrm{in}}` are sums of the left contact :math:`\mathbf{\Sigma}_1`, right contact :math:`\mathbf{\Sigma}_2` and an intrinsic term :math:`\mathbf{\Sigma}_0`, hence

.. math::
\begin{align}
\mathbf{\Sigma} &= \mathbf{\Sigma}_1 + \mathbf{\Sigma}_2 + \mathbf{\Sigma}_0 , \\
\mathbf{\Sigma}^{\mathrm{in}} &= \mathbf{\Sigma}^{\mathrm{in}}_1 + \mathbf{\Sigma}^{\mathrm{in}}_2 + \mathbf{\Sigma}^{\mathrm{in}}_0 .
\end{align}
NOTE: We use the (physically expressive) notation of S. Datta, where the self-energies and Green's functions in relation to the standard notation (on the right) are defined as

.. math::
\begin{align}
\mathbf{\Sigma} &\equiv \mathbf{\Sigma}^\mathrm{R} , \\
\mathbf{G}^\mathrm{n} &\equiv -i \mathbf{G}^< , \\
\mathbf{\Sigma}^\mathrm{in} &\equiv -i \mathbf{\Sigma}^< .
\end{align}
Linear Chain Model
----------------------------

For the ``LinearChain`` model, the **Hamiltonian**

.. math::
H_{ij} = \begin{cases}
\epsilon_0, & \text { if } i=j \\
t, & \text{ if } i \neq j
\end{cases}
Impurity potential :math:`U` can be added to the on-site energy as

.. math::
\mathbf{H}=\left[
\begin{array}{ccccc}
\ddots & \vdots & \vdots & \vdots & \ddots \\
\cdots & \varepsilon & t & 0 & \cdots \\
\cdots & t & \varepsilon+U & t & \cdots \\
\cdots & 0 & t & \varepsilon & \cdots \\
\ddots & \vdots & \vdots & \vdots & \ddots
\end{array}
\right] .
The **self-energies**

.. math::
\mathbf{\Sigma}_1=\left[\begin{array}{ccccc}
\mathrm{te}^{i k a} & 0 & 0 & \cdots & 0 \\
0 & 0 & 0 & \cdots & 0 \\
0 & 0 & 0 & \cdots & 0 \\
\vdots & \vdots & \vdots & \ddots & \vdots \\
0 & 0 & 0 & \cdots & 0
\end{array}\right], \quad \mathbf{\Sigma}_2=\left[\begin{array}{ccccc}
0 & \cdots & 0 & 0 & 0 \\
\vdots & \ddots & \vdots & \vdots & \vdots \\
0 & \cdots & 0 & 0 & 0 \\
0 & \cdots & 0 & 0 & 0 \\
0 & \cdots & 0 & 0 & \mathrm{te}^{i k a}
\end{array}\right] ,
with the broadening functions :math:`\mathbf{\Gamma} \equiv i\left[ \mathbf{\Sigma} - \mathbf{\Sigma}^\dagger\right]`

.. math::
\mathbf{\Gamma}_1=\frac{\hbar v}{a}\left[\begin{array}{ccccc}
1 & 0 & 0 & \cdots & 0 \\
0 & 0 & 0 & \cdots & 0 \\
0 & 0 & 0 & \cdots & 0 \\
\vdots & \vdots & \vdots & \ddots & \vdots \\
0 & 0 & 0 & \cdots & 0
\end{array}\right], \quad \mathbf{\Gamma}_2=\frac{\hbar v}{a}\left[\begin{array}{ccccc}
0 & \cdots & 0 & 0 & 0 \\
\vdots & \ddots & \vdots & \vdots & \vdots \\
0 & \cdots & 0 & 0 & 0 \\
0 & \cdots & 0 & 0 & 0 \\
0 & \cdots & 0 & 0 & 1
\end{array}\right] ,
where :math:`v=\mathrm{d} E /(\hbar \mathrm{d} k) = -2 a t / \hbar \sin (k a)` so that :math:`\frac{\hbar v}{a} = -2 t / \sin (k a)`.

The in-scattering terms

.. math::
\mathbf{\Sigma}^\mathrm{in}_i = \mathbf{\Gamma}_i \cdot f_i(E) ,
where :math:`f_i(E)` is the Fermi-Dirac distribution function for contact :math:`i \in \set{1, 2}`.

The self-energies describing the **phase and phase-momentum relaxation** are defined in terms of the Green's functions themselves. Their strength is defined via the (scalar) coefficients :math:`D_0^\text{phase}` and :math:`D_0^\text{phase-momentum}`, creating a "mask" matrix

.. math::
\mathbf{D} = D_0^\text{phase}
\left[\begin{array}{ccccc}
1 & 1 & 1 & \cdots & 1 \\
1 & 1 & 1 & \cdots & 1 \\
1 & 1 & 1 & \cdots & 1 \\
\vdots & \vdots & \vdots & \ddots & \vdots \\
1 & 1 & 1 & \cdots & 1
\end{array}\right]
+ D_0^\text{phase-momentum}
\left[\begin{array}{ccccc}
1 & 0 & 0 & \cdots & 0 \\
0 & 1 & 0 & \cdots & 0 \\
0 & 0 & 1 & \cdots & 0 \\
\vdots & \vdots & \vdots & \ddots & \vdots \\
0 & 0 & 0 & \cdots & 1
\end{array}\right] ,
which is used for an element-wise multiplication :math:`\odot` of the Green's function matrices

.. math::
\begin{align}
\mathbf{\Sigma}_0 &= \mathbf{D} \odot \mathbf{G}^\text{R}, \\
\mathbf{\Sigma}^\text{in}_0 &= \mathbf{D} \odot \mathbf{G}^\text{n} .
\end{align}
Since the Green's functions enter the definition of the self-energy, a self-consistent loop is performed, where :math:`\mathbf{G}^\text{R}` and :math:`\mathbf{G}^\text{n}` are initially set as zero matrices and iteratively updated, along with :math:`\mathbf{\Sigma}_0` and :math:`\mathbf{\Sigma}^\text{in}_0`. About 70 iteration steps are usually enough to reach a convergence.
3 changes: 2 additions & 1 deletion docs/build/html/classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,8 @@
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="current nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">API</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l1"><a class="reference internal" href="theory.html">Theory</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">Modules</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/fuNEGF.models.html">fuNEGF.models</a></li>
</ul>
</details></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/build/html/generated/fuNEGF.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,8 @@
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="../modules.html">API</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l1"><a class="reference internal" href="../theory.html">Theory</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../modules.html">Modules</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="fuNEGF.models.html">fuNEGF.models</a></li>
</ul>
</details></li>
Expand Down
7 changes: 4 additions & 3 deletions docs/build/html/generated/fuNEGF.models.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Classes" href="../classes.html" />
<link rel="prev" title="API" href="../modules.html" />
<link rel="prev" title="Modules" href="../modules.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -149,7 +149,8 @@
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active has-children"><a class="reference internal" href="../modules.html">API</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../theory.html">Theory</a></li>
<li class="toctree-l1 current active has-children"><a class="reference internal" href="../modules.html">Modules</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l2 current active"><a class="current reference internal" href="#">fuNEGF.models</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -350,7 +351,7 @@ <h1>fuNEGF.models</h1>
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">API</p>
<p class="prev-next-title">Modules</p>
</div>
</a>
<a class="right-next"
Expand Down
3 changes: 2 additions & 1 deletion docs/build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,8 @@
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">API</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l1"><a class="reference internal" href="theory.html">Theory</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">Modules</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/fuNEGF.models.html">fuNEGF.models</a></li>
</ul>
</details></li>
Expand Down
15 changes: 10 additions & 5 deletions docs/build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'index';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="API" href="modules.html" />
<link rel="next" title="Theory" href="theory.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -150,7 +150,8 @@
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">API</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l1"><a class="reference internal" href="theory.html">Theory</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">Modules</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/fuNEGF.models.html">fuNEGF.models</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -351,7 +352,11 @@ <h2>Quickstart<a class="headerlink" href="#quickstart" title="Link to this headi
<h2>Navigation<a class="headerlink" href="#navigation" title="Link to this heading">#</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">API</a><ul>
<li class="toctree-l1"><a class="reference internal" href="theory.html">Theory</a><ul>
<li class="toctree-l2"><a class="reference internal" href="theory.html#linear-chain-model">Linear Chain Model</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">Modules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/fuNEGF.models.html">fuNEGF.models</a></li>
</ul>
</li>
Expand Down Expand Up @@ -394,11 +399,11 @@ <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Li

<div class="prev-next-area">
<a class="right-next"
href="modules.html"
href="theory.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">API</p>
<p class="prev-next-title">Theory</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
Expand Down
17 changes: 9 additions & 8 deletions docs/build/html/modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>API &#8212; fuNEGF 0.1.11 documentation</title>
<title>Modules &#8212; fuNEGF 0.1.11 documentation</title>



Expand Down Expand Up @@ -44,7 +44,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="fuNEGF.models" href="generated/fuNEGF.models.html" />
<link rel="prev" title="Welcome to fuNEGF’s documentation!" href="index.html" />
<link rel="prev" title="Theory" href="theory.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
Expand Down Expand Up @@ -149,7 +149,8 @@
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">API</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l1"><a class="reference internal" href="theory.html">Theory</a></li>
<li class="toctree-l1 current active has-children"><a class="current reference internal" href="#">Modules</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/fuNEGF.models.html">fuNEGF.models</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -305,7 +306,7 @@


<div id="jb-print-docs-body" class="onlyprint">
<h1>API</h1>
<h1>Modules</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
Expand All @@ -319,8 +320,8 @@ <h1>API</h1>
<div id="searchbox"></div>
<article class="bd-article">

<section id="api">
<h1>API<a class="headerlink" href="#api" title="Link to this heading">#</a></h1>
<section id="modules">
<h1>Modules<a class="headerlink" href="#modules" title="Link to this heading">#</a></h1>
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/fuNEGF.models.html#module-fuNEGF.models" title="fuNEGF.models"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fuNEGF.models</span></code></a></p></td>
Expand All @@ -343,12 +344,12 @@ <h1>API<a class="headerlink" href="#api" title="Link to this heading">#</a></h1>

<div class="prev-next-area">
<a class="left-prev"
href="index.html"
href="theory.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Welcome to fuNEGF’s documentation!</p>
<p class="prev-next-title">Theory</p>
</div>
</a>
<a class="right-next"
Expand Down
Binary file modified docs/build/html/objects.inv
Binary file not shown.
3 changes: 2 additions & 1 deletion docs/build/html/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,8 @@
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">API</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l1"><a class="reference internal" href="theory.html">Theory</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">Modules</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/fuNEGF.models.html">fuNEGF.models</a></li>
</ul>
</details></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/build/html/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,8 @@
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">API</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l1"><a class="reference internal" href="theory.html">Theory</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="modules.html">Modules</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/fuNEGF.models.html">fuNEGF.models</a></li>
</ul>
</details></li>
Expand Down
Loading

0 comments on commit 056b6f8

Please sign in to comment.