trixi-framework · patrickersing · Apr 9, 2025 · Apr 11, 2025 · Apr 11, 2025
diff --git a/NEWS.md b/NEWS.md
@@ -6,6 +6,19 @@ 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
+
+- The keyword argument `gravity_constant` has been changed to `gravity` for the `ShallowWaterEquations1D`,
+  `ShallowWaterEquations2D`, and `ShallowWaterEquationsQuasi1D`.
+
+#### Deprecated
+
+#### Removed
+
 ## Changes in the v0.11 lifecycle
 
 #### Added

diff --git a/examples/dgmulti_1d/elixir_shallow_water_quasi_1d.jl b/examples/dgmulti_1d/elixir_shallow_water_quasi_1d.jl
@@ -5,7 +5,7 @@ using Trixi
 # Semidiscretization of the quasi 1d shallow water equations
 # See Chan et al.  https://doi.org/10.48550/arXiv.2307.12089 for details
 
-equations = ShallowWaterEquationsQuasi1D(gravity_constant = 9.81)
+equations = ShallowWaterEquationsQuasi1D(gravity = 9.81)
 
 initial_condition = initial_condition_convergence_test
 

diff --git a/examples/dgmulti_2d/elixir_shallowwater_source_terms.jl b/examples/dgmulti_2d/elixir_shallowwater_source_terms.jl
@@ -4,7 +4,7 @@ using Trixi
 ###############################################################################
 # semidiscretization of the shallow water equations
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81)
+equations = ShallowWaterEquations2D(gravity = 9.81)
 
 initial_condition = initial_condition_convergence_test
 

diff --git a/examples/p4est_2d_dgsem/elixir_shallowwater_source_terms.jl b/examples/p4est_2d_dgsem/elixir_shallowwater_source_terms.jl
@@ -4,7 +4,7 @@ using Trixi
 ###############################################################################
 # semidiscretization of the shallow water equations
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81)
+equations = ShallowWaterEquations2D(gravity = 9.81)
 
 initial_condition = initial_condition_convergence_test # MMS EOC test
 

diff --git a/examples/structured_2d_dgsem/elixir_shallowwater_source_terms.jl b/examples/structured_2d_dgsem/elixir_shallowwater_source_terms.jl
@@ -4,7 +4,7 @@ using Trixi
 ###############################################################################
 # semidiscretization of the shallow water equations
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81)
+equations = ShallowWaterEquations2D(gravity = 9.81)
 
 initial_condition = initial_condition_convergence_test
 

diff --git a/examples/structured_2d_dgsem/elixir_shallowwater_well_balanced.jl b/examples/structured_2d_dgsem/elixir_shallowwater_well_balanced.jl
@@ -5,7 +5,7 @@ using Trixi
 # semidiscretization of the shallow water equations with a discontinuous
 # bottom topography function (set in the initial conditions)
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81, H0 = 3.0)
+equations = ShallowWaterEquations2D(gravity = 9.81, H0 = 3.0)
 
 # An initial condition with constant total water height and zero velocities to test well-balancedness.
 # Note, this routine is used to compute errors in the analysis callback but the initialization is

diff --git a/examples/t8code_2d_dgsem/elixir_shallowwater_source_terms.jl b/examples/t8code_2d_dgsem/elixir_shallowwater_source_terms.jl
@@ -4,7 +4,7 @@ using Trixi
 ###############################################################################
 # Semidiscretization of the shallow water equations.
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81)
+equations = ShallowWaterEquations2D(gravity = 9.81)
 
 initial_condition = initial_condition_convergence_test # MMS EOC test
 

diff --git a/examples/tree_1d_dgsem/elixir_shallow_water_quasi_1d_source_terms.jl b/examples/tree_1d_dgsem/elixir_shallow_water_quasi_1d_source_terms.jl
@@ -5,7 +5,7 @@ using Trixi
 # Semidiscretization of the quasi 1d shallow water equations
 # See Chan et al.  https://doi.org/10.48550/arXiv.2307.12089 for details
 
-equations = ShallowWaterEquationsQuasi1D(gravity_constant = 9.81)
+equations = ShallowWaterEquationsQuasi1D(gravity = 9.81)
 
 initial_condition = initial_condition_convergence_test
 

