-
Notifications
You must be signed in to change notification settings - Fork 0
/
Globals.html
2 lines (2 loc) · 11.7 KB
/
Globals.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>Constants and Enumerations · 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 class="is-active"><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">Utilities</a></li><li class="is-active"><a href="Globals.html">Constants and Enumerations</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="Globals.html">Constants and Enumerations</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/Globals.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="Constants-and-Enumerations"><a class="docs-heading-anchor" href="#Constants-and-Enumerations">Constants and Enumerations</a><a id="Constants-and-Enumerations-1"></a><a class="docs-heading-anchor-permalink" href="#Constants-and-Enumerations" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="LibCEED.CeedScalar" href="#LibCEED.CeedScalar"><code>LibCEED.CeedScalar</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">CeedScalar</code></pre><p>Scalar (floating point) type. Equivalent to <code>Float64</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Globals.jl#L1-L5">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.CeedInt" href="#LibCEED.CeedInt"><code>LibCEED.CeedInt</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">CeedInt</code></pre><p>Integer type, used for indexing. Equivalent to <code>Int32</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Globals.jl#L8-L12">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.QuadMode" href="#LibCEED.QuadMode"><code>LibCEED.QuadMode</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">QuadMode</code></pre><p>One of <code>GAUSS</code> or <code>GAUSS_LOBATTO</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Globals.jl#L15-L19">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.MemType" href="#LibCEED.MemType"><code>LibCEED.MemType</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">MemType</code></pre><p>One of <code>MEM_HOST</code> or <code>MEM_DEVICE</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Globals.jl#L24-L28">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.CopyMode" href="#LibCEED.CopyMode"><code>LibCEED.CopyMode</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">CopyMode</code></pre><p>One of <code>COPY_VALUES</code>, <code>USE_POINTER</code> or <code>OWN_POINTER</code>.</p><p><code>OWN_POINTER</code> is not typically supported for objects created in Julia, because those must be destroyed by the garbage collector, and cannot be freed from C.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Globals.jl#L33-L40">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.EvalMode" href="#LibCEED.EvalMode"><code>LibCEED.EvalMode</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">EvalMode</code></pre><p>Evaluation mode used in the specification of input and output fields for Q-functions, e.g. in <a href="QFunction.html#LibCEED.@interior_qf"><code>@interior_qf</code></a>.</p><p>One of:</p><ul><li><code>EVAL_NONE</code></li><li><code>EVAL_INTERP</code></li><li><code>EVAL_GRAD</code></li><li><code>EVAL_DIV</code></li><li><code>EVAL_CURL</code></li><li><code>EVAL_WEIGHT</code></li></ul><p>See the <a href="https://libceed.org/en/latest/api/CeedBasis/?highlight=EVAL_MODE#c.CeedEvalMode">libCEED documentation</a> for further information.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Globals.jl#L46-L63">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.TransposeMode" href="#LibCEED.TransposeMode"><code>LibCEED.TransposeMode</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">TransposeMose</code></pre><p>Denotes whether a linear transformation or its transpose should be applied. Either <code>NOTRANSPOSE</code> or <code>TRANSPOSE</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Globals.jl#L82-L87">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.NormType" href="#LibCEED.NormType"><code>LibCEED.NormType</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">NormType</code></pre><p>Denotes type of vector norm. One of <code>NORM_1</code>, <code>NORM_2</code>, or <code>NORM_MAX</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Globals.jl#L72-L76">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.Topology" href="#LibCEED.Topology"><code>LibCEED.Topology</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Topology</code></pre><p>Type of basis shape to create non-tensor H1 element basis. One of <code>LINE</code>, <code>TRIANGLE</code>, <code>QUAD</code>, <code>TET</code>, <code>PYRAMID</code>, <code>PRISM</code>, or <code>HEX</code>.</p><p>The dimension can be extracted with bitshift:</p><pre><code class="language-none">dim = Int(topology) >> 16</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Globals.jl#L92-L101">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.STRIDES_BACKEND" href="#LibCEED.STRIDES_BACKEND"><code>LibCEED.STRIDES_BACKEND</code></a> — <span class="docstring-category">Constant</span></header><section><div><pre><code class="language-julia">STRIDES_BACKEND</code></pre><p>Indicate that the stride is determined by the backend.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Globals.jl#L112-L116">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="Misc.html">« Linear Algebra</a><a class="docs-footer-nextpage" href="Quadrature.html">Quadrature »</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="Monday 11 April 2022 23:12">Monday 11 April 2022</span>. Using Julia version 1.7.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>