Separation of TrixiShallowWater.jl

NEWS.md

@@ -4,6 +4,19 @@ Trixi.jl follows the interpretation of [semantic versioning (semver)](https://ju
 used in the Julia ecosystem. Notable changes will be documented in this file
 for human readability.
 
+## Changes when updating to v0.7 from v0.6.x
+
+#### Added
+
+#### Changed
+
+#### Deprecated
+
+#### Removed
+- Some specialized Shallow water specific features will no longer be available directly in
+  `Trixi.jl`, but will be moved to a dedicated repository: [TrixiShallowWater.jl](https://github.com/trixi-framework/TrixiShallowWater.jl). This includes all features related to wetting and drying, as well as the `ShallowWaterTwoLayerEquations1D` and `ShallowWaterTwoLayerEquations2D`.
+  However, the basic Shallow water equations will continue to be part of `Trixi.jl`. We'll also be updating the `TrixiShallowWater.jl` documentation with instructions on how to use these relocated features in the future.
+
 ## Changes in the v0.6 lifecycle
 
 #### Added

test/test_unit.jl

@@ -538,7 +538,7 @@ end
 end
 
 @timed_testset "Shallow water conversion between conservative/entropy variables" begin
-    H, v1, v2, b = 3.5, 0.25, 0.1, 0.4
+    H, v1, v2, b, a = 3.5, 0.25, 0.1, 0.4, 0.3
 
     let equations = ShallowWaterEquations1D(gravity_constant = 9.8)
         cons_vars = prim2cons(SVector(H, v1, b), equations)
@@ -567,6 +567,14 @@ end
         entropy_vars = cons2entropy(cons_vars, equations)
         @test cons_vars ≈ entropy2cons(entropy_vars, equations)
     end
+
+    let equations = ShallowWaterEquationsQuasi1D(gravity_constant = 9.8)
+        cons_vars = prim2cons(SVector(H, v1, b, a), equations)
+        entropy_vars = cons2entropy(cons_vars, equations)
+
+        total_energy = energy_total(cons_vars, equations)
+        @test entropy(cons_vars, equations) ≈ a * total_energy
+    end
 end
 
 @timed_testset "boundary_condition_do_nothing" begin
@@ -692,6 +700,14 @@ end
     u = SVector(1, 0.5, 0.0)
     @test flux_hll(u, u, 1, equations) ≈ flux(u, 1, equations)
 
+    u_ll = SVector(0.1, 1.0, 0.0)
+    u_rr = SVector(0.1, 1.0, 0.0)
+    @test flux_hll(u_ll, u_rr, 1, equations) ≈ flux(u_ll, 1, equations)
+
+    u_ll = SVector(0.1, -1.0, 0.0)
+    u_rr = SVector(0.1, -1.0, 0.0)
+    @test flux_hll(u_ll, u_rr, 1, equations) ≈ flux(u_rr, 1, equations)
+
     equations = ShallowWaterEquations2D(gravity_constant = 9.81)
     normal_directions = [SVector(1.0, 0.0),
         SVector(0.0, 1.0),
@@ -702,6 +718,17 @@ end
         @test flux_hll(u, u, normal_direction, equations) ≈
               flux(u, normal_direction, equations)
     end
+
+    normal_direction = SVector(1.0, 0.0, 0.0)
+    u_ll = SVector(0.1, 1.0, 1.0, 0.0)
+    u_rr = SVector(0.1, 1.0, 1.0, 0.0)
+    @test flux_hll(u_ll, u_rr, normal_direction, equations) ≈
+          flux(u_ll, normal_direction, equations)
+
+    u_ll = SVector(0.1, -1.0, -1.0, 0.0)
+    u_rr = SVector(0.1, -1.0, -1.0, 0.0)
+    @test flux_hll(u_ll, u_rr, normal_direction, equations) ≈
+          flux(u_rr, normal_direction, equations)
 end
 
 @timed_testset "Consistency check for HLL flux (naive): MHD" begin