-
Notifications
You must be signed in to change notification settings - Fork 114
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* rename paper examples * move example elixirs * update benchmarks * adapt more hard-coded elixir paths * make docstring of examples_dir a Documenter example * some additions to the docstrings of functions related to examples * adapt more elixir path * more detailed README of the examples [skip ci] Co-authored-by: Michael Schlottke-Lakemper <[email protected]> * use suffic _eoc for convergence test elixirs * unify names elixir_euler_nonperiodic -> elixir_euler_source_terms_nonperiodic * _eoc -> _convergence in elixirs Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
- Loading branch information
Showing
238 changed files
with
341 additions
and
354 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
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
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,28 +1,38 @@ | ||
# Example elixirs for Trixi | ||
|
||
This folder contains example files ("elixirs") that can be used to just try out Trixi and | ||
that also serve as a starting point to create new simulation setups. | ||
This folder contains example files ("elixirs") that can be used to just try out | ||
Trixi and that also serve as a starting point to create new simulation setups. | ||
Furthermore, these files are also the basis for our automated Trixi tests and | ||
**each new file put in here** should be added to the test sets in | ||
`../test/test_examples_Xd_equation.jl`. | ||
**each new file put in here** should be added to the test sets. | ||
|
||
In general, the elixirs are sorted by | ||
|
||
- the mesh type, | ||
- the spatial dimension, | ||
- and the discretization type | ||
|
||
at the top level. Inside each folder, the elixirs are sorted by the equations, | ||
then the setup, and then, optionally, configuration details. For example, | ||
`elixir_euler_kelvin_helmholtz_instability_amr.jl` indicates an *elixir* for the | ||
compressible *Euler* equations, running the *Kelvin-Helmholtz instability* setup | ||
with adaptive mesh refinement (*AMR*) enabled. | ||
|
||
There are also a few files that were configured such that they lend themselves | ||
to doing convergence tests with `convergence_test`, i.e., to determine the | ||
experimental order of convergence (EOC): | ||
|
||
* [`2d/elixir_advection_basic.jl`](2d/elixir_advection_basic.jl): | ||
* [`tree_2d_dgsem/elixir_advection_basic.jl`](tree_2d_dgsem/elixir_advection_basic.jl): | ||
EOC tests for linear scalar advection with `polydeg = 3`. | ||
* [`2d/elixir_euler_source_terms.jl`](2d/elixir_euler_source_terms.jl): | ||
* [`tree_2d_dgsem/elixir_euler_source_terms.jl`](tree_2d_dgsem/elixir_euler_source_terms.jl): | ||
EOC tests for Euler equations with `polydeg = 3`. | ||
* [`2d/elixir_mhd_alfven_wave.jl`](2d/elixir_mhd_alfven_wave.jl): | ||
* [`tree_2d_dgsem/elixir_mhd_alfven_wave.jl`](tree_2d_dgsem/elixir_mhd_alfven_wave.jl): | ||
EOC tests for MHD equations with `polydeg = 3`. | ||
* [`2d/elixir_hypdiff_lax_friedrichs.jl`](2d/elixir_hypdiff_lax_friedrichs.jl): | ||
* [`tree_2d_dgsem/elixir_hypdiff_lax_friedrichs.jl`](tree_2d_dgsem/elixir_hypdiff_lax_friedrichs.jl): | ||
EOC tests for hyperbolic diffusion equations with `polydeg = 4`. | ||
|
||
Similar setups are available for other spatial dimensions in the directories | ||
`1d` and `3d`. | ||
Similar setups are available for other spatial dimensions and for other mesh types. | ||
|
||
In general, a good first elixir to try out as a new user is | ||
[`2d/elixir_advection_basic.jl`](2d/elixir_advection_basic.jl), | ||
[`tree_2d_dgsem/elixir_advection_basic.jl`](tree_2d_dgsem/elixir_advection_basic.jl), | ||
as it is short, takes less than a second to run, and uses only the basic features | ||
of Trixi. |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.