build based on 854fd78

previews/PR133/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-12T23:02:42","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-12T23:16:13","documenter_version":"1.8.0"}}

previews/PR133/index.html

@@ -23,4 +23,4 @@
 associate_matrix!(mumps, A)  # A is converted to a sparse ComplexF64 matrix
 associate_rhs!(mumps, rhs)   # rhs is converted to a Complex64 vector</code></pre><p>See <a href="https://github.com/JuliaSmoothOptimizers/MUMPS.jl/tree/main/test">test</a> for more examples.</p><h2 id="Constants-and-Methods-Exposed"><a class="docs-heading-anchor" href="#Constants-and-Methods-Exposed">Constants and Methods Exposed</a><a id="Constants-and-Methods-Exposed-1"></a><a class="docs-heading-anchor-permalink" href="#Constants-and-Methods-Exposed" title="Permalink"></a></h2><h3 id="Constants"><a class="docs-heading-anchor" href="#Constants">Constants</a><a id="Constants-1"></a><a class="docs-heading-anchor-permalink" href="#Constants" title="Permalink"></a></h3><p>The following convenience constants may be used when initializing a <code>Mumps</code> object:</p><table><tr><th style="text-align: right">Constant</th><th style="text-align: right">Meaning</th></tr><tr><td style="text-align: right"><code>mumps_unsymmetric</code></td><td style="text-align: right">matrix is general unsymmetric (or symmetry is unknown)</td></tr><tr><td style="text-align: right"><code>mumps_definite</code></td><td style="text-align: right">matrix is symmetric and (positive or negative) definite</td></tr><tr><td style="text-align: right"><code>mumps_symmetric</code></td><td style="text-align: right">matrix is symmetric but indefinite (or definiteness is unknown)</td></tr><tr><td style="text-align: right"><code>default_icntl</code></td><td style="text-align: right">array of default integer parameters</td></tr><tr><td style="text-align: right"><code>default_cntl32</code></td><td style="text-align: right">array of default real parameters in single precision</td></tr><tr><td style="text-align: right"><code>default_cntl64</code></td><td style="text-align: right">array of default real parameters in double precision</td></tr></table><p>See Section 5 of the <a href="https://graal.ens-lyon.fr/MUMPS/index.php?page=doc">MUMPS User&#39;s Manual</a> for a description of the integer and real control arrays.</p><h3 id="Methods"><a class="docs-heading-anchor" href="#Methods">Methods</a><a id="Methods-1"></a><a class="docs-heading-anchor-permalink" href="#Methods" title="Permalink"></a></h3><p>A <code>Mumps</code> object is created using the default constructor, which must be supplied with:</p><ul><li>the data type for the arithmetic to be used, as a type parameter, i.e., <code>Mumps{Float64}(...)</code> or <code>Mumps{ComplexF64}(...)</code></li><li><code>sym</code>: one of the constants <code>mumps_unsymmetric</code>, <code>mumps_definite</code> or <code>mumps_symmetric</code>. Note that there is no support for Hermitian complex matrices in MUMPS. Therefore, we recommend to always use <code>mumps_unsymmetric</code> for complex data.</li><li><code>icntl</code>: an integer parameters array (see the MUMPS Users&#39;s Manual)</li><li><code>cntl</code>: a real parameters array (see the MUMPS Users&#39;s Manual)</li></ul><p>The convenience function <code>get_icntl()</code> returns an array of integer parameters corresponding to certain commonly-used options. Its arguments are all optional:</p><ul><li><code>det</code>: a boolean indicating whether the determinant should be computed (default: <code>false</code>)</li><li><code>verbose</code>: a boolean (default: <code>false</code>)</li><li><code>ooc</code>: a boolean indicating whether factors should be stored out of core (default: <code>false</code>)</li><li><code>itref</code>: the number of iterative refinement steps (default: 0).</li></ul><p>A <code>Mumps</code> object is destroyed by calling the <code>finalize()</code> method. Because <code>finalize</code> still issues MPI commands, it is important to call <code>finalize()</code> before calling <code>MPI.Finalize()</code>.</p><table><tr><th style="text-align: right">Method</th><th style="text-align: right">Description</th></tr><tr><td style="text-align: right"><code>finalize</code></td><td style="text-align: right">Finalize a <code>Mumps</code> object. Must be done before calling <code>MPI.Finalize()</code></td></tr><tr><td style="text-align: right"><code>associate_matrix!</code></td><td style="text-align: right">Register a matrix with the <code>Mumps</code> object. This function makes it possible to define the data on the host only.</td></tr><tr><td style="text-align: right"><code>factorize!</code></td><td style="text-align: right">Factorize the matrix registered with the <code>Mumps</code> object.</td></tr><tr><td style="text-align: right"><code>associate_rhs!</code></td><td style="text-align: right">Register right-hand sides with the <code>Mumps</code> object. This function makes it possible to define the data on the host only.</td></tr><tr><td style="text-align: right"><code>solve!</code></td><td style="text-align: right">Solve the linear system for the given right-hand side.</td></tr><tr><td style="text-align: right"><code>get_solution</code></td><td style="text-align: right">Retrieve the solution from the <code>Mumps</code> object. This function makes it possible for the solution to be assembled on the host only.</td></tr></table><h2 id="Parallel-Execution"><a class="docs-heading-anchor" href="#Parallel-Execution">Parallel Execution</a><a id="Parallel-Execution-1"></a><a class="docs-heading-anchor-permalink" href="#Parallel-Execution" title="Permalink"></a></h2><p>MPI is controled by way of <a href="https://github.com/JuliaParallel/MPI.jl">MPI.jl</a>. Look for the lines that say <code>NUMBER OF WORKING PROCESSES</code> in the output of</p><pre><code class="language-shell hljs">mpirun -np 4 julia examples/mumps_mpi.jl</code></pre><h2 id="Custom-Installation"><a class="docs-heading-anchor" href="#Custom-Installation">Custom Installation</a><a id="Custom-Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Custom-Installation" title="Permalink"></a></h2><p><strong>Note: MUMPS is already precompiled with Yggdrasil for all platforms except Windows.</strong></p><p>To use your custom MUMPS, set the environment variable <code>JULIA_MUMPS_LIBRARY_PATH</code> to point to the shared library before <code>using MUMPS</code>. Note that the same version of MUMPS as used by the <code>MUMPS_jll</code> artifact is needed.</p><p>For example, macOS users may install precompiled MUMPS binaries from the Homebrew tap <code>dpo/mumps-jl</code> as follows:</p><pre><code class="language-bash hljs">brew tap dpo/mumps-jl
 brew install mpich-mumps
