Skip to content

Commit

Permalink
build based on d782beb
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 9, 2024
1 parent 91e6f70 commit bffbd5b
Show file tree
Hide file tree
Showing 41 changed files with 471 additions and 471 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.0","generation_timestamp":"2024-10-09T12:28:30","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.11.0","generation_timestamp":"2024-10-09T12:30:44","documenter_version":"1.7.0"}}
2 changes: 1 addition & 1 deletion dev/ADOs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@

# with a list contains many ADOs
ados_list::Vector{ADOs}
Elist = expect(A, ados_list)</code></pre><p>Here, <code>Elist</code> contains the expectation values corresponding to the <code>ados_list</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../bath_fermion/Fermion_Lorentz/">« Lorentz Spectral Density</a><a class="docs-footer-nextpage" href="../heom_matrix/HEOMLS_intro/">Introduction »</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="Wednesday 9 October 2024 12:28">Wednesday 9 October 2024</span>. Using Julia version 1.11.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Elist = expect(A, ados_list)</code></pre><p>Here, <code>Elist</code> contains the expectation values corresponding to the <code>ados_list</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../bath_fermion/Fermion_Lorentz/">« Lorentz Spectral Density</a><a class="docs-footer-nextpage" href="../heom_matrix/HEOMLS_intro/">Introduction »</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="Wednesday 9 October 2024 12:30">Wednesday 9 October 2024</span>. Using Julia version 1.11.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/LS_solvers/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>LinearSolve solvers · Documentation | HierarchicalEOM.jl</title><meta name="title" content="LinearSolve solvers · Documentation | HierarchicalEOM.jl"/><meta property="og:title" content="LinearSolve solvers · Documentation | HierarchicalEOM.jl"/><meta property="twitter:title" content="LinearSolve solvers · Documentation | HierarchicalEOM.jl"/><meta name="description" content="Documentation for Documentation | HierarchicalEOM.jl."/><meta property="og:description" content="Documentation for Documentation | HierarchicalEOM.jl."/><meta property="twitter:description" content="Documentation for Documentation | HierarchicalEOM.jl."/><meta property="og:url" content="https://qutip.github.io/HierarchicalEOM.jl/LS_solvers/"/><meta property="twitter:url" content="https://qutip.github.io/HierarchicalEOM.jl/LS_solvers/"/><link rel="canonical" href="https://qutip.github.io/HierarchicalEOM.jl/LS_solvers/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img class="docs-light-only" src="../assets/logo.png" alt="Documentation | HierarchicalEOM.jl logo"/><img class="docs-dark-only" src="../assets/logo-dark.png" alt="Documentation | HierarchicalEOM.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">Documentation | HierarchicalEOM.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><span class="tocitem">Home</span><ul><li><a class="tocitem" href="../">Introduction</a></li><li><a class="tocitem" href="../install/">Installation</a></li><li><a class="tocitem" href="../examples/quick_start/">Quick Start</a></li><li><a class="tocitem" href="../cite/">Cite HierarchicalEOM.jl</a></li></ul></li><li><span class="tocitem">Manual</span><ul><li><input class="collapse-toggle" id="menuitem-2-1" type="checkbox"/><label class="tocitem" for="menuitem-2-1"><span class="docs-label">Bosonic Bath</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../bath_boson/bosonic_bath_intro/">Introduction</a></li><li><a class="tocitem" href="../bath_boson/Boson_Drude_Lorentz/">Drude-Lorentz Spectral Density</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-2-2" type="checkbox"/><label class="tocitem" for="menuitem-2-2"><span class="docs-label">Bosonic Bath (RWA)</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../bath_boson_RWA/bosonic_bath_RWA_intro/">Introduction</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-2-3" type="checkbox"/><label class="tocitem" for="menuitem-2-3"><span class="docs-label">Fermionic Bath</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../bath_fermion/fermionic_bath_intro/">Introduction</a></li><li><a class="tocitem" href="../bath_fermion/Fermion_Lorentz/">Lorentz Spectral Density</a></li></ul></li><li><a class="tocitem" href="../ADOs/">Auxiliary Density Operators</a></li><li><input class="collapse-toggle" id="menuitem-2-5" type="checkbox"/><label class="tocitem" for="menuitem-2-5"><span class="docs-label">HEOMLS Matrices</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../heom_matrix/HEOMLS_intro/">Introduction</a></li><li><a class="tocitem" href="../heom_matrix/schrodinger_eq/">HEOMLS for Schrödinger Equation</a></li><li><a class="tocitem" href="../heom_matrix/M_Boson/">HEOMLS for Bosonic Bath</a></li><li><a class="tocitem" href="../heom_matrix/M_Fermion/">HEOMLS for Fermionic Bath</a></li><li><a class="tocitem" href="../heom_matrix/M_Boson_Fermion/">HEOMLS for Bosonic and Fermionic Bath</a></li><li><a class="tocitem" href="../heom_matrix/master_eq/">HEOMLS for Master Equation</a></li></ul></li><li><a class="tocitem" href="../Parity/">Parity Support</a></li><li><a class="tocitem" href="../hierarchy_dictionary/">Hierarchy Dictionary</a></li><li><a class="tocitem" href="../time_evolution/">Time Evolution</a></li><li><a class="tocitem" href="../stationary_state/">Stationary State</a></li><li><a class="tocitem" href="../spectrum/">Spectrum</a></li><li><input class="collapse-toggle" id="menuitem-2-11" type="checkbox"/><label class="tocitem" for="menuitem-2-11"><span class="docs-label">Examples</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../examples/cavityQED/">Cavity QED system</a></li><li><a class="tocitem" href="../examples/dynamical_decoupling/">Driven Systems and Dynamical Decoupling</a></li><li><a class="tocitem" href="../examples/SIAM/">The single-impurity Anderson model</a></li><li><a class="tocitem" href="../examples/electronic_current/">Electronic Current</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-2-12" type="checkbox" checked/><label class="tocitem" for="menuitem-2-12"><span class="docs-label">Solvers Lists</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../ODE_solvers/">DifferentialEquations solvers</a></li><li class="is-active"><a class="tocitem" href>LinearSolve solvers</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-2-13" type="checkbox"/><label class="tocitem" for="menuitem-2-13"><span class="docs-label">Extensions</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../extensions/CUDA/">CUDA.jl</a></li></ul></li></ul></li><li><a class="tocitem" href="../libraryAPI/">Library API</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Manual</a></li><li><a class="is-disabled">Solvers Lists</a></li><li class="is-active"><a href>LinearSolve solvers</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>LinearSolve solvers</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/qutip/HierarchicalEOM.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/qutip/HierarchicalEOM.jl/blob/main/docs/src/LS_solvers.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="LS-solvers"><a class="docs-heading-anchor" href="#LS-solvers">LinearSolve solvers</a><a id="LS-solvers-1"></a><a class="docs-heading-anchor-permalink" href="#LS-solvers" title="Permalink"></a></h1><p>In this page, we list several recommended solvers provided by <a href="https://docs.sciml.ai/LinearSolve/stable/">LinearSolve.jl</a> for solving <a href="../libraryAPI/#QuantumToolbox.steadystate"><code>steadystate</code></a> and spectrum in hierarchical equations of motion approach. </p><p>Remember to import <code>LinearSolve.jl</code></p><pre><code class="language-julia hljs">using LinearSolve</code></pre><p>(click <a href="https://docs.sciml.ai/LinearSolve/stable/solvers/solvers/">here</a> to see the full solver list provided by <code>LinearSolve.jl</code>)</p><h3 id="UMFPACKFactorization-(Default-solver)"><a class="docs-heading-anchor" href="#UMFPACKFactorization-(Default-solver)">UMFPACKFactorization (Default solver)</a><a id="UMFPACKFactorization-(Default-solver)-1"></a><a class="docs-heading-anchor-permalink" href="#UMFPACKFactorization-(Default-solver)" title="Permalink"></a></h3><p>This solver performs better when there is more structure to the sparsity pattern (depends on the complexity of your system and baths).</p><pre><code class="language-julia hljs">UMFPACKFactorization()</code></pre><h3 id="KLUFactorization"><a class="docs-heading-anchor" href="#KLUFactorization">KLUFactorization</a><a id="KLUFactorization-1"></a><a class="docs-heading-anchor-permalink" href="#KLUFactorization" title="Permalink"></a></h3><p>This solver performs better when there is less structure to the sparsity pattern (depends on the complexity of your system and baths).</p><pre><code class="language-julia hljs">KLUFactorization()</code></pre><h3 id="A-generic-BICGSTAB-implementation-from-Krylov"><a class="docs-heading-anchor" href="#A-generic-BICGSTAB-implementation-from-Krylov">A generic BICGSTAB implementation from Krylov</a><a id="A-generic-BICGSTAB-implementation-from-Krylov-1"></a><a class="docs-heading-anchor-permalink" href="#A-generic-BICGSTAB-implementation-from-Krylov" title="Permalink"></a></h3><pre><code class="language-julia hljs">KrylovJL_BICGSTAB()</code></pre><h3 id="Pardiso"><a class="docs-heading-anchor" href="#Pardiso">Pardiso</a><a id="Pardiso-1"></a><a class="docs-heading-anchor-permalink" href="#Pardiso" title="Permalink"></a></h3><p>This solver is based on Intel openAPI Math Kernel Library (MKL) Pardiso</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Using this solver requires adding the package <a href="https://github.com/JuliaSparse/Pardiso.jl">Pardiso.jl</a>, i.e. <code>using Pardiso</code></p></div></div><pre><code class="language-julia hljs">using Pardiso
using LinearSolve
MKLPardisoFactorize()
MKLPardisoIterate()</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../ODE_solvers/">« DifferentialEquations solvers</a><a class="docs-footer-nextpage" href="../extensions/CUDA/">CUDA.jl »</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="Wednesday 9 October 2024 12:28">Wednesday 9 October 2024</span>. Using Julia version 1.11.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
MKLPardisoIterate()</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../ODE_solvers/">« DifferentialEquations solvers</a><a class="docs-footer-nextpage" href="../extensions/CUDA/">CUDA.jl »</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="Wednesday 9 October 2024 12:30">Wednesday 9 October 2024</span>. Using Julia version 1.11.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit bffbd5b

Please sign in to comment.