You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
<!DOCTYPE html> |
|
|
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>LibHYPRE C API · HYPRE.jl</title><meta name="title" content="LibHYPRE C API · HYPRE.jl"/><meta property="og:title" content="LibHYPRE C API · HYPRE.jl"/><meta property="twitter:title" content="LibHYPRE C API · HYPRE.jl"/><meta name="description" content="Documentation for HYPRE.jl."/><meta property="og:description" content="Documentation for HYPRE.jl."/><meta property="twitter:description" content="Documentation for HYPRE.jl."/><meta property="og:url" content="https://fredrikekre.github.io/HYPRE.jl/stable/libhypre/"/><meta property="twitter:url" content="https://fredrikekre.github.io/HYPRE.jl/stable/libhypre/"/><link rel="canonical" href="https://fredrikekre.github.io/HYPRE.jl/stable/libhypre/"/><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.048/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.3.0/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.3.0/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.3.0/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.4/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="../siteinfo.js"></script><script src="../../versions.js"></script><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"><div class="docs-package-name"><span class="docs-autofit"><a href="../">HYPRE.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs (Ctrl + /)"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../matrix-vector/">Matrix/vector representation</a></li><li><a class="tocitem" href="../solvers-preconditioners/">Solvers and preconditioners</a></li><li class="is-active"><a class="tocitem" href>LibHYPRE C API</a></li><li><a class="tocitem" href="../api/">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"><div class="docs-left"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>LibHYPRE C API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>LibHYPRE C API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/fredrikekre/HYPRE.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/fredrikekre/HYPRE.jl/blob/master/docs/src/libhypre.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="LibHYPRE-C-API"><a class="docs-heading-anchor" href="#LibHYPRE-C-API">LibHYPRE C API</a><a id="LibHYPRE-C-API-1"></a><a class="docs-heading-anchor-permalink" href="#LibHYPRE-C-API" title="Permalink"></a></h1><p>The submodule <code>HYPRE.LibHYPRE</code> contains auto-generated bindings to the HYPRE library and give access to the HYPRE C API directly<sup class="footnote-reference"><a id="citeref-1" href="#footnote-1">[1]</a></sup>. The module exports all <code>HYPRE_*</code> symbols. Function names and arguments are identical to the C-library – refer to the <a href="https://hypre.readthedocs.io/">HYPRE manual</a> for details.</p><p>The example program <a href="https://github.com/fredrikekre/HYPRE.jl/blob/master/examples/ex5.jl"><code>examples/ex5.jl</code></a> is an (almost) line-to-line translation of the corresponding example program <a href="https://github.com/hypre-space/hypre/blob/ac9d7d0d7b43cd3d0c7f24ec5d64b58fbf900097/src/examples/ex5.c"><code>examples/ex5.c</code></a> written in C, and showcases how HYPRE.jl can be used to interact with the HYPRE library directly.</p><p>Functions from the <code>LibHYPRE</code> submodule can be used together with the high level interface. This is useful when you need some functionality from the library which isn't exposed in the high level interface. Many functions require passing a reference to a matrix/vector or a solver. HYPRE.jl defines the appropriate conversion methods used by <code>ccall</code> such that</p><ul><li><code>A::HYPREMatrix</code> can be passed to <code>HYPRE_*</code> functions with <code>HYPRE_IJMatrix</code> or <code>HYPRE_ParCSRMatrix</code> in the signature</li><li><code>b::HYPREVector</code> can be passed to <code>HYPRE_*</code> functions with <code>HYPRE_IJVector</code> or <code>HYPRE_ParVector</code> in the signature</li><li><code>s::HYPRESolver</code> can be passed to <code>HYPRE_*</code> functions with <code>HYPRE_Solver</code> in the signature</li></ul><section class="footnotes is-size-7"><ul><li class="footnote" id="footnote-1"><a class="tag is-link" href="#citeref-1">1</a>Bindings are generated using <a href="https://github.com/JuliaInterop/Clang.jl">Clang.jl</a>, see <a href="https://github.com/fredrikekre/HYPRE.jl/blob/master/gen/generator.jl">gen/generator.jl</a>.</li></ul></section></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../solvers-preconditioners/">« Solvers and preconditioners</a><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="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.28.0-DEV on <span class="colophon-date" title="Saturday 28 September 2024 21:55">Saturday 28 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|
|
|
|
