Add interactive HQMTool and testing

.github/workflows/DocPreviewCleanup.yml

@@ -0,0 +1,32 @@
+name: Doc Preview Cleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  doc-preview-cleanup:
+    # Do not run on forks to avoid authorization errors
+    # Source: https://github.community/t/have-github-action-only-run-on-master-repo-and-not-on-forks/140840/18
+    if: github.repository_owner == 'trixi-framework'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v2
+        with:
+          ref: gh-pages
+
+      - name: Delete preview and history
+        shell: bash
+        run: |
+            git config user.name "Documenter.jl"
+            git config user.email "[email protected]"
+            git rm -rf --ignore-unmatch "previews/PR$PRNUM"
+            git commit -m "delete preview" --allow-empty
+            git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+        env:
+            PRNUM: ${{ github.event.number }}
+
+      - name: Push changes
+        run: |
+            git push --force origin gh-pages-new:gh-pages

.gitignore

@@ -6,3 +6,5 @@ coverage/
 coverage_report/
 **/*.jl.*.cov
 .vscode/
+examples/*.tec
+examples/*.mesh

LICENSE.md

@@ -1,21 +1,21 @@
 MIT License
 
-Copyright (c) 2021-present Michael Schlottke-Lakemper
+Copyright (c) 2021-present David Kopriva, Andrew Winters, and Michael Schlottke-Lakemper
 
-Permission is hereby granted, free of charge, to any person obtaining a copy  
-of this software and associated documentation files (the "Software"), to deal  
-in the Software without restriction, including without limitation the rights  
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell  
-copies of the Software, and to permit persons to whom the Software is  
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all  
+The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR  
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE  
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER  
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

Project.toml

@@ -5,7 +5,9 @@ version = "0.1.2-pre"
 
 [deps]
 HOHQMesh_jll = "1d5cbd98-5122-5a8a-bea1-c186d986ee7f"
+Requires = "ae029012-a4dd-5104-9daa-d747884805df"
 
 [compat]
 HOHQMesh_jll = "1.0"
+Requires = "1.1.3"
 julia = "1.6"

docs/make.jl

@@ -23,6 +23,8 @@ makedocs(
     # Explicitly specify documentation structure
     pages = [
         "Home" => "index.md",
+        "Interactive mesh generation" => "HQMTool.md",
+        "Cheat sheet" => "CheatSheet.md",
         "Reference" => "reference.md",
         "License" => "license.md"
     ],
@@ -32,5 +34,5 @@ makedocs(
 deploydocs(
     repo = "github.com/trixi-framework/HOHQMesh.jl",
     devbranch = "main",
-    # push_preview = true
+    push_preview = true
 )

docs/src/CheatSheet.md

@@ -0,0 +1,86 @@
+# HQMTool CheatSheet
+
+Workflow:
+
+1. Create a project
+2. Add boundary curves
+4. Add a background grid
+3. Add manual refinement (if desired)
+5. Generate mesh
+
+## Project
+
+```
+   p = newProject(<projectName>, <folder>)
+```
+
+## [Plotting](@id cs-plotting)
+
+```
+   plotProject!(p, options)
+   updatePlot!(p, options)
+```
+
+`options` are the sum of `GRID`, `MESH`, `MODEL`, `REFINEMENTS`
+## Curves
+
+```
+   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*
+```
+
+Shown here is the use of the function `new`, which is a shortcut to the full functions, e.g. `newCircularArcCurve`, etc. which have the same arguments.
+
+## [Manual Refinement](@id cs-manual-refinement)
+
+```
+   r = newRefinementCenter(name, center, gridSize, radius)
+   r = newRefinementLine(name, type, startPoint, endPoint, gridSize, width)
+```
+
+## Adding to a Project
+
+```
+   add!(p, c)                        *Add outer boundary curve*
+   add!(p, c, <InnerBoundaryName>)   *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*
+```
+Shown here is the use of the function `add!`, which is a shortcut to the full functions, e.g. `addOuterBoundaryCurve`, etc. which have the same arguments.
+
+## Accessing items
+
+```
+   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)
+```
+
+## Removing from Project
+
+```
+   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)
+```
+
+## Editing items
+
+All items have set/get methods to edit them. Most actions have `undo()` and `redo()`.
+To find out what the next undo/redo actions are, use `undoActionName()` and `redoActionName()`
+to print them to the screen.
+
+## Meshing
+
+```
+   generate_mesh(p)
+   remove_mesh!(p)
+```