diff --git a/examples/tree_1d_dgsem/elixir_shallowwater_ec.jl b/examples/tree_1d_dgsem/elixir_shallowwater_ec.jl
@@ -5,7 +5,7 @@ using Trixi
 # Semidiscretization of the shallow water equations with a discontinuous
 # bottom topography function
 
-equations = ShallowWaterEquations1D(gravity_constant = 9.81)
+equations = ShallowWaterEquations1D(gravity = 9.81)
 
 # Initial condition with a truly discontinuous water height, velocity, and bottom
 # topography function as an academic testcase for entropy conservation.

diff --git a/examples/tree_1d_dgsem/elixir_shallowwater_quasi_1d_discontinuous.jl b/examples/tree_1d_dgsem/elixir_shallowwater_quasi_1d_discontinuous.jl
@@ -5,7 +5,7 @@ using Trixi
 # Semidiscretization of the quasi 1d shallow water equations
 # See Chan et al.  https://doi.org/10.48550/arXiv.2307.12089 for details
 
-equations = ShallowWaterEquationsQuasi1D(gravity_constant = 9.81)
+equations = ShallowWaterEquationsQuasi1D(gravity = 9.81)
 
 function initial_condition_discontinuity(x, t, equations::ShallowWaterEquationsQuasi1D)
     RealT = eltype(x)

diff --git a/examples/tree_1d_dgsem/elixir_shallowwater_quasi_1d_well_balanced.jl b/examples/tree_1d_dgsem/elixir_shallowwater_quasi_1d_well_balanced.jl
@@ -5,7 +5,7 @@ using Trixi
 # semidiscretization of the shallow water equations with a discontinuous
 # bottom topography function and channel width function
 
-equations = ShallowWaterEquationsQuasi1D(gravity_constant = 9.81, H0 = 2.0)
+equations = ShallowWaterEquationsQuasi1D(gravity = 9.81, H0 = 2.0)
 
 # Setup a truly discontinuous bottom topography function and channel width for
 # this academic testcase of well-balancedness. The errors from the analysis

diff --git a/examples/tree_1d_dgsem/elixir_shallowwater_shock_capturing.jl b/examples/tree_1d_dgsem/elixir_shallowwater_shock_capturing.jl
@@ -4,7 +4,7 @@ using Trixi
 ###############################################################################
 # Semidiscretization of the shallow water equations
 
-equations = ShallowWaterEquations1D(gravity_constant = 9.812, H0 = 1.75)
+equations = ShallowWaterEquations1D(gravity = 9.812, H0 = 1.75)
 
 # Initial condition with a truly discontinuous velocity and bottom topography.
 # Works as intended for TreeMesh1D with `initial_refinement_level=3`. If the mesh

diff --git a/examples/tree_1d_dgsem/elixir_shallowwater_source_terms.jl b/examples/tree_1d_dgsem/elixir_shallowwater_source_terms.jl
@@ -4,7 +4,7 @@ using Trixi
 ###############################################################################
 # Semidiscretization of the shallow water equations
 
-equations = ShallowWaterEquations1D(gravity_constant = 9.81)
+equations = ShallowWaterEquations1D(gravity = 9.81)
 
 initial_condition = initial_condition_convergence_test
 

diff --git a/examples/tree_1d_dgsem/elixir_shallowwater_source_terms_dirichlet.jl b/examples/tree_1d_dgsem/elixir_shallowwater_source_terms_dirichlet.jl
@@ -4,7 +4,7 @@ using Trixi
 ###############################################################################
 # Semidiscretization of the shallow water equations
 
-equations = ShallowWaterEquations1D(gravity_constant = 9.81)
+equations = ShallowWaterEquations1D(gravity = 9.81)
 
 initial_condition = initial_condition_convergence_test
 

diff --git a/examples/tree_1d_dgsem/elixir_shallowwater_well_balanced.jl b/examples/tree_1d_dgsem/elixir_shallowwater_well_balanced.jl
@@ -5,7 +5,7 @@ using Trixi
 # semidiscretization of the shallow water equations with a discontinuous
 # bottom topography function
 
