Skip to content

Commit

Permalink
build based on de6f4c3
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 1, 2023
1 parent f865eea commit 5d4b241
Show file tree
Hide file tree
Showing 26 changed files with 1,401 additions and 0 deletions.
21 changes: 21 additions & 0 deletions previews/PR37/CheatSheet/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Commands Cheat Sheet · HOHQMesh.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://trixi-framework.github.io/HOHQMesh.jl/stable/CheatSheet/"/><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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" 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="../">HOHQMesh.jl</a></span></div><form class="docs-search" action="../search/"><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="../">Home</a></li><li><span class="tocitem">Interactive mesh generation</span><ul><li><a class="tocitem" href="../interactive_overview/">Overview</a></li><li><a class="tocitem" href="../guided-tour/">Guided tour</a></li><li><a class="tocitem" href="../interactive-api/">API</a></li><li class="is-active"><a class="tocitem" href>Commands Cheat Sheet</a><ul class="internal"><li><a class="tocitem" href="#Project"><span>Project</span></a></li><li><a class="tocitem" href="#cs-plotting"><span>Plotting</span></a></li><li><a class="tocitem" href="#Curves"><span>Curves</span></a></li><li><a class="tocitem" href="#cs-manual-refinement"><span>Manual Refinement</span></a></li><li><a class="tocitem" href="#Adding-to-a-Project"><span>Adding to a Project</span></a></li><li><a class="tocitem" href="#Accessing-items"><span>Accessing items</span></a></li><li><a class="tocitem" href="#Removing-from-Project"><span>Removing from Project</span></a></li><li><a class="tocitem" href="#Editing-items"><span>Editing items</span></a></li><li><a class="tocitem" href="#Meshing"><span>Meshing</span></a></li></ul></li></ul></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="../tutorials/introduction/">Overview</a></li><li><a class="tocitem" href="../tutorials/straight_outer_boundary/">Straight-sided outer boundary</a></li><li><a class="tocitem" href="../tutorials/curved_outer_boundary/">Curved outer boundary</a></li><li><a class="tocitem" href="../tutorials/spline_curves/">Spline curves</a></li><li><a class="tocitem" href="../tutorials/create_edit_curves/">Creating and editing curves</a></li></ul></li><li><span class="tocitem">Advanced topics &amp; developers</span><ul><li><a class="tocitem" href="../development/">Development</a></li><li><a class="tocitem" href="../github-git/">GitHub &amp; Git</a></li><li><a class="tocitem" href="../testing/">Testing</a></li></ul></li><li><a class="tocitem" href="../reference/">Reference</a></li><li><a class="tocitem" href="../authors/">Authors</a></li><li><a class="tocitem" href="../contributing/">Contributing</a></li><li><a class="tocitem" href="../license/">License</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">Interactive mesh generation</a></li><li class="is-active"><a href>Commands Cheat Sheet</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Commands Cheat Sheet</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/trixi-framework/HOHQMesh.jl/blob/main/docs/src/CheatSheet.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="Commands-Cheat-Sheet"><a class="docs-heading-anchor" href="#Commands-Cheat-Sheet">Commands Cheat Sheet</a><a id="Commands-Cheat-Sheet-1"></a><a class="docs-heading-anchor-permalink" href="#Commands-Cheat-Sheet" title="Permalink"></a></h1><p>This provides a quick reference for the syntax of the interactive construction of boundary curves, background grid, etc. When possible, the commands presented below give generic versions of the function calls, e.g., for creating a new curve or adding the curve to a boundary chain. The script <code>interactive_outer_boundary_generic.jl</code> in the <code>examples</code> folder constructs an identical example mesh as shown in the <a href="../guided-tour/#Guided-tour">Guided tour</a> using generic function calls.</p><p>A thorough description of the functions can be found in the <a href="../interactive-api/#API">API</a> section.</p><p>The general workflow of the interactive mesh functionality within a REPL session is</p><ol><li>Create a project</li><li>Add boundary curves</li><li>Add a background grid</li><li>Add manual refinement (if desired)</li><li>Generate mesh</li></ol><h2 id="Project"><a class="docs-heading-anchor" href="#Project">Project</a><a id="Project-1"></a><a class="docs-heading-anchor-permalink" href="#Project" title="Permalink"></a></h2><pre><code class="nohighlight hljs"> p = newProject(&lt;projectName&gt;, &lt;folder&gt;)</code></pre><h2 id="cs-plotting"><a class="docs-heading-anchor" href="#cs-plotting">Plotting</a><a id="cs-plotting-1"></a><a class="docs-heading-anchor-permalink" href="#cs-plotting" title="Permalink"></a></h2><pre><code class="nohighlight hljs"> plotProject!(p, options)
updatePlot!(p, options)</code></pre><p>The <code>options</code> are any sum of <code>MODEL</code>, <code>GRID</code>, <code>REFINEMENTS</code>, and <code>MESH</code>.</p><h2 id="Curves"><a class="docs-heading-anchor" href="#Curves">Curves</a><a id="Curves-1"></a><a class="docs-heading-anchor-permalink" href="#Curves" title="Permalink"></a></h2><pre><code class="nohighlight hljs"> c = new(name, startLocation [x,y,z],endLocation [x,y,z]) *Straight Line*
c = new(name,center [x,y,z],radius, startAngle, endAngle) *Circular Arc*
c = new(name, xEqn, yEqn, zEqn) *Parametric equation*
c = new(name, dataFile) *Spline with data from a file*
c = new(name, nKnots, knotsMatrix) *Spline with given knot values*</code></pre><p>Shown here is the use of the function <code>new</code>, which is a shortcut to the full functions, e.g. <code>newCircularArcCurve</code>, etc. which have the same arguments.</p><h2 id="cs-manual-refinement"><a class="docs-heading-anchor" href="#cs-manual-refinement">Manual Refinement</a><a id="cs-manual-refinement-1"></a><a class="docs-heading-anchor-permalink" href="#cs-manual-refinement" title="Permalink"></a></h2><pre><code class="nohighlight hljs"> r = newRefinementCenter(name, center, gridSize, radius)
r = newRefinementLine(name, type, startPoint, endPoint, gridSize, width)</code></pre><h2 id="Adding-to-a-Project"><a class="docs-heading-anchor" href="#Adding-to-a-Project">Adding to a Project</a><a id="Adding-to-a-Project-1"></a><a class="docs-heading-anchor-permalink" href="#Adding-to-a-Project" title="Permalink"></a></h2><pre><code class="nohighlight hljs"> add!(p, c) *Add outer boundary curve*
add!(p, c, &lt;InnerBoundaryName&gt;) *Add curve to an inner boundary*
add!(p, r) *Add refinement region*

