Move SWEs to TrixiShallowWater.jl (#2379)

* remove shallow water equations

* apply formatter

* add docstrings to the functions that are shared between subpackages

* add additional tests for TreeMesh

* move empty exported fluxes from equations.jl to numerical_fluxes.jl

* add news item

* add elixir_mhd_onion.jl and corresponding test for UnstructuredMesh2D

* add unit_test for lake_at_rest_error

* remove todo note

* replace swe elixir in benchmarks.jl with euler_quasi_1d

* Update NEWS.md

Co-authored-by: Hendrik Ranocha <[email protected]>

* modify docstrings for empty interface functions

* Apply suggestions from code review

Co-authored-by: Hendrik Ranocha <[email protected]>

---------

Co-authored-by: Hendrik Ranocha <[email protected]>
Co-authored-by: Andrew Winters <[email protected]>

Author: 3 people

NEWS.md

@@ -5,6 +5,16 @@ Trixi.jl follows the interpretation of
 used in the Julia ecosystem. Notable changes will be documented in this file
 for human readability.
 
+## Changes when updating to v0.12 from v0.11.x
+
+#### Added
+
+#### Changed
+
+#### Deprecated
+
+#### Removed
+- The shallow-water equation types `ShallowWaterEquations1D`, `ShallowWaterEquations2D`, and `ShallowWaterEquationsQuasi1D` have been removed from Trixi.jl and are now available via [TrixiShallowWater.jl](https://github.com/trixi-framework/TrixiShallowWater.jl/). This also affects the related functions `hydrostatic_reconstruction_audusse_etal`, `flux_nonconservative_audusse_etal`, and `FluxHydrostaticReconstruction`. ([#2379])
 
 ## Changes in the v0.11 lifecycle
 

README.md

@@ -58,7 +58,7 @@ installation and postprocessing procedures. Its features include:
   * Linearized Euler and acoustic perturbation equations
   * Hyperbolic diffusion equations for elliptic problems
   * Lattice-Boltzmann equations (D2Q9 and D3Q27 schemes)
-  * Shallow water equations
+  * Shallow water equations via [TrixiShallowWater.jl](https://github.com/trixi-framework/TrixiShallowWater.jl)
   * Several scalar conservation laws (e.g., linear advection, Burgers' equation, LWR traffic flow)
 * Multi-physics simulations
   * [Self-gravitating gas dynamics](https://github.com/trixi-framework/paper-self-gravitating-gas-dynamics)

benchmark/benchmarks.jl

@@ -14,7 +14,7 @@ for elixir in [# 1D
                joinpath(examples_dir(), "structured_1d_dgsem", "elixir_euler_sedov.jl"),
                joinpath(examples_dir(), "tree_1d_dgsem", "elixir_mhd_ec.jl"), 
                joinpath(examples_dir(), "tree_1d_dgsem", "elixir_navierstokes_convergence_walls_amr.jl"),
-               joinpath(examples_dir(), "tree_1d_dgsem", "elixir_shallowwater_well_balanced_nonperiodic.jl"),
+               joinpath(examples_dir(), "tree_1d_dgsem", "elixir_euler_quasi_1d_source_terms_dirichlet.jl"),
                # 2D
                joinpath(examples_dir(), "tree_2d_dgsem", "elixir_advection_extended.jl"),
                joinpath(examples_dir(), "tree_2d_dgsem", "elixir_advection_amr_nonperiodic.jl"),

docs/src/index.md

@@ -53,7 +53,7 @@ installation and postprocessing procedures. Its features include:
   * Linearized Euler and acoustic perturbation equations
   * Hyperbolic diffusion equations for elliptic problems
   * Lattice-Boltzmann equations (D2Q9 and D3Q27 schemes)
-  * Shallow water equations
+  * Shallow water equations via [TrixiShallowWater.jl](https://github.com/trixi-framework/TrixiShallowWater.jl)
   * Several scalar conservation laws (e.g., linear advection, Burgers' equation, LWR traffic flow)
 * Multi-physics simulations
   * [Self-gravitating gas dynamics](https://github.com/trixi-framework/paper-self-gravitating-gas-dynamics)

docs/src/overview.md

@@ -59,7 +59,7 @@ different features on different mesh types.
 | Weak form                                                    |          ✅         |             ✅            |               ✅              |          ✅          |               ✅            | [`VolumeIntegralWeakForm`](@ref)
 | Flux differencing                                            |          ✅         |             ✅            |               ✅              |          ✅          |               ✅            | [`VolumeIntegralFluxDifferencing`](@ref)
 | Shock capturing                                              |          ✅         |             ✅            |               ✅              |          ✅          |               ❌            | [`VolumeIntegralShockCapturingHG`](@ref)
-| Nonconservative equations                                    |          ✅         |             ✅            |               ✅              |          ✅          |               ✅            | e.g., GLM MHD or shallow water equations
+| Nonconservative equations                                    |          ✅         |             ✅            |               ✅              |          ✅          |               ✅            | e.g., [`IdealGlmMhdEquations2D`](@ref)
 | Parabolic terms                                              |          ✅         |             ❌            |               ❌              |          ✅          |               ✅            | e.g., [`CompressibleNavierStokesDiffusion2D`](@ref)
 
 ᵃ: quad = quadrilateral, hex = hexahedron