-equations = ShallowWaterEquations1D(gravity_constant = 9.81, H0 = 3.25)
+equations = ShallowWaterEquations1D(gravity = 9.81, H0 = 3.25)
 
 # Setup a truly discontinuous bottom topography function for this academic
 # testcase of well-balancedness. The errors from the analysis callback are

diff --git a/examples/tree_1d_dgsem/elixir_shallowwater_well_balanced_nonperiodic.jl b/examples/tree_1d_dgsem/elixir_shallowwater_well_balanced_nonperiodic.jl
@@ -4,7 +4,7 @@ using Trixi
 ###############################################################################
 # Semidiscretization of the shallow water equations
 
-equations = ShallowWaterEquations1D(gravity_constant = 1.0, H0 = 3.0)
+equations = ShallowWaterEquations1D(gravity = 1.0, H0 = 3.0)
 
 # An initial condition with constant total water height and zero velocities to test well-balancedness.
 function initial_condition_well_balancedness(x, t, equations::ShallowWaterEquations1D)

diff --git a/examples/tree_2d_dgsem/elixir_shallowwater_ec.jl b/examples/tree_2d_dgsem/elixir_shallowwater_ec.jl
@@ -5,7 +5,7 @@ using Trixi
 # semidiscretization of the shallow water equations with a discontinuous
 # bottom topography function
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81)
+equations = ShallowWaterEquations2D(gravity = 9.81)
 
 # Note, this initial condition is used to compute errors in the analysis callback but the initialization is
 # overwritten by `initial_condition_ec_discontinuous_bottom` below.

diff --git a/examples/tree_2d_dgsem/elixir_shallowwater_source_terms.jl b/examples/tree_2d_dgsem/elixir_shallowwater_source_terms.jl
@@ -4,7 +4,7 @@ using Trixi
 ###############################################################################
 # semidiscretization of the shallow water equations
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81)
+equations = ShallowWaterEquations2D(gravity = 9.81)
 
 initial_condition = initial_condition_convergence_test # MMS EOC test
 

diff --git a/examples/tree_2d_dgsem/elixir_shallowwater_source_terms_dirichlet.jl b/examples/tree_2d_dgsem/elixir_shallowwater_source_terms_dirichlet.jl
@@ -4,7 +4,7 @@ using Trixi
 ###############################################################################
 # Semidiscretization of the shallow water equations
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81)
+equations = ShallowWaterEquations2D(gravity = 9.81)
 
 initial_condition = initial_condition_convergence_test
 

diff --git a/examples/tree_2d_dgsem/elixir_shallowwater_wall.jl b/examples/tree_2d_dgsem/elixir_shallowwater_wall.jl
@@ -4,7 +4,7 @@ using Trixi
 ###############################################################################
 # Semidiscretization of the shallow water equations
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81, H0 = 3.25)
+equations = ShallowWaterEquations2D(gravity = 9.81, H0 = 3.25)
 
 # An initial condition with a bottom topography and a perturbation in the waterheight to test
 # boundary_condition_slip_wall

diff --git a/examples/tree_2d_dgsem/elixir_shallowwater_well_balanced.jl b/examples/tree_2d_dgsem/elixir_shallowwater_well_balanced.jl
@@ -5,7 +5,7 @@ using Trixi
 # semidiscretization of the shallow water equations with a discontinuous
 # bottom topography function
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81, H0 = 3.25)
+equations = ShallowWaterEquations2D(gravity = 9.81, H0 = 3.25)
 
 # An initial condition with constant total water height and zero velocities to test well-balancedness.
 # Note, this routine is used to compute errors in the analysis callback but the initialization is

diff --git a/examples/tree_2d_dgsem/elixir_shallowwater_well_balanced_wall.jl b/examples/tree_2d_dgsem/elixir_shallowwater_well_balanced_wall.jl
@@ -5,7 +5,7 @@ using Trixi
 # semidiscretization of the shallow water equations with a discontinuous
 # bottom topography function
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81, H0 = 3.25)
+equations = ShallowWaterEquations2D(gravity = 9.81, H0 = 3.25)
 
 # An initial condition with constant total water height and zero velocities to test well-balancedness.
 # Note, this routine is used to compute errors in the analysis callback but the initialization is

