Skip to content

Commit

Permalink
build based on 057f1bc
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 8, 2023
1 parent ea87229 commit 560690d
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions dev/couplingfunctions/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
0.0 2.0 0.0 2.0
2.0 0.0 2.0 0.0
0.0 2.0 0.0 2.0
2.0 0.0 2.0 0.0</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/quantum-exeter/SpiDy.jl/blob/918a1e5727429a9166b94d46e6556bdb51034f78/src/CouplingFunctions.jl#L1-L30">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SpiDy.NNlattice" href="#SpiDy.NNlattice"><code>SpiDy.NNlattice</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">NNlattice(N, Jh, Jv; boundary=nothing)</code></pre><p>Create the spin-spin coupling matrix of a <code>NxN</code> 2D lattice with nearest-neighbour interactions and specified horizontal and vertical coupling strengths, <code>Jh</code> and <code>Jv</code> respectively.</p><p><strong>Arguments</strong></p><ul><li><code>N</code>: The size of the lattice (N x N).</li><li><code>Jh</code>: The horizontal nearest-neighbour coupling strength.</li><li><code>Jv</code>: The vertical nearest-neighbour coupling strength.</li><li><code>boundary=nothing</code>: (Optional) Specifies the boundary condition of the lattice. Default is <code>nothing</code> which corresponds to open edges. Use <code>:periodic</code> for periodic boundary condition.</li></ul><p><strong>Returns</strong></p><p>An <code>N^2×N^2</code> array representing the coupling matrix of the lattice.</p><p><strong>Examples</strong></p><pre><code class="language-julia hljs">julia&gt; J = NNlattice(3, 2.0, 1.0)
2.0 0.0 2.0 0.0</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/quantum-exeter/SpiDy.jl/blob/057f1bcbad337b01e0c16a97b4282cbb36a4fdb4/src/CouplingFunctions.jl#L1-L30">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="SpiDy.NNlattice" href="#SpiDy.NNlattice"><code>SpiDy.NNlattice</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">NNlattice(N, Jh, Jv; boundary=nothing)</code></pre><p>Create the spin-spin coupling matrix of a <code>NxN</code> 2D lattice with nearest-neighbour interactions and specified horizontal and vertical coupling strengths, <code>Jh</code> and <code>Jv</code> respectively.</p><p><strong>Arguments</strong></p><ul><li><code>N</code>: The size of the lattice (N x N).</li><li><code>Jh</code>: The horizontal nearest-neighbour coupling strength.</li><li><code>Jv</code>: The vertical nearest-neighbour coupling strength.</li><li><code>boundary=nothing</code>: (Optional) Specifies the boundary condition of the lattice. Default is <code>nothing</code> which corresponds to open edges. Use <code>:periodic</code> for periodic boundary condition.</li></ul><p><strong>Returns</strong></p><p>An <code>N^2×N^2</code> array representing the coupling matrix of the lattice.</p><p><strong>Examples</strong></p><pre><code class="language-julia hljs">julia&gt; J = NNlattice(3, 2.0, 1.0)
9×9 LinearAlgebra.Symmetric{Float64, Matrix{Float64}}:
0.0 2.0 0.0 1.0 0.0 0.0 0.0 0.0 0.0
2.0 0.0 2.0 0.0 1.0 0.0 0.0 0.0 0.0
Expand All @@ -33,4 +33,4 @@
0.0 0.0 1.0 2.0 2.0 0.0 0.0 0.0 1.0
1.0 0.0 0.0 1.0 0.0 0.0 0.0 2.0 2.0
0.0 1.0 0.0 0.0 1.0 0.0 2.0 0.0 2.0
0.0 0.0 1.0 0.0 0.0 1.0 2.0 2.0 0.0</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/quantum-exeter/SpiDy.jl/blob/918a1e5727429a9166b94d46e6556bdb51034f78/src/CouplingFunctions.jl#L44-L85">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../couplingtensor/">« Spin-environment coupling tensor</a><a class="docs-footer-nextpage" href="../dynamics/">Dynamics »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 8 November 2023 15:58">Wednesday 8 November 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
0.0 0.0 1.0 0.0 0.0 1.0 2.0 2.0 0.0</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/quantum-exeter/SpiDy.jl/blob/057f1bcbad337b01e0c16a97b4282cbb36a4fdb4/src/CouplingFunctions.jl#L44-L85">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../couplingtensor/">« Spin-environment coupling tensor</a><a class="docs-footer-nextpage" href="../dynamics/">Dynamics »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 8 November 2023 16:32">Wednesday 8 November 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 560690d

Please sign in to comment.