build based on 315a58f

trixi-framework · Feb 7, 2024 · ed8ced8 · ed8ced8
1 parent 67925cc
commit ed8ced8
Show file tree

Hide file tree

Showing 140 changed files with 31,851 additions and 23,273 deletions.
diff --git a/previews/PR1816/.documenter-siteinfo.json b/previews/PR1816/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-02-05T18:49:51","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-02-07T10:57:59","documenter_version":"1.2.1"}}
diff --git a/previews/PR1816/authors/index.html b/previews/PR1816/authors/index.html
diff --git a/previews/PR1816/callbacks/index.html b/previews/PR1816/callbacks/index.html
diff --git a/previews/PR1816/code_of_conduct/index.html b/previews/PR1816/code_of_conduct/index.html
diff --git a/previews/PR1816/contributing/index.html b/previews/PR1816/contributing/index.html
diff --git a/previews/PR1816/conventions/index.html b/previews/PR1816/conventions/index.html
diff --git a/previews/PR1816/development/index.html b/previews/PR1816/development/index.html
diff --git a/previews/PR1816/github-git/index.html b/previews/PR1816/github-git/index.html
diff --git a/previews/PR1816/index.html b/previews/PR1816/index.html
diff --git a/previews/PR1816/license/index.html b/previews/PR1816/license/index.html
diff --git a/previews/PR1816/meshes/dgmulti_mesh/index.html b/previews/PR1816/meshes/dgmulti_mesh/index.html
diff --git a/previews/PR1816/meshes/p4est_mesh/index.html b/previews/PR1816/meshes/p4est_mesh/index.html
diff --git a/previews/PR1816/meshes/structured_mesh/index.html b/previews/PR1816/meshes/structured_mesh/index.html
diff --git a/previews/PR1816/meshes/tree_mesh/index.html b/previews/PR1816/meshes/tree_mesh/index.html
diff --git a/previews/PR1816/meshes/unstructured_quad_mesh/index.html b/previews/PR1816/meshes/unstructured_quad_mesh/index.html
diff --git a/previews/PR1816/multi-physics_coupling/index.html b/previews/PR1816/multi-physics_coupling/index.html
diff --git a/previews/PR1816/overview/index.html b/previews/PR1816/overview/index.html
diff --git a/previews/PR1816/parallelization/index.html b/previews/PR1816/parallelization/index.html
diff --git a/previews/PR1816/performance/index.html b/previews/PR1816/performance/index.html
diff --git a/previews/PR1816/reference-trixi/index.html b/previews/PR1816/reference-trixi/index.html
diff --git a/previews/PR1816/reference-trixi2vtk/index.html b/previews/PR1816/reference-trixi2vtk/index.html
diff --git a/previews/PR1816/restart/index.html b/previews/PR1816/restart/index.html
diff --git a/previews/PR1816/search_index.js b/previews/PR1816/search_index.js
diff --git a/previews/PR1816/styleguide/index.html b/previews/PR1816/styleguide/index.html
diff --git a/previews/PR1816/testing/index.html b/previews/PR1816/testing/index.html
diff --git a/previews/PR1816/time_integration/index.html b/previews/PR1816/time_integration/index.html
diff --git a/previews/PR1816/troubleshooting/index.html b/previews/PR1816/troubleshooting/index.html
diff --git a/...s/PR1816/tutorials/DGMulti_1/37f737fc.svg → ...s/PR1816/tutorials/DGMulti_1/07da02ff.svg b/...s/PR1816/tutorials/DGMulti_1/37f737fc.svg → ...s/PR1816/tutorials/DGMulti_1/07da02ff.svg
diff --git a/...s/PR1816/tutorials/DGMulti_1/b58cffd1.svg → ...s/PR1816/tutorials/DGMulti_1/21894830.svg b/...s/PR1816/tutorials/DGMulti_1/b58cffd1.svg → ...s/PR1816/tutorials/DGMulti_1/21894830.svg
diff --git a/...s/PR1816/tutorials/DGMulti_1/1d84e625.svg → ...s/PR1816/tutorials/DGMulti_1/2c0a5629.svg b/...s/PR1816/tutorials/DGMulti_1/1d84e625.svg → ...s/PR1816/tutorials/DGMulti_1/2c0a5629.svg
diff --git a/...s/PR1816/tutorials/DGMulti_1/18e4f7fc.svg → ...s/PR1816/tutorials/DGMulti_1/5020db4c.svg b/...s/PR1816/tutorials/DGMulti_1/18e4f7fc.svg → ...s/PR1816/tutorials/DGMulti_1/5020db4c.svg
diff --git a/...s/PR1816/tutorials/DGMulti_1/e8732d47.svg → ...s/PR1816/tutorials/DGMulti_1/82740764.svg b/...s/PR1816/tutorials/DGMulti_1/e8732d47.svg → ...s/PR1816/tutorials/DGMulti_1/82740764.svg
diff --git a/...s/PR1816/tutorials/DGMulti_1/1594f390.svg → ...s/PR1816/tutorials/DGMulti_1/f1845976.svg b/...s/PR1816/tutorials/DGMulti_1/1594f390.svg → ...s/PR1816/tutorials/DGMulti_1/f1845976.svg
diff --git a/previews/PR1816/tutorials/DGMulti_1/index.html b/previews/PR1816/tutorials/DGMulti_1/index.html
diff --git a/previews/PR1816/tutorials/DGMulti_2/index.html b/previews/PR1816/tutorials/DGMulti_2/index.html
diff --git a/...816/tutorials/DGSEM_FluxDiff/06fd4456.svg → ...816/tutorials/DGSEM_FluxDiff/383ef7fc.svg b/...816/tutorials/DGSEM_FluxDiff/06fd4456.svg → ...816/tutorials/DGSEM_FluxDiff/383ef7fc.svg
diff --git a/...816/tutorials/DGSEM_FluxDiff/62c83852.svg → ...816/tutorials/DGSEM_FluxDiff/7f0fc714.svg b/...816/tutorials/DGSEM_FluxDiff/62c83852.svg → ...816/tutorials/DGSEM_FluxDiff/7f0fc714.svg
diff --git a/previews/PR1816/tutorials/DGSEM_FluxDiff/index.html b/previews/PR1816/tutorials/DGSEM_FluxDiff/index.html
diff --git a/...als/adaptive_mesh_refinement/f6d49c7f.svg → ...als/adaptive_mesh_refinement/c5ecd560.svg b/...als/adaptive_mesh_refinement/f6d49c7f.svg → ...als/adaptive_mesh_refinement/c5ecd560.svg
diff --git a/previews/PR1816/tutorials/adaptive_mesh_refinement/index.html b/previews/PR1816/tutorials/adaptive_mesh_refinement/index.html
diff --git a/...s/adding_new_parabolic_terms/a779e0ce.svg → ...s/adding_new_parabolic_terms/2d6f544e.svg b/...s/adding_new_parabolic_terms/a779e0ce.svg → ...s/adding_new_parabolic_terms/2d6f544e.svg
diff --git a/previews/PR1816/tutorials/adding_new_parabolic_terms/index.html b/previews/PR1816/tutorials/adding_new_parabolic_terms/index.html
diff --git a/.../adding_new_scalar_equations/a0f8da29.svg → .../adding_new_scalar_equations/42f6fcf1.svg b/.../adding_new_scalar_equations/a0f8da29.svg → .../adding_new_scalar_equations/42f6fcf1.svg
diff --git a/.../adding_new_scalar_equations/c54905fd.svg → .../adding_new_scalar_equations/77f9d63b.svg b/.../adding_new_scalar_equations/c54905fd.svg → .../adding_new_scalar_equations/77f9d63b.svg
diff --git a/.../adding_new_scalar_equations/ae2f6aa3.svg → .../adding_new_scalar_equations/9b365d89.svg b/.../adding_new_scalar_equations/ae2f6aa3.svg → .../adding_new_scalar_equations/9b365d89.svg
diff --git a/.../adding_new_scalar_equations/d9e5afdc.svg → .../adding_new_scalar_equations/a2e609b6.svg b/.../adding_new_scalar_equations/d9e5afdc.svg → .../adding_new_scalar_equations/a2e609b6.svg
diff --git a/.../adding_new_scalar_equations/a8d3266c.svg → .../adding_new_scalar_equations/ba9bae54.svg b/.../adding_new_scalar_equations/a8d3266c.svg → .../adding_new_scalar_equations/ba9bae54.svg
diff --git a/previews/PR1816/tutorials/adding_new_scalar_equations/index.html b/previews/PR1816/tutorials/adding_new_scalar_equations/index.html
diff --git a/...ing_nonconservative_equation/481c1109.svg → ...ing_nonconservative_equation/6bb769c6.svg b/...ing_nonconservative_equation/481c1109.svg → ...ing_nonconservative_equation/6bb769c6.svg
diff --git a/previews/PR1816/tutorials/adding_nonconservative_equation/index.html b/previews/PR1816/tutorials/adding_nonconservative_equation/index.html
diff --git a/...ls/custom_semidiscretization/24e4b6eb.svg → ...ls/custom_semidiscretization/11b7b570.svg b/...ls/custom_semidiscretization/24e4b6eb.svg → ...ls/custom_semidiscretization/11b7b570.svg
diff --git a/...ls/custom_semidiscretization/c122a0c6.svg → ...ls/custom_semidiscretization/3c41b8b1.svg b/...ls/custom_semidiscretization/c122a0c6.svg → ...ls/custom_semidiscretization/3c41b8b1.svg
diff --git a/...ls/custom_semidiscretization/b7f0d166.svg → ...ls/custom_semidiscretization/4a4b1d65.svg b/...ls/custom_semidiscretization/b7f0d166.svg → ...ls/custom_semidiscretization/4a4b1d65.svg
diff --git a/...ls/custom_semidiscretization/f3173adb.svg → ...ls/custom_semidiscretization/928f203e.svg b/...ls/custom_semidiscretization/f3173adb.svg → ...ls/custom_semidiscretization/928f203e.svg
diff --git a/...ls/custom_semidiscretization/08d83677.svg → ...ls/custom_semidiscretization/ee9ec3e6.svg b/...ls/custom_semidiscretization/08d83677.svg → ...ls/custom_semidiscretization/ee9ec3e6.svg
diff --git a/previews/PR1816/tutorials/custom_semidiscretization/index.html b/previews/PR1816/tutorials/custom_semidiscretization/index.html
diff --git a/...s/differentiable_programming/55b6304b.svg → ...s/differentiable_programming/29960f84.svg b/...s/differentiable_programming/55b6304b.svg → ...s/differentiable_programming/29960f84.svg
diff --git a/...s/differentiable_programming/d5458ab2.svg → ...s/differentiable_programming/3b1d3c7d.svg b/...s/differentiable_programming/d5458ab2.svg → ...s/differentiable_programming/3b1d3c7d.svg
diff --git a/...s/differentiable_programming/9150f855.svg → ...s/differentiable_programming/50b93a2d.svg b/...s/differentiable_programming/9150f855.svg → ...s/differentiable_programming/50b93a2d.svg
diff --git a/...s/differentiable_programming/48972d3b.svg → ...s/differentiable_programming/6220f384.svg b/...s/differentiable_programming/48972d3b.svg → ...s/differentiable_programming/6220f384.svg
diff --git a/...s/differentiable_programming/6737bc08.svg → ...s/differentiable_programming/94083087.svg b/...s/differentiable_programming/6737bc08.svg → ...s/differentiable_programming/94083087.svg
diff --git a/...s/differentiable_programming/e5319739.svg → ...s/differentiable_programming/b0739a29.svg b/...s/differentiable_programming/e5319739.svg → ...s/differentiable_programming/b0739a29.svg
diff --git a/...s/differentiable_programming/caf3fbb9.svg → ...s/differentiable_programming/d896d194.svg b/...s/differentiable_programming/caf3fbb9.svg → ...s/differentiable_programming/d896d194.svg
diff --git a/...s/differentiable_programming/2ddbb9ec.svg → ...s/differentiable_programming/f8d7cf33.svg b/...s/differentiable_programming/2ddbb9ec.svg → ...s/differentiable_programming/f8d7cf33.svg
diff --git a/previews/PR1816/tutorials/differentiable_programming/index.html b/previews/PR1816/tutorials/differentiable_programming/index.html
diff --git a/previews/PR1816/tutorials/first_steps/changing_trixi/index.html b/previews/PR1816/tutorials/first_steps/changing_trixi/index.html
diff --git a/previews/PR1816/tutorials/first_steps/create_first_setup/b1edc0d7.svg b/previews/PR1816/tutorials/first_steps/create_first_setup/b1edc0d7.svg
diff --git a/previews/PR1816/tutorials/first_steps/create_first_setup/e892cf00.svg b/previews/PR1816/tutorials/first_steps/create_first_setup/e892cf00.svg
diff --git a/previews/PR1816/tutorials/first_steps/create_first_setup/index.html b/previews/PR1816/tutorials/first_steps/create_first_setup/index.html
diff --git a/previews/PR1816/tutorials/first_steps/getting_started/5c420399.svg b/previews/PR1816/tutorials/first_steps/getting_started/5c420399.svg
diff --git a/previews/PR1816/tutorials/first_steps/getting_started/e8a15a78.svg b/previews/PR1816/tutorials/first_steps/getting_started/e8a15a78.svg
diff --git a/previews/PR1816/tutorials/first_steps/getting_started/index.html b/previews/PR1816/tutorials/first_steps/getting_started/index.html
diff --git a/previews/PR1816/tutorials/hohqmesh_tutorial/index.html b/previews/PR1816/tutorials/hohqmesh_tutorial/index.html
diff --git a/previews/PR1816/tutorials/introduction/index.html b/previews/PR1816/tutorials/introduction/index.html
diff --git a/...ials/non_periodic_boundaries/ee7640b6.svg → ...ials/non_periodic_boundaries/497000ef.svg b/...ials/non_periodic_boundaries/ee7640b6.svg → ...ials/non_periodic_boundaries/497000ef.svg
diff --git a/previews/PR1816/tutorials/non_periodic_boundaries/index.html b/previews/PR1816/tutorials/non_periodic_boundaries/index.html
diff --git a/previews/PR1816/tutorials/notebooks/DGMulti_1.ipynb b/previews/PR1816/tutorials/notebooks/DGMulti_1.ipynb
@@ -3,7 +3,7 @@
   {
    "cell_type": "markdown",
    "source": [
-    "# 5: DG schemes via `DGMulti` solver"
+    "# 6: DG schemes via `DGMulti` solver"
    ],
    "metadata": {}
   },