diff --git a/examples/unstructured_2d_dgsem/elixir_shallowwater_dirichlet.jl b/examples/unstructured_2d_dgsem/elixir_shallowwater_dirichlet.jl
@@ -5,7 +5,7 @@ using Trixi
 # semidiscretization of the shallow water equations with a continuous
 # bottom topography function (set in the initial conditions)
 
-equations = ShallowWaterEquations2D(gravity_constant = 1.0, H0 = 3.0)
+equations = ShallowWaterEquations2D(gravity = 1.0, H0 = 3.0)
 
 # An initial condition with constant total water height and zero velocities to test well-balancedness.
 function initial_condition_well_balancedness(x, t, equations::ShallowWaterEquations2D)

diff --git a/examples/unstructured_2d_dgsem/elixir_shallowwater_ec.jl b/examples/unstructured_2d_dgsem/elixir_shallowwater_ec.jl
@@ -5,7 +5,7 @@ using Trixi
 # semidiscretization of the shallow water equations with a discontinuous
 # bottom topography function
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81)
+equations = ShallowWaterEquations2D(gravity = 9.81)
 
 # Note, this initial condition is used to compute errors in the analysis callback but the initialization is
 # overwritten by `initial_condition_ec_discontinuous_bottom` below.

diff --git a/examples/unstructured_2d_dgsem/elixir_shallowwater_ec_float32.jl b/examples/unstructured_2d_dgsem/elixir_shallowwater_ec_float32.jl
@@ -8,7 +8,7 @@ using Trixi
 # semidiscretization of the shallow water equations with a discontinuous
 # bottom topography function
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81f0)
+equations = ShallowWaterEquations2D(gravity = 9.81f0)
 
 # Note, this initial condition is used to compute errors in the analysis callback but the initialization is
 # overwritten by `initial_condition_ec_discontinuous_bottom` below.

diff --git a/examples/unstructured_2d_dgsem/elixir_shallowwater_ec_shockcapturing.jl b/examples/unstructured_2d_dgsem/elixir_shallowwater_ec_shockcapturing.jl
@@ -5,7 +5,7 @@ using Trixi
 # semidiscretization of the shallow water equations with a discontinuous
 # bottom topography function
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81)
+equations = ShallowWaterEquations2D(gravity = 9.81)
 
 # Note, this initial condition is used to compute errors in the analysis callback but the initialization is
 # overwritten by `initial_condition_ec_discontinuous_bottom` below.

diff --git a/examples/unstructured_2d_dgsem/elixir_shallowwater_source_terms.jl b/examples/unstructured_2d_dgsem/elixir_shallowwater_source_terms.jl
@@ -5,7 +5,7 @@ using Trixi
 # semidiscretization of the shallow water equations with a periodic
 # bottom topography function (set in the initial conditions)
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81)
+equations = ShallowWaterEquations2D(gravity = 9.81)
 
 initial_condition = initial_condition_convergence_test
 

diff --git a/examples/unstructured_2d_dgsem/elixir_shallowwater_wall_bc_shockcapturing.jl b/examples/unstructured_2d_dgsem/elixir_shallowwater_wall_bc_shockcapturing.jl
@@ -5,7 +5,7 @@ using Trixi
 # semidiscretization of the shallow water equations with a continuous
 # bottom topography function
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.812, H0 = 2.0)
+equations = ShallowWaterEquations2D(gravity = 9.812, H0 = 2.0)
 
 function initial_condition_stone_throw(x, t, equations::ShallowWaterEquations2D)
     # Set up polar coordinates

diff --git a/examples/unstructured_2d_dgsem/elixir_shallowwater_well_balanced.jl b/examples/unstructured_2d_dgsem/elixir_shallowwater_well_balanced.jl
@@ -5,7 +5,7 @@ using Trixi
 # semidiscretization of the shallow water equations with a discontinuous
 # bottom topography function (set in the initial conditions)
 
-equations = ShallowWaterEquations2D(gravity_constant = 9.81, H0 = 3.0)
+equations = ShallowWaterEquations2D(gravity = 9.81, H0 = 3.0)
 
 # An initial condition with constant total water height and zero velocities to test well-balancedness.
 # Note, this routine is used to compute errors in the analysis callback but the initialization is

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_constant, H0 = 0)
+    ShallowWaterEquations1D(; gravity, H0 = 0)
 
 Shallow water equations (SWE) in one space dimension. The equations are given by
 ```math
@@ -17,7 +17,7 @@ Shallow water equations (SWE) in one space dimension. The equations are given by
 \end{aligned}
 ```
 The unknown quantities of the SWE are the water height ``h`` and the velocity ``v``.
