-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCeed.html
2 lines (2 loc) · 8.32 KB
/
Ceed.html
1
2
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Ceed · 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 class="is-active"><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><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><a class="is-disabled">Ceed Objects</a></li><li class="is-active"><a href="Ceed.html">Ceed</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="Ceed.html">Ceed</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/Ceed.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="Ceed"><a class="docs-heading-anchor" href="#Ceed">Ceed</a><a id="Ceed-1"></a><a class="docs-heading-anchor-permalink" href="#Ceed" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="LibCEED.Ceed" href="#LibCEED.Ceed"><code>LibCEED.Ceed</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Ceed(spec="/cpu/self")</code></pre><p>Wraps a libCEED <code>Ceed</code> object, created with the given resource specification string.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/4018a20a98d451fac24765d3ddb936861647ce8d/julia/LibCEED.jl/src/Ceed.jl#L44-L48">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.getresource" href="#LibCEED.getresource"><code>LibCEED.getresource</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">getresource(c::Ceed)</code></pre><p>Returns the resource string associated with the given <a href="Ceed.html#LibCEED.Ceed"><code>Ceed</code></a> object.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/4018a20a98d451fac24765d3ddb936861647ce8d/julia/LibCEED.jl/src/Ceed.jl#L69-L73">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.get_preferred_memtype" href="#LibCEED.get_preferred_memtype"><code>LibCEED.get_preferred_memtype</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">get_preferred_memtype(c::Ceed)</code></pre><p>Returns the preferred <a href="Globals.html#LibCEED.MemType"><code>MemType</code></a> (either <code>MEM_HOST</code> or <code>MEM_DEVICE</code>) of the given <a href="Ceed.html#LibCEED.Ceed"><code>Ceed</code></a> object.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/4018a20a98d451fac24765d3ddb936861647ce8d/julia/LibCEED.jl/src/Ceed.jl#L92-L97">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.isdeterministic" href="#LibCEED.isdeterministic"><code>LibCEED.isdeterministic</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">isdeterministic(c::Ceed)</code></pre><p>Returns true if backend of the given <a href="Ceed.html#LibCEED.Ceed"><code>Ceed</code></a> object is deterministic, and false otherwise.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/4018a20a98d451fac24765d3ddb936861647ce8d/julia/LibCEED.jl/src/Ceed.jl#L80-L85">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.iscuda" href="#LibCEED.iscuda"><code>LibCEED.iscuda</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">iscuda(c::Ceed)</code></pre><p>Returns true if the given <a href="Ceed.html#LibCEED.Ceed"><code>Ceed</code></a> object has resource <code>"/gpu/cuda/*"</code> and false otherwise.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/4018a20a98d451fac24765d3ddb936861647ce8d/julia/LibCEED.jl/src/Ceed.jl#L104-L109">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="index.html">« Home</a><a class="docs-footer-nextpage" href="CeedVector.html">CeedVector »</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>