diff --git a/previews/PR1816/tutorials/notebooks/DGMulti_2.ipynb b/previews/PR1816/tutorials/notebooks/DGMulti_2.ipynb
@@ -3,7 +3,7 @@
   {
    "cell_type": "markdown",
    "source": [
-    "# 6: Other SBP schemes (FD, CGSEM) via `DGMulti` solver"
+    "# 7: Other SBP schemes (FD, CGSEM) via `DGMulti` solver"
    ],
    "metadata": {}
   },

diff --git a/previews/PR1816/tutorials/notebooks/DGSEM_FluxDiff.ipynb b/previews/PR1816/tutorials/notebooks/DGSEM_FluxDiff.ipynb
@@ -3,7 +3,7 @@
   {
    "cell_type": "markdown",
    "source": [
-    "# 2: DGSEM with flux differencing"
+    "# 3: DGSEM with flux differencing"
    ],
    "metadata": {}
   },

diff --git a/previews/PR1816/tutorials/notebooks/adaptive_mesh_refinement.ipynb b/previews/PR1816/tutorials/notebooks/adaptive_mesh_refinement.ipynb
@@ -3,7 +3,7 @@
   {
    "cell_type": "markdown",
    "source": [
-    "# 12: Adaptive mesh refinement"
+    "# 13: Adaptive mesh refinement"
    ],
    "metadata": {}
   },

