-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Dec 4, 2024
1 parent
f0f762d
commit ea196fc
Showing
22 changed files
with
397 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| {"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-04T19:18:56","documenter_version":"1.8.0"}} | ||
| {"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-04T21:59:18","documenter_version":"1.8.0"}} |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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>ASCII Operators · Decapodes.jl</title><meta name="title" content="ASCII Operators · Decapodes.jl"/><meta property="og:title" content="ASCII Operators · Decapodes.jl"/><meta property="twitter:title" content="ASCII Operators · Decapodes.jl"/><meta name="description" content="Documentation for Decapodes.jl."/><meta property="og:description" content="Documentation for Decapodes.jl."/><meta property="twitter:description" content="Documentation for Decapodes.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><script src="../assets/analytics.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Decapodes.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><a class="tocitem" href="../">Decapodes.jl</a></li><li><a class="tocitem" href="../overview/overview/">Overview</a></li><li><a class="tocitem" href="../equations/equations/">Equations</a></li><li><a class="tocitem" href="../navier_stokes/ns/">Vortices</a></li><li><a class="tocitem" href="../harmonics/harmonics/">Harmonics</a></li><li><a class="tocitem" href="../ch/cahn-hilliard/">Cahn-Hilliard</a></li><li><a class="tocitem" href="../klausmeier/klausmeier/">Klausmeier</a></li><li><a class="tocitem" href="../cism/cism/">CISM v2.1</a></li><li><a class="tocitem" href="../ice_dynamics/ice_dynamics/">Glacial Flow</a></li><li><a class="tocitem" href="../grigoriev/grigoriev/">Grigoriev Ice Cap</a></li><li><a class="tocitem" href="../bsh/budyko_sellers_halfar/">Budyko-Sellers-Halfar</a></li><li><a class="tocitem" href="../ebm_melt/ebm_melt/">Halfar-EBM-Water</a></li><li><a class="tocitem" href="../halmo/halmo/">Halfar-NS</a></li><li><a class="tocitem" href="../nhs/nhs_lite/">NHS</a></li><li><a class="tocitem" href="../poiseuille/poiseuille/">Pipe Flow</a></li><li><a class="tocitem" href="../bc/bc_debug/">Misc Features</a></li><li class="is-active"><a class="tocitem" href>ASCII Operators</a><ul class="internal"><li><a class="tocitem" href="#ASCII-Equivalents"><span>ASCII Equivalents</span></a></li><li><a class="tocitem" href="#Vector-Calculus-Equivalents"><span>Vector Calculus Equivalents</span></a></li></ul></li><li><a class="tocitem" href="../canon/">Canonical Models</a></li><li><a class="tocitem" href="../api/">Library 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>ASCII Operators</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>ASCII Operators</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/AlgebraicJulia/Decapodes.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/AlgebraicJulia/Decapodes.jl/blob/main/docs/src/ascii.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="ASCII-and-Vector-Calculus-Operators"><a class="docs-heading-anchor" href="#ASCII-and-Vector-Calculus-Operators">ASCII and Vector Calculus Operators</a><a id="ASCII-and-Vector-Calculus-Operators-1"></a><a class="docs-heading-anchor-permalink" href="#ASCII-and-Vector-Calculus-Operators" title="Permalink"></a></h1><p>Some users may have trouble entering unicode characters like ⋆ or ∂ in their development environment. So, we offer the following ASCII equivalents. Further, some users may like to use vector calculus symbols instead of exterior calculus symbols where possible. We offer support for such symbols as well.</p><h2 id="ASCII-Equivalents"><a class="docs-heading-anchor" href="#ASCII-Equivalents">ASCII Equivalents</a><a id="ASCII-Equivalents-1"></a><a class="docs-heading-anchor-permalink" href="#ASCII-Equivalents" title="Permalink"></a></h2><table><tr><th style="text-align: right">Unicode</th><th style="text-align: right">ASCII</th><th style="text-align: right">Meaning</th></tr><tr><td style="text-align: right">∂ₜ</td><td style="text-align: right">dt</td><td style="text-align: right">derivative w.r.t. time</td></tr><tr><td style="text-align: right">⋆</td><td style="text-align: right">star</td><td style="text-align: right">Hodge star, generalizing transpose</td></tr><tr><td style="text-align: right">Δ</td><td style="text-align: right">lapl</td><td style="text-align: right">laplacian</td></tr><tr><td style="text-align: right">∧</td><td style="text-align: right">wedge</td><td style="text-align: right">wedge product, generalizing the cross product</td></tr><tr><td style="text-align: right">⋆⁻¹</td><td style="text-align: right">star_inv</td><td style="text-align: right">Hodge star, generalizing transpose</td></tr><tr><td style="text-align: right">∘(⋆,d,⋆)</td><td style="text-align: right">div</td><td style="text-align: right">divergence, a.k.a. ∇⋅</td></tr><tr><td style="text-align: right">avg₀₁</td><td style="text-align: right">avg_01</td><td style="text-align: right">average values stored on endpoints of edges</td></tr></table><h2 id="Vector-Calculus-Equivalents"><a class="docs-heading-anchor" href="#Vector-Calculus-Equivalents">Vector Calculus Equivalents</a><a id="Vector-Calculus-Equivalents-1"></a><a class="docs-heading-anchor-permalink" href="#Vector-Calculus-Equivalents" title="Permalink"></a></h2><table><tr><th style="text-align: right">Vec</th><th style="text-align: right">DEC</th><th style="text-align: right">How to enter</th></tr><tr><td style="text-align: right">grad</td><td style="text-align: right">d</td><td style="text-align: right">grad</td></tr><tr><td style="text-align: right">div</td><td style="text-align: right">∘(⋆,d,⋆)</td><td style="text-align: right">div</td></tr><tr><td style="text-align: right">curl</td><td style="text-align: right">∘(d,⋆)</td><td style="text-align: right">curl</td></tr><tr><td style="text-align: right">∇</td><td style="text-align: right">d</td><td style="text-align: right">\nabla</td></tr><tr><td style="text-align: right">∇ᵈ</td><td style="text-align: right">∘(⋆,d,⋆)</td><td style="text-align: right">\nabla \<tab\> \^d \<tab\></td></tr><tr><td style="text-align: right">∇x</td><td style="text-align: right">∘(d,⋆)</td><td style="text-align: right">\nabla \<tab\> x</td></tr><tr><td style="text-align: right">adv(X,Y)</td><td style="text-align: right">∘(⋆,d,⋆)(X∧Y)</td><td style="text-align: right">adv</td></tr></table><pre class="documenter-example-output"><code class="nohighlight hljs ansi">[ Info: Page built in 0 seconds. | ||
| [ Info: This page was last built at 2024-12-04T18:58:52.106.</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../bc/bc_debug/">« Misc Features</a><a class="docs-footer-nextpage" href="../canon/">Canonical Models »</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.8.0 on <span class="colophon-date" title="Wednesday 4 December 2024 19:18">Wednesday 4 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
| [ Info: This page was last built at 2024-12-04T21:39:19.349.</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../bc/bc_debug/">« Misc Features</a><a class="docs-footer-nextpage" href="../canon/">Canonical Models »</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.8.0 on <span class="colophon-date" title="Wednesday 4 December 2024 21:59">Wednesday 4 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.