build based on eb8c716

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-16T22:14:33","documenter_version":"1.5.0"}}
+{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-17T08:18:24","documenter_version":"1.5.0"}}

dev/extsparse/index.html

@@ -27,4 +27,4 @@
     a\nabla u\cdot \vec n + bu &=g && \text{on}\;  \partial\Omega
     \end{align*}\]</p><p>The matrix is irreducibly diagonally dominant, has positive main diagonal entries  and nonpositive off-diagonal entries, hence it has the M-Property. Therefore, its inverse will be a dense matrix with positive entries, and the spectral radius of the  Jacobi iteration matrix <span>$ho(I-D(A)^{-1}A)&lt;1$</span> .</p><p>Moreover, in the symmetric case, it is positive definite.</p><p>Parameters+ default values:</p><table><tr><th style="text-align: right">Parameter + default vale</th><th style="text-align: left">Description</th></tr><tr><td style="text-align: right"><code>nx</code></td><td style="text-align: left">Number of unknowns in x direction</td></tr><tr><td style="text-align: right"><code>ny</code></td><td style="text-align: left">Number of unknowns in y direction</td></tr><tr><td style="text-align: right"><code>nz</code></td><td style="text-align: left">Number of unknowns in z direction</td></tr><tr><td style="text-align: right"><code>matrixtype = SparseMatrixCSC</code></td><td style="text-align: left">Matrix type</td></tr><tr><td style="text-align: right"><code>update = (A,v,i,j)-&gt; A[i,j]+=v</code></td><td style="text-align: left">Element update function</td></tr><tr><td style="text-align: right"><code>rand =()-&gt; rand()</code></td><td style="text-align: left">Random number generator</td></tr><tr><td style="text-align: right"><code>symmetric=true</code></td><td style="text-align: left">Whether to create symmetric matrix or not</td></tr></table><p>The sparsity structure is fixed to an orthogonal grid, resulting in a 3, 5 or 7 diagonal matrix depending on dimension. The entries are random unless e.g.  <code>rand=()-&gt;1</code> is passed as random number generator. Tested for Matrix, SparseMatrixCSC,  ExtendableSparseMatrix, Tridiagonal, SparseMatrixLNK and <code>:COO</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/j-fu/ExtendableSparse.jl">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ExtendableSparse.sprand!-Union{Tuple{Ti}, Tuple{Tv}, Tuple{SparseArrays.AbstractSparseMatrix{Tv, Ti}, Int64}} where {Tv, Ti}" href="#ExtendableSparse.sprand!-Union{Tuple{Ti}, Tuple{Tv}, Tuple{SparseArrays.AbstractSparseMatrix{Tv, Ti}, Int64}} where {Tv, Ti}"><code>ExtendableSparse.sprand!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">sprand!(A, xnnz)
 </code></pre><p>Fill empty sparse matrix A with random nonzero elements from interval [1,2] using incremental assembly.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/j-fu/ExtendableSparse.jl">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ExtendableSparse.sprand_sdd!-Union{Tuple{SparseArrays.AbstractSparseMatrix{Tv, Ti}}, Tuple{Ti}, Tuple{Tv}} where {Tv, Ti}" href="#ExtendableSparse.sprand_sdd!-Union{Tuple{SparseArrays.AbstractSparseMatrix{Tv, Ti}}, Tuple{Ti}, Tuple{Tv}} where {Tv, Ti}"><code>ExtendableSparse.sprand_sdd!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">sprand_sdd!(A; nnzrow)
