v0.12.0/LibCEED.html

<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Library configuration · LibCEED.jl Docs</title><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/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"/><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">LibCEED.jl Docs</span></div><form class="docs-search" action="search.html"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="index.html">Home</a></li><li><span class="tocitem">Ceed Objects</span><ul><li><a class="tocitem" href="Ceed.html">Ceed</a></li><li><a class="tocitem" href="CeedVector.html">CeedVector</a></li><li><a class="tocitem" href="ElemRestriction.html">ElemRestriction</a></li><li><a class="tocitem" href="Basis.html">Basis</a></li><li><a class="tocitem" href="QFunction.html">QFunction</a></li><li><a class="tocitem" href="Operator.html">Operator</a></li></ul></li><li><span class="tocitem">Utilities</span><ul><li><a class="tocitem" href="Misc.html">Linear Algebra</a></li><li><a class="tocitem" href="Globals.html">Constants and Enumerations</a></li><li><a class="tocitem" href="Quadrature.html">Quadrature</a></li></ul></li><li class="is-active"><a class="tocitem" href="LibCEED.html">Library configuration</a></li><li><a class="tocitem" href="C.html">Low-level C interface</a></li><li><a class="tocitem" href="UserQFunctions.html">Defining User Q-Functions</a></li><li><a class="tocitem" href="Examples.html">Examples</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href="LibCEED.html">Library configuration</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="LibCEED.html">Library configuration</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/CEED/libCEED/blob/master/julia/LibCEED.jl/docs/src/LibCEED.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Library-configuration"><a class="docs-heading-anchor" href="#Library-configuration">Library configuration</a><a id="Library-configuration-1"></a><a class="docs-heading-anchor-permalink" href="#Library-configuration" title="Permalink"></a></h1><p>By default, LibCEED.jl uses a &quot;basic version&quot; of the libCEED library that is bundled as a pre-built binary. In order to access more advanced features (CUDA support, architecture-specific compiler flags, etc.), users can use LibCEED.jl with a other versions of the libCEED library (e.g. compiled from source).</p><p>This is achieved by by calling <a href="LibCEED.html#LibCEED.set_libceed_path!"><code>set_libceed_path!</code></a> with the path to the library file. The choice of library file is stored as a per-environment preference. For changes to take effect, the Julia session must be restarted. The library currently being used by LibCEED.jl can be queried using <a href="LibCEED.html#LibCEED.get_libceed_path"><code>get_libceed_path</code></a>.</p><p>The version number of the currently loaded libCEED library can also be queried using <a href="LibCEED.html#LibCEED.ceedversion"><code>ceedversion</code></a>.</p><article class="docstring"><header><a class="docstring-binding" id="LibCEED.ceedversion" href="#LibCEED.ceedversion"><code>LibCEED.ceedversion</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">ceedversion()</code></pre><p>Returns a <code>VersionNumber</code> corresponding to the version of the libCEED library currently used.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/4018a20a98d451fac24765d3ddb936861647ce8d/julia/LibCEED.jl/src/LibCEED.jl#L173-L177">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.isrelease" href="#LibCEED.isrelease"><code>LibCEED.isrelease</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">isrelease()</code></pre><p>Returns true if the libCEED library is a release build, false otherwise.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/4018a20a98d451fac24765d3ddb936861647ce8d/julia/LibCEED.jl/src/LibCEED.jl#L187-L191">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.set_libceed_path!" href="#LibCEED.set_libceed_path!"><code>LibCEED.set_libceed_path!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">set_libceed_path!(path::AbstractString)
set_libceed_path!(:prebuilt)
set_libceed_path!(:default)</code></pre><p>Sets the path of the libCEED dynamic library. <code>path</code> should be the absolute path to the library file.</p><p><code>set_libceed_path!(:prebuilt)</code> indicates to LibCEED.jl to use the prebuilt version of the libCEED library (bundled with libCEED_jll).</p><p><code>set_libceed_path!(:default)</code> indicates to LibCEED.jl to use the default library. This usually has the same effect as <code>set_libceed_path!(:prebuilt)</code>, unless a different path has been specified in the depot-wide preferences or using <a href="https://pkgdocs.julialang.org/dev/artifacts/#Overriding-artifact-locations">Overrides.toml</a>.</p><p>This function sets the library path as a <em>preference</em> associated with the currently active environment. Changes will take effect after restarting the Julia session. See the <a href="https://github.com/JuliaPackaging/Preferences.jl">Preferences.jl documentation</a> for more information.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/4018a20a98d451fac24765d3ddb936861647ce8d/julia/LibCEED.jl/src/LibCEED.jl#L209-L228">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.use_prebuilt_libceed!" href="#LibCEED.use_prebuilt_libceed!"><code>LibCEED.use_prebuilt_libceed!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">use_prebuilt_libceed!()</code></pre><p>Indicates that the prebuilt version of the libCEED library (bundled with libCEED_jll) should be used.</p><p>Equivalent to <code>set_libceed_path!(:prebuilt)</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/4018a20a98d451fac24765d3ddb936861647ce8d/julia/LibCEED.jl/src/LibCEED.jl#L259-L266">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.get_libceed_path" href="#LibCEED.get_libceed_path"><code>LibCEED.get_libceed_path</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">get_libceed_path()</code></pre><p>Returns the path to the currently used libCEED library. A different libCEED library can be used by calling <a href="LibCEED.html#LibCEED.set_libceed_path!"><code>set_libceed_path!</code></a> or by using a depot-wide Overrides.toml file.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/4018a20a98d451fac24765d3ddb936861647ce8d/julia/LibCEED.jl/src/LibCEED.jl#L269-L274">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="Quadrature.html">« Quadrature</a><a class="docs-footer-nextpage" href="C.html">Low-level C interface »</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> on <span class="colophon-date" title="Wednesday 1 November 2023 06:18">Wednesday 1 November 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>