Skip to content

Commit

Permalink
build based on 7d24c24
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 1, 2024
1 parent a5e8173 commit dabfbc6
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-01T21:47:03","documenter_version":"1.6.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-01T22:02:36","documenter_version":"1.6.0"}}
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · SummationByParts.jl</title><meta name="title" content="Home · SummationByParts.jl"/><meta property="og:title" content="Home · SummationByParts.jl"/><meta property="twitter:title" content="Home · SummationByParts.jl"/><meta name="description" content="Documentation for SummationByParts.jl."/><meta property="og:description" content="Documentation for SummationByParts.jl."/><meta property="twitter:description" content="Documentation for SummationByParts.jl."/><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="search_index.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/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><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>SummationByParts.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Introduction"><span>Introduction</span></a></li><li><a class="tocitem" href="#Using-the-Package"><span>Using the Package</span></a></li></ul></li><li><a class="tocitem" href="reference/">Reference</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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/OptimalDesignLab/SummationByParts.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/OptimalDesignLab/SummationByParts.jl/blob/master/docs/src/index.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="SummationByParts"><a class="docs-heading-anchor" href="#SummationByParts">SummationByParts</a><a id="SummationByParts-1"></a><a class="docs-heading-anchor-permalink" href="#SummationByParts" title="Permalink"></a></h1><h2 id="Introduction"><a class="docs-heading-anchor" href="#Introduction">Introduction</a><a id="Introduction-1"></a><a class="docs-heading-anchor-permalink" href="#Introduction" title="Permalink"></a></h2><p>SummationByParts is a <a href="http://julialang.org">Julia</a> package that implements summation-by-parts (SBP) operators, which can be used to construct stable, high-order discretizations of partial differential equations. SBP operators are finite-difference operators, but they share much in common with finite-element operators. For more information about SBP methods, the following reviews are a great place to start:</p><ul><li><p>M. Svärd and Jan Nordström, <a href="&#39;http://dx.doi.org/10.1016/j.jcp.2014.02.031&#39;">&quot;Review of summation-by-parts schemes for initial–boundary-value problems,&quot;</a> <em>Journal of Computational Physics</em>, July, 2014.</p></li><li><p>D. Del Rey Fernández, J. Hicken, and D. Zingg, <a href="&#39;http://dx.doi.org/10.1016/j.compfluid.2014.02.016&#39;">&quot;Review of summation-by-parts operators with simultaneous approximation terms for the numerical solution of partial differential equations,&quot;</a> <em>Computers &amp; Fluids</em>, May, 2014.</p></li></ul><p>This package focuses on multidimensional SBP operators for the triangle and tetrahedral. For the theory behind multidimensional SBP operators, please see:</p><ul><li><p>J. Hicken, D. Del Rey Fernández, and D. Zingg, <a href="&#39;http://dx.doi.org/10.1137/15m1038360&#39;">&quot;Multidimensional Summation-by-Parts Operators: General Theory and Application to Simplex Elements,&quot;</a> <em>SIAM Journal on Scientific Computing</em>, July 06, 2016.</p></li><li><p>D. Del Rey Fernández, J. Hicken, and D. Zingg, <a href="&#39;https://doi.org/10.1007/s10915-017-0523-7&#39;">&quot;Simultaneous Approximation Terms for Multi-dimensional Summation-by-Parts Operators,&quot;</a> <em>Journal of Scientific Computing</em>, 2018.</p></li></ul><p>SummationByParts also provides functionality to construct high-order symmetric quadrature rules with positive weights on simplices. For details on construction of such quadrature rules, please see: </p><ul><li>Z. Worku, J. Hicken, D. Zingg, <a href="https://arxiv.org/abs/2311.15576">&quot;Quadrature Rules on Triangles and Tetrahedra for Multidimensional Summation-By-Parts Operators,&quot;</a> <em>Submitted to Journal of Scientific Computing</em>, 2024.</li></ul><h2 id="Using-the-Package"><a class="docs-heading-anchor" href="#Using-the-Package">Using the Package</a><a id="Using-the-Package-1"></a><a class="docs-heading-anchor-permalink" href="#Using-the-Package" title="Permalink"></a></h2><p>The following documentation provides a brief overview of how to use the SummationByParts package. This assumes the user has some familiarity with Julia. </p><h3 id="Building-SBP-operators"><a class="docs-heading-anchor" href="#Building-SBP-operators">Building SBP operators</a><a id="Building-SBP-operators-1"></a><a class="docs-heading-anchor-permalink" href="#Building-SBP-operators" title="Permalink"></a></h3><p>The construction of an SBP operator is best explained with an example. The following code produces a degree 3 (order 4) SBP operator on a triangle.</p><pre><code class="nohighlight hljs">using SummationByParts
sbp = SummationByParts.getTriSBPDiagE(degree=3)</code></pre><p>Here is another example, which shows how to construct a degree 2 SBP element on a tetrahedron (in this example, it has been assumed that the <code>using SummationByParts</code> statement has already been executed).</p><pre><code class="nohighlight hljs">sbp = SummationByParts.getTetSBPDiagE(degree=2,Tsbp=Float64)</code></pre><p>The SBP operators are parametrized; hence, one can specify the their type as examplified by the use of <code>Float64</code>. This means that the matrix fields inside the <code>sbp</code> type are <code>Float64</code> arrarys. </p><p>In general, we recommend using the SBP operators with methods provided by the package and that users <em>do not</em> rely on the fields of the sbp type directly. This is because we may, in the future, change the fields to support different SBP operators (or some fields may become obsolete). Nevertheless, for those who are curious, here is a partial list of the most important fields.</p><ul><li><code>sbp.degree</code> : maximum polynomial degree for which the derivatives are exact</li><li><code>sbp.numnodes</code> : number of nodes for the operator</li><li><code>sbp.vtx</code> : vertices of the reference element in computational space</li><li><code>sbp.w</code> : cubature weights, i.e. the diagonal SBP norm, stored as an array</li><li><code>sbp.Q[:,:,i]</code> : discrete stiffness matrix operator in ith coordinate </li></ul><p>For more information on the usage of the SummationByPart.jl package, please refer to the <a href="https://github.com/OptimalDesignLab/SummationByParts.jl/tree/master/examples">examples</a>.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="reference/">Reference »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Sunday 1 September 2024 21:47">Sunday 1 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
sbp = SummationByParts.getTriSBPDiagE(degree=3)</code></pre><p>Here is another example, which shows how to construct a degree 2 SBP element on a tetrahedron (in this example, it has been assumed that the <code>using SummationByParts</code> statement has already been executed).</p><pre><code class="nohighlight hljs">sbp = SummationByParts.getTetSBPDiagE(degree=2,Tsbp=Float64)</code></pre><p>The SBP operators are parametrized; hence, one can specify the their type as examplified by the use of <code>Float64</code>. This means that the matrix fields inside the <code>sbp</code> type are <code>Float64</code> arrarys. </p><p>In general, we recommend using the SBP operators with methods provided by the package and that users <em>do not</em> rely on the fields of the sbp type directly. This is because we may, in the future, change the fields to support different SBP operators (or some fields may become obsolete). Nevertheless, for those who are curious, here is a partial list of the most important fields.</p><ul><li><code>sbp.degree</code> : maximum polynomial degree for which the derivatives are exact</li><li><code>sbp.numnodes</code> : number of nodes for the operator</li><li><code>sbp.vtx</code> : vertices of the reference element in computational space</li><li><code>sbp.w</code> : cubature weights, i.e. the diagonal SBP norm, stored as an array</li><li><code>sbp.Q[:,:,i]</code> : discrete stiffness matrix operator in ith coordinate </li></ul><p>For more information on the usage of the SummationByPart.jl package, please refer to the <a href="https://github.com/OptimalDesignLab/SummationByParts.jl/tree/master/examples">examples</a>.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="reference/">Reference »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Sunday 1 September 2024 22:02">Sunday 1 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
4 changes: 2 additions & 2 deletions dev/reference/index.html
View file

Large diffs are not rendered by default.

0 comments on commit dabfbc6

Please sign in to comment.