diff --git a/previews/PR1816/tutorials/notebooks/adding_new_parabolic_terms.ipynb b/previews/PR1816/tutorials/notebooks/adding_new_parabolic_terms.ipynb
@@ -3,7 +3,7 @@
   {
    "cell_type": "markdown",
    "source": [
-    "# 11: Adding new parabolic terms"
+    "# 12: Adding new parabolic terms"
    ],
    "metadata": {}
   },

diff --git a/previews/PR1816/tutorials/notebooks/adding_new_scalar_equations.ipynb b/previews/PR1816/tutorials/notebooks/adding_new_scalar_equations.ipynb
@@ -3,7 +3,7 @@
   {
    "cell_type": "markdown",
    "source": [
-    "# 8: Adding a new scalar conservation law"
+    "# 9: Adding a new scalar conservation law"
    ],
    "metadata": {}
   },

diff --git a/previews/PR1816/tutorials/notebooks/adding_nonconservative_equation.ipynb b/previews/PR1816/tutorials/notebooks/adding_nonconservative_equation.ipynb
@@ -3,7 +3,7 @@
   {
    "cell_type": "markdown",
    "source": [
-    "# 9: Adding a non-conservative equation"
+    "# 10: Adding a non-conservative equation"
    ],
    "metadata": {}
   },

