Apply suggestions from code review

Co-authored-by: Hendrik Ranocha <[email protected]>
trixi-framework · Jul 13, 2023 · 78d3aa5 · 78d3aa5
1 parent 1927fb3
commit 78d3aa5
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/src/Trixi.jl b/src/Trixi.jl
@@ -253,6 +253,7 @@ export ControllerThreeLevel, ControllerThreeLevelCombined,
        IndicatorNeuralNetwork, NeuralNetworkPerssonPeraire, NeuralNetworkRayHesthaven,
        NeuralNetworkCNN
 
+# TODO: TrixiShallowWater: move new limiter
 export PositivityPreservingLimiterZhangShu, PositivityPreservingLimiterShallowWater
 
 export trixi_include, examples_dir, get_examples, default_example,

diff --git a/src/equations/shallow_water_1d.jl b/src/equations/shallow_water_1d.jl
@@ -6,7 +6,7 @@
 #! format: noindent
 
 @doc raw"""
-    ShallowWaterEquations1D(gravity, H0, threshold_limiter, threshold_wet)
+    ShallowWaterEquations1D(; gravity, H0 = 0, threshold_limiter = nothing threshold_wet = nothing)
 
 Shallow water equations (SWE) in one space dimension. The equations are given by
 ```math

diff --git a/src/equations/shallow_water_2d.jl b/src/equations/shallow_water_2d.jl
@@ -6,7 +6,7 @@
 #! format: noindent
 
 @doc raw"""
-    ShallowWaterEquations2D(gravity, H0, threshold_limiter, threshold_wet)
+    ShallowWaterEquations2D(; gravity, H0 = 0, threshold_limiter = nothing, threshold_wet = nothing)
 
 Shallow water equations (SWE) in two space dimensions. The equations are given by
 ```math