-</code></pre><p>Fill sparse matrix  with random entries such that  it becomes strictly diagonally  dominant  and  thus  invertible and  has  a  fixed  number <code>nnzrow</code> (default: 4) of nonzeros in its rows. The matrix bandwidth is bounded by  sqrt(n) in order to resemble  a typical matrix of  a 2D piecewise linear FEM discretization.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/j-fu/ExtendableSparse.jl">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../linearsolve/">« Integration with LinearSolve.jl</a><a class="docs-footer-nextpage" href="../iter/">Factorizations &amp; Preconditioners »</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.5.0 on <span class="colophon-date" title="Tuesday 16 July 2024 22:14">Tuesday 16 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre><p>Fill sparse matrix  with random entries such that  it becomes strictly diagonally  dominant  and  thus  invertible and  has  a  fixed  number <code>nnzrow</code> (default: 4) of nonzeros in its rows. The matrix bandwidth is bounded by  sqrt(n) in order to resemble  a typical matrix of  a 2D piecewise linear FEM discretization.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/j-fu/ExtendableSparse.jl">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../linearsolve/">« Integration with LinearSolve.jl</a><a class="docs-footer-nextpage" href="../iter/">Factorizations &amp; Preconditioners »</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.5.0 on <span class="colophon-date" title="Wednesday 17 July 2024 08:18">Wednesday 17 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/internal/index.html

@@ -66,4 +66,4 @@
 </code></pre><p>Update element of the matrix  with operation <code>op</code>.  It assumes that <code>op(0,0)==0</code>. If <code>v</code> is zero a new entry is created nevertheless.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/j-fu/ExtendableSparse.jl">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ExtendableSparse.updateindex!-Union{Tuple{Ti}, Tuple{Tv}, Tuple{ExtendableSparse.SparseMatrixDILNKC{Tv, Ti}, Vararg{Any, 4}}} where {Tv, Ti}" href="#ExtendableSparse.updateindex!-Union{Tuple{Ti}, Tuple{Tv}, Tuple{ExtendableSparse.SparseMatrixDILNKC{Tv, Ti}, Vararg{Any, 4}}} where {Tv, Ti}"><code>ExtendableSparse.updateindex!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">updateindex!(lnk, op, v, i, j)
 </code></pre><p>Update element of the matrix  with operation <code>op</code>.  It assumes that <code>op(0,0)==0</code>. If <code>v</code> is zero, no new  entry is created.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/j-fu/ExtendableSparse.jl">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SparseArrays.nnz-Tuple{ExtendableSparse.SparseMatrixDILNKC}" href="#SparseArrays.nnz-Tuple{ExtendableSparse.SparseMatrixDILNKC}"><code>SparseArrays.nnz</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">nnz(lnk)
 </code></pre><p>Return number of nonzero entries.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/j-fu/ExtendableSparse.jl">source</a></section></article><h2 id="Misc-methods"><a class="docs-heading-anchor" href="#Misc-methods">Misc methods</a><a id="Misc-methods-1"></a><a class="docs-heading-anchor-permalink" href="#Misc-methods" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ExtendableSparse.@makefrommatrix-Tuple{Tuple{Any}}" href="#ExtendableSparse.@makefrommatrix-Tuple{Tuple{Any}}"><code>ExtendableSparse.@makefrommatrix</code></a> — <span class="docstring-category">Macro</span></header><section><div><p>&quot;     @makefrommatrix(fact)</p><p>For an AbstractFactorization <code>MyFact</code>, provide methods</p><pre><code class="nohighlight hljs">    MyFact(A::ExtendableSparseMatrix; kwargs...)
-    MyFact(A::SparseMatrixCSC; kwargs...)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/j-fu/ExtendableSparse.jl">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../iter/">« Factorizations &amp; Preconditioners</a><a class="docs-footer-nextpage" href="../changes/">Changes »</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.5.0 on <span class="colophon-date" title="Tuesday 16 July 2024 22:14">Tuesday 16 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+    MyFact(A::SparseMatrixCSC; kwargs...)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/j-fu/ExtendableSparse.jl">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../iter/">« Factorizations &amp; Preconditioners</a><a class="docs-footer-nextpage" href="../changes/">Changes »</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.5.0 on <span class="colophon-date" title="Wednesday 17 July 2024 08:18">Wednesday 17 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>