diff --git a/previews/PR1816/tutorials/notebooks/custom_semidiscretization.ipynb b/previews/PR1816/tutorials/notebooks/custom_semidiscretization.ipynb
@@ -3,7 +3,7 @@
   {
    "cell_type": "markdown",
    "source": [
-    "# 18: Custom semidiscretizations"
+    "# 19: Custom semidiscretizations"
    ],
    "metadata": {}
   },

diff --git a/previews/PR1816/tutorials/notebooks/differentiable_programming.ipynb b/previews/PR1816/tutorials/notebooks/differentiable_programming.ipynb
@@ -3,7 +3,7 @@
   {
    "cell_type": "markdown",
    "source": [
-    "# 17: Differentiable programming"
+    "# 18: Differentiable programming"
    ],
    "metadata": {}
   },

diff --git a/previews/PR1816/tutorials/notebooks/first_steps/changing_trixi.ipynb b/previews/PR1816/tutorials/notebooks/first_steps/changing_trixi.ipynb
@@ -0,0 +1,156 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "source": [
+    "# 1.3: First steps in Trixi.jl: Changing Trixi.jl itself"
+   ],
+   "metadata": {}
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "**Note:** To improve responsiveness via caching, the notebooks are updated only once a week. They are only\n",
+    "available for the latest stable release of Trixi.jl at the time of caching."
+   ],
+   "metadata": {}
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "If you plan on editing Trixi.jl itself, you can download Trixi.jl locally and run it from\n",
+    "the cloned directory."
+   ],
+   "metadata": {}
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "## Cloning Trixi.jl"
+   ],
+   "metadata": {}
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "### Windows"
+   ],
+   "metadata": {}
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "If you are using Windows, you can clone Trixi.jl by using the GitHub Desktop tool:\n",
+    "- If you do not have a GitHub account yet, create it on\n",
+    "  the [GitHub website](https://github.com/join).\n",
+    "- Download and install [GitHub Desktop](https://desktop.github.com/) and then log in to\n",
+    "  your account.\n",
+    "- Open GitHub Desktop, press `Ctrl+Shift+O`.\n",
+    "- In the opened window, paste `trixi-framework/Trixi.jl` and choose the path to the folder where\n",
+    "  you want to save Trixi.jl. Then click `Clone` and Trixi.jl will be cloned to your computer."
+   ],
+   "metadata": {}
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "Now you cloned Trixi.jl and only need to tell Julia to use the local clone as the package sources:\n",
+    "- Open a terminal using `Win+r` and `cmd`. Navigate to the folder with the cloned Trixi.jl using `cd`.\n",
+    "- Create a new directory `run`, enter it, and start Julia with the `--project=.` flag:\n",
+    "  ```shell\n",
+    "  mkdir run\n",
+    "  cd run\n",
+    "  julia --project=.\n",
+    "  ```\n",
+    "- Now run the following commands to install all relevant packages:\n",
+    "  ```julia\n",
+    "  using Pkg; Pkg.develop(PackageSpec(path=\"..\")) # Tell Julia to use the local Trixi.jl clone\n",
+    "  Pkg.add([\"OrdinaryDiffEq\", \"Plots\"])  # Install additional packages\n",
+    "  ```"
+   ],
+   "metadata": {}
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "Now you already installed Trixi.jl from your local clone. Note that if you installed Trixi.jl\n",
+    "this way, you always have to start Julia with the `--project` flag set to your `run` directory,\n",
+    "e.g.,\n",
+    "```shell\n",
+    "julia --project=.\n",
+    "```\n",
+    "if already inside the `run` directory."
+   ],
+   "metadata": {}
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "### Linux"
+   ],
+   "metadata": {}
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "You can clone Trixi.jl to your computer by executing the following commands:\n",
+    "```shell\n",
+    "git clone [email protected]:trixi-framework/Trixi.jl.git\n",
+    "# If an error occurs, try the following:\n",
+    "# git clone https://github.com/trixi-framework/Trixi.jl\n",
+    "cd Trixi.jl\n",
+    "mkdir run\n",
+    "cd run\n",
+    "julia --project=. -e 'using Pkg; Pkg.develop(PackageSpec(path=\"..\"))' # Tell Julia to use the local Trixi.jl clone\n",
+    "julia --project=. -e 'using Pkg; Pkg.add([\"OrdinaryDiffEq\", \"Plots\"])' # Install additional packages\n",
+    "```\n",
+    "Note that if you installed Trixi.jl this way,\n",
+    "you always have to start Julia with the `--project` flag set to your `run` directory, e.g.,\n",
+    "```shell\n",
+    "julia --project=.\n",
+    "```\n",
+    "if already inside the `run` directory."
+   ],
+   "metadata": {}
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "## Additional reading"
+   ],
+   "metadata": {}
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "To further delve into Trixi.jl, you may have a look at the following introductory tutorials.\n",
+    "- Introduction to DG methods will teach you how to set up a\n",
+    "  simple way to approximate the solution of a hyperbolic partial differential equation. It will\n",
+    "  be especially useful to learn about the\n",
+    "  [Discontinuous Galerkin method](https://en.wikipedia.org/wiki/Discontinuous_Galerkin_method)\n",
+    "  and the way it is implemented in Trixi.jl.\n",
+    "- Adding a new scalar conservation law and\n",
+    "  Adding a non-conservative equation\n",
+    "  describe how to add new physics models that are not yet included in Trixi.jl.\n",
+    "- Callbacks gives an overview of how to regularly execute specific actions\n",
+    "  during a simulation, e.g., to store the solution or adapt the mesh."
+   ],
+   "metadata": {}
+  }
+ ],
+ "nbformat_minor": 3,
+ "metadata": {
+  "language_info": {
+   "file_extension": ".jl",
+   "mimetype": "application/julia",
+   "name": "julia",
+   "version": "1.9.4"
+  },
+  "kernelspec": {
+   "name": "julia-1.9",
+   "display_name": "Julia 1.9.4",
+   "language": "julia"
+  }
+ },
+ "nbformat": 4
+}
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-02-05T18:49:51","documenter_version":"1.2.1"}}
		{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-02-07T10:57:59","documenter_version":"1.2.1"}}