-The gravitational constant is denoted by `g` and the (possibly) variable bottom topography function ``b(x)``.
+The gravitational acceleration is denoted by `g` and the (possibly) variable bottom topography function ``b(x)``.
 Conservative variable water height ``h`` is measured from the bottom topography ``b``, therefore one
 also defines the total water height as ``H = h + b``.
 
@@ -45,16 +45,16 @@ References for the SWE are many but a good introduction is available in Chapter
   [DOI: 10.1017/CBO9780511791253](https://doi.org/10.1017/CBO9780511791253)
 """
 struct ShallowWaterEquations1D{RealT <: Real} <: AbstractShallowWaterEquations{1, 3}
-    gravity::RealT # gravitational constant
+    gravity::RealT # gravitational acceleration
     H0::RealT      # constant "lake-at-rest" total water height
 end
 
-# Allow for flexibility to set the gravitational constant within an elixir depending on the
-# application where `gravity_constant=1.0` or `gravity_constant=9.81` are common values.
+# Allow for flexibility to set the gravitational acceleration within an elixir depending on the
+# application where `gravity=1.0` or `gravity=9.81` are common values.
 # The reference total water height H0 defaults to 0.0 but is used for the "lake-at-rest"
 # well-balancedness test cases.
-function ShallowWaterEquations1D(; gravity_constant, H0 = zero(gravity_constant))
-    ShallowWaterEquations1D(gravity_constant, H0)
+function ShallowWaterEquations1D(; gravity, H0 = zero(gravity))
+    ShallowWaterEquations1D(gravity, H0)
 end
 
 have_nonconservative_terms(::ShallowWaterEquations1D) = True()

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_constant, H0 = 0)
+    ShallowWaterEquations2D(; gravity, H0 = 0)
 
 Shallow water equations (SWE) in two space dimensions. The equations are given by
 ```math
@@ -20,7 +20,7 @@ Shallow water equations (SWE) in two space dimensions. The equations are given b
 \end{aligned}
 ```
 The unknown quantities of the SWE are the water height ``h`` and the velocities ``\mathbf{v} = (v_1, v_2)^T``.
-The gravitational constant is denoted by `g` and the (possibly) variable bottom topography function ``b(x,y)``.
+The gravitational acceleration is denoted by `g` and the (possibly) variable bottom topography function ``b(x,y)``.
 Conservative variable water height ``h`` is measured from the bottom topography ``b``, therefore one
 also defines the total water height as ``H = h + b``.
 
@@ -48,17 +48,17 @@ References for the SWE are many but a good introduction is available in Chapter
   [DOI: 10.1017/CBO9780511791253](https://doi.org/10.1017/CBO9780511791253)
 """
 struct ShallowWaterEquations2D{RealT <: Real} <: AbstractShallowWaterEquations{2, 4}
-    gravity::RealT # gravitational constant
+    gravity::RealT # gravitational acceleration
     H0::RealT      # constant "lake-at-rest" total water height
 end
 
-# Allow for flexibility to set the gravitational constant within an elixir depending on the
-# application where `gravity_constant=1.0` or `gravity_constant=9.81` are common values.
+# Allow for flexibility to set the gravitational acceleration within an elixir depending on the
+# application where `gravity=1.0` or `gravity=9.81` are common values.
 # The reference total water height H0 defaults to 0.0 but is used for the "lake-at-rest"
 # well-balancedness test cases.
 # Strict default values for thresholds that performed well in many numerical experiments
-function ShallowWaterEquations2D(; gravity_constant, H0 = zero(gravity_constant))
-    ShallowWaterEquations2D(gravity_constant, H0)
+function ShallowWaterEquations2D(; gravity, H0 = zero(gravity))
+    ShallowWaterEquations2D(gravity, H0)
 end
 
 have_nonconservative_terms(::ShallowWaterEquations2D) = True()