addBackgroundGrid!(p, [top, left, bottom, right], [nX, nY, nZ]) *No outer boundary*
addBackgroundGrid!(p, [dx, dy, dz]) *If an outer boundary is present*</code></pre><p>Shown here is the use of the function <code>add!</code>, which is a shortcut to the full functions, e.g. <code>addOuterBoundaryCurve</code>, etc. which have the same arguments.</p><h2 id="Accessing-items"><a class="docs-heading-anchor" href="#Accessing-items">Accessing items</a><a id="Accessing-items-1"></a><a class="docs-heading-anchor-permalink" href="#Accessing-items" title="Permalink"></a></h2><pre><code class="nohighlight hljs"> crv = getCurve(p, curveName) *Get a curve in the outer boundary*
crv = getCurve(p, curveName, boundaryName) *Get a curve in an inner boundary*
indx, chain = getChain(p, boundaryName) *Get a complete inner boundary curve*
r = getRefinementRegion(p, name)</code></pre><h2 id="Removing-from-Project"><a class="docs-heading-anchor" href="#Removing-from-Project">Removing from Project</a><a id="Removing-from-Project-1"></a><a class="docs-heading-anchor-permalink" href="#Removing-from-Project" title="Permalink"></a></h2><pre><code class="nohighlight hljs"> removeOuterboundary!(p) *Entire outer boundary curve*
removeInnerBoundary!(p, innerBoundaryName) *Entire inner boundary curve*
remove!(p, name) *Curve in outer boundary*
remove!(p, name, innerBoundaryName) *Curve in inner boundary*
removeRefinementRegion!(p, name)</code></pre><h2 id="Editing-items"><a class="docs-heading-anchor" href="#Editing-items">Editing items</a><a id="Editing-items-1"></a><a class="docs-heading-anchor-permalink" href="#Editing-items" title="Permalink"></a></h2><p>All items have set/get methods to edit them. Most actions have <code>undo()</code> and <code>redo()</code>. To find out what the next undo/redo actions are, use <code>undoActionName()</code> and <code>redoActionName()</code> to print them to the screen.</p><h2 id="Meshing"><a class="docs-heading-anchor" href="#Meshing">Meshing</a><a id="Meshing-1"></a><a class="docs-heading-anchor-permalink" href="#Meshing" title="Permalink"></a></h2><pre><code class="nohighlight hljs"> generate_mesh(p)
remove_mesh!(p)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../interactive-api/">« API</a><a class="docs-footer-nextpage" href="../tutorials/introduction/">Overview »</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> version 0.27.25 on <span class="colophon-date" title="Sunday 1 October 2023 09:22">Sunday 1 October 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 5d4b241

Please sign in to comment.