build based on 365c267

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-27T07:51:45","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-27T09:02:27","documenter_version":"1.7.0"}}

dev/advanced/meanfield/index.html

@@ -151,4 +151,4 @@
  2.0432+0.0im    -1.0+0.0im         ⋅             ⋅
    -1.0+0.0im  2.1068+0.0im    -1.0+0.0im         ⋅
         ⋅        -1.0+0.0im  2.1068+0.0im    -1.0+0.0im
-        ⋅             ⋅        -1.0+0.0im  2.0432+0.0im</code></pre><p>Note that the content of <code>pdata</code> is passed by <code>aasol</code> as a third argument to <code>f!</code>. We use this to pass the serializer <code>s</code> and <code>U</code> parameter to use.</p><div class="admonition is-info"><header class="admonition-header">Bring your own fixed-point solver!</header><div class="admonition-body"><p>Note that fixed-point calculations can be tricky, and the search algorithm can have a huge impact in convergence (if the problem converges at all!). For this reason, Quantica.jl does not provide built-in fixed-point routines, only the functionality to write functions such as <code>f</code> above. Numerous packages exist for fixed-point computations in julia. Check <a href="https://github.com/SciML/NonlinearSolve.jl">NonlinearSolve.jl</a> for one prominent metapackage.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../tutorial/observables/">« Observables</a><a class="docs-footer-nextpage" href="../wannier90/">Wannier90 imports »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 27 September 2024 07:51">Friday 27 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+        ⋅             ⋅        -1.0+0.0im  2.0432+0.0im</code></pre><p>Note that the content of <code>pdata</code> is passed by <code>aasol</code> as a third argument to <code>f!</code>. We use this to pass the serializer <code>s</code> and <code>U</code> parameter to use.</p><div class="admonition is-info"><header class="admonition-header">Bring your own fixed-point solver!</header><div class="admonition-body"><p>Note that fixed-point calculations can be tricky, and the search algorithm can have a huge impact in convergence (if the problem converges at all!). For this reason, Quantica.jl does not provide built-in fixed-point routines, only the functionality to write functions such as <code>f</code> above. Numerous packages exist for fixed-point computations in julia. Check <a href="https://github.com/SciML/NonlinearSolve.jl">NonlinearSolve.jl</a> for one prominent metapackage.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../tutorial/observables/">« Observables</a><a class="docs-footer-nextpage" href="../wannier90/">Wannier90 imports »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 27 September 2024 09:02">Friday 27 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/advanced/wannier90/index.html

@@ -57,4 +57,4 @@
 WannierBuilder{Float64,2} : 2-dimensional Hamiltonian builder of type Float64 from Wannier90 input
   cells      : 151
   elements   : 7560
-  modifiers  : 2</code></pre><p>An interesting application of modifiers is the addition of an electric field that couples to the full <code>r</code> operator. In an strict tight-binding limit, we would add an electric field <code>E</code> simply as an onsite potential</p><pre><code class="language-julia hljs">julia&gt; hE = h |&gt; @onsite!((o, r; E = SA[0,0]) -&gt; o + E&#39;*r);</code></pre><p>However, we actually have the full <code>r</code> operator now, which includes non-diagonal matrix elements. We can then incorporate the electric field term <code>E&#39;*r</code> more precisely. We can do so using the <code>--&gt;</code> syntax and the indexing functionality of the <code>r::BarebonesOperator</code> that we obtained from Wannier90</p><pre><code class="language-julia hljs">julia&gt; hE = h |&gt; @onsite!((o, i; E = SA[0,0]) --&gt; o + E&#39;*r[i,i]) |&gt; @hopping!((t, i, j; E = SA[0,0]) --&gt; t + E&#39;*r[i,j]);</code></pre><div class="admonition is-info"><header class="admonition-header">Closures over non-constant objects</header><div class="admonition-body"><p>Note that the above creates a closure over <code>r</code>, which is not <code>const</code>. As a result this would incur a small performance and allocation cost when evaluating <code>hE(E=...)</code>. We can avoid it e.g. by defining <code>r</code> as a constant, <code>const r = sites(w)</code>.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../meanfield/">« Self-consistent mean fields</a><a class="docs-footer-nextpage" href="../../examples/">Examples »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 27 September 2024 07:51">Friday 27 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+  modifiers  : 2</code></pre><p>An interesting application of modifiers is the addition of an electric field that couples to the full <code>r</code> operator. In an strict tight-binding limit, we would add an electric field <code>E</code> simply as an onsite potential</p><pre><code class="language-julia hljs">julia&gt; hE = h |&gt; @onsite!((o, r; E = SA[0,0]) -&gt; o + E&#39;*r);</code></pre><p>However, we actually have the full <code>r</code> operator now, which includes non-diagonal matrix elements. We can then incorporate the electric field term <code>E&#39;*r</code> more precisely. We can do so using the <code>--&gt;</code> syntax and the indexing functionality of the <code>r::BarebonesOperator</code> that we obtained from Wannier90</p><pre><code class="language-julia hljs">julia&gt; hE = h |&gt; @onsite!((o, i; E = SA[0,0]) --&gt; o + E&#39;*r[i,i]) |&gt; @hopping!((t, i, j; E = SA[0,0]) --&gt; t + E&#39;*r[i,j]);</code></pre><div class="admonition is-info"><header class="admonition-header">Closures over non-constant objects</header><div class="admonition-body"><p>Note that the above creates a closure over <code>r</code>, which is not <code>const</code>. As a result this would incur a small performance and allocation cost when evaluating <code>hE(E=...)</code>. We can avoid it e.g. by defining <code>r</code> as a constant, <code>const r = sites(w)</code>.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../meanfield/">« Self-consistent mean fields</a><a class="docs-footer-nextpage" href="../../examples/">Examples »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 27 September 2024 09:02">Friday 27 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>