v0.10.1/Operator.html

<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Operator · 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 class="is-active"><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="Operator.html">Operator</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="Operator.html">Operator</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/Operator.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="Operator"><a class="docs-heading-anchor" href="#Operator">Operator</a><a id="Operator-1"></a><a class="docs-heading-anchor-permalink" href="#Operator" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="LibCEED.Operator" href="#LibCEED.Operator"><code>LibCEED.Operator</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Operator(ceed::Ceed; qf, dqf=QFunctionNone(), dqfT=QFunctionNone(), fields)</code></pre><p>Creates a libCEED <code>CeedOperator</code> object using the given Q-function <code>qf</code>, and optionally its derivative and derivative transpose.</p><p>An array of fields must be provided, where each element of the array is a tuple containing the name of the field (as a string or symbol), the corresponding element restriction, basis, and vector.</p><p><strong>Examples</strong></p><p>Create the operator that builds the Q-data associated with the mass matrix.</p><pre><code class="language-none">build_oper = Operator(
    ceed,
    qf=build_qfunc,
    fields=[
        (:J, mesh_restr, mesh_basis, CeedVectorActive()),
        (:w, ElemRestrictionNone(), mesh_basis, CeedVectorNone()),
        (:qdata, sol_restr_i, BasisCollocated(), CeedVectorActive())
    ]
)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Operator.jl#L20-L44">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.create_composite_operator" href="#LibCEED.create_composite_operator"><code>LibCEED.create_composite_operator</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">create_composite_operator(c::Ceed, ops)</code></pre><p>Create an <a href="Operator.html#LibCEED.Operator"><code>Operator</code></a> whose action represents the sum of the operators in the collection <code>ops</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Operator.jl#L64-L69">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.apply!-Tuple{Operator, LibCEED.AbstractCeedVector, LibCEED.AbstractCeedVector}" href="#LibCEED.apply!-Tuple{Operator, LibCEED.AbstractCeedVector, LibCEED.AbstractCeedVector}"><code>LibCEED.apply!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia">apply!(op::Operator, vin, vout; request=RequestImmediate())</code></pre><p>Apply the action of the operator <code>op</code> to the input vector <code>vin</code>, and store the result in the output vector <code>vout</code>.</p><p>For non-blocking application, the user can specify a request object. By default, immediate (synchronous) completion is requested.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Operator.jl#L91-L99">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.apply_add!" href="#LibCEED.apply_add!"><code>LibCEED.apply_add!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">apply_add!(op::Operator, vin, vout; request=RequestImmediate())</code></pre><p>Apply the action of the operator <code>op</code> to the input vector <code>vin</code>, and add the result to the output vector <code>vout</code>.</p><p>For non-blocking application, the user can specify a request object. By default, immediate (synchronous) completion is requested.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Operator.jl#L109-L117">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.assemble_diagonal!" href="#LibCEED.assemble_diagonal!"><code>LibCEED.assemble_diagonal!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">assemble_diagonal!(op::Operator, diag::CeedVector; request=RequestImmediate())</code></pre><p>Overwrites a <a href="CeedVector.html#LibCEED.CeedVector"><code>CeedVector</code></a> with the diagonal of a linear <a href="Operator.html#LibCEED.Operator"><code>Operator</code></a>.</p><div class="admonition is-info"><header class="admonition-header">Note:</header><div class="admonition-body"><p>Currently only <a href="Operator.html#LibCEED.Operator"><code>Operator</code></a>s with a single field are supported.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Operator.jl#L127-L134">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="LibCEED.assemble_add_diagonal!" href="#LibCEED.assemble_add_diagonal!"><code>LibCEED.assemble_add_diagonal!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">assemble_diagonal!(op::Operator, diag::CeedVector; request=RequestImmediate())</code></pre><p>Adds the diagonal of a linear <a href="Operator.html#LibCEED.Operator"><code>Operator</code></a> to the given <a href="CeedVector.html#LibCEED.CeedVector"><code>CeedVector</code></a>.</p><div class="admonition is-info"><header class="admonition-header">Note:</header><div class="admonition-body"><p>Currently only <a href="Operator.html#LibCEED.Operator"><code>Operator</code></a>s with a single field are supported.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CEED/libCEED/blob/74532b27052d94e943eb8bc76257fbd710103614/julia/LibCEED.jl/src/Operator.jl#L139-L146">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="QFunction.html">« QFunction</a><a class="docs-footer-nextpage" href="Misc.html">Linear Algebra »</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>