-export JULIA_MUMPS_LIBRARY_PATH=$(brew --prefix)/opt/mpich-mumps/lib</code></pre><p>Apple Silicon users should remember to use <code>arch x86_64 brew</code> to refer to Intel binaries run through Rosetta, as we do not (yet) ship Silicon binaries of MUMPS via Homebrew.</p><p>The <code>JULIA_MUMPS_LIBRARY_PATH</code> environment variable may be set permanently in the shell&#39;s startup file, or in <code>$HOME/.julia/config/startup.jl</code>.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="api/">API »</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.8.0 on <span class="colophon-date" title="Thursday 12 December 2024 23:02">Thursday 12 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+export JULIA_MUMPS_LIBRARY_PATH=$(brew --prefix)/opt/mpich-mumps/lib</code></pre><p>Apple Silicon users should remember to use <code>arch x86_64 brew</code> to refer to Intel binaries run through Rosetta, as we do not (yet) ship Silicon binaries of MUMPS via Homebrew.</p><p>The <code>JULIA_MUMPS_LIBRARY_PATH</code> environment variable may be set permanently in the shell&#39;s startup file, or in <code>$HOME/.julia/config/startup.jl</code>.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="api/">API »</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.8.0 on <span class="colophon-date" title="Thursday 12 December 2024 23:16">Thursday 12 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>