Merge branch 'main' into tm/autodiff_metrics

Author: tristanmontoya

.github/workflows/SpellCheck.yml

@@ -10,4 +10,4 @@ jobs:
       - name: Checkout Actions Repository
         uses: actions/checkout@v4
       - name: Check spelling
-        uses: crate-ci/typos@v1.30.0
+        uses: crate-ci/typos@v1.31.1

examples/elixir_shallowwater_cubed_sphere_shell_EC_correction.jl

@@ -6,7 +6,7 @@ using TrixiAtmo
 # Entropy conservation for the spherical shallow water equations in Cartesian
 # form obtained through an entropy correction term
 
-equations = ShallowWaterEquations3D(gravity_constant = 9.81)
+equations = ShallowWaterEquations3D(gravity = 9.81)
 
 # Create DG solver with polynomial degree = 3 and Wintemeyer et al.'s flux as surface flux
 polydeg = 3

examples/elixir_shallowwater_cubed_sphere_shell_EC_projection.jl

@@ -8,7 +8,7 @@ using TrixiAtmo
 # form obtained through the projection of the momentum onto the divergence-free
 # tangential contravariant vectors
 
-equations = ShallowWaterEquations3D(gravity_constant = 9.81)
+equations = ShallowWaterEquations3D(gravity = 9.81)
 
 # Create DG solver with polynomial degree = 3 and Wintemeyer et al.'s flux as surface flux
 polydeg = 3

examples/elixir_shallowwater_cubed_sphere_shell_advection.jl

@@ -21,7 +21,7 @@ cells_per_dimension = (5, 5)
 
 # We use the ShallowWaterEquations3D equations structure but modify the rhs! function to
 # convert it to a variable-coefficient advection equation
-equations = ShallowWaterEquations3D(gravity_constant = 0.0)
+equations = ShallowWaterEquations3D(gravity = 0.0)
 
 # Create DG solver with polynomial degree = 3 and (local) Lax-Friedrichs/Rusanov flux as surface flux
 solver = DGSEM(polydeg = 3, surface_flux = flux_lax_friedrichs)

examples/elixir_shallowwater_cubed_sphere_shell_standard.jl

@@ -6,7 +6,7 @@ using TrixiAtmo
 # Entropy consistency test for the spherical shallow water equations in Cartesian
 # form using the standard DGSEM with LLF dissipation
 
-equations = ShallowWaterEquations3D(gravity_constant = 9.81)
+equations = ShallowWaterEquations3D(gravity = 9.81)
 
 # Create DG solver with polynomial degree = 3 and (local) Lax-Friedrichs as surface flux
 polydeg = 3

examples/elixir_shallowwater_quad_icosahedron_shell_advection.jl

@@ -21,7 +21,7 @@ cells_per_dimension = (2, 2)
 
 # We use the ShallowWaterEquations3D equations structure but modify the rhs! function to
 # convert it to a variable-coefficient advection equation
-equations = ShallowWaterEquations3D(gravity_constant = 0.0)
+equations = ShallowWaterEquations3D(gravity = 0.0)
 
 # Create DG solver with polynomial degree = 3 and (local) Lax-Friedrichs/Rusanov flux as surface flux
 solver = DGSEM(polydeg = polydeg, surface_flux = flux_lax_friedrichs)

src/TrixiAtmo.jl

@@ -42,7 +42,7 @@ export flux_chandrashekar, FluxLMARS
 export flux_nonconservative_zeros, flux_nonconservative_ec,
        source_terms_geometric_coriolis
 
-export velocity, waterheight, pressure, energy_total, energy_kinetic, energy_internal,
+export velocity, pressure, energy_total, energy_kinetic, energy_internal,
        lake_at_rest_error, source_terms_lagrange_multiplier,
        clean_solution_lagrange_multiplier!
 

src/equations/covariant_shallow_water.jl

@@ -16,7 +16,7 @@ on a two-dimensional surface in three-dimensional ambient space as
 \end{aligned}
 ```
 where $h$ is the fluid height, $v^a$ and $G^{ab}$ are the contravariant velocity and metric 
-tensor components, $g$ is the gravitational constant, $f$ is the Coriolis parameter, 
+tensor components, $g$ is the gravitational acceleration, $f$ is the Coriolis parameter, 
 $J$ is the area element, and $\partial_a$ is used as a shorthand for 
 $\partial / \partial \xi^a$. Combining the advective and pressure terms in order to define 
 the momentum flux components
@@ -92,7 +92,7 @@ function Trixi.varnames(::typeof(contravariant2global),
 end
 
 # Convenience functions to extract physical variables from state vector
-@inline waterheight(u, ::AbstractCovariantShallowWaterEquations2D) = u[1]
+@inline Trixi.waterheight(u, ::AbstractCovariantShallowWaterEquations2D) = u[1]
 @inline velocity_contravariant(u,
 ::AbstractCovariantShallowWaterEquations2D) = SVector(u[2] /
                                                       u[1],

src/equations/shallow_water_3d.jl

@@ -19,7 +19,7 @@ The equations are given by
 \end{aligned}
 ```
 The unknown quantities of the SWE are the water height ``h`` and the velocities ``\mathbf{v} = (v_1, v_2, v_3)^T``.
-The gravitational constant is denoted by `g`.
+The gravitational acceleration is denoted by `g`.
 
 The 3D Shallow Water Equations (SWE) extend the 2D SWE to model shallow water flows on 2D manifolds embedded within 3D space. 
 To confine the flow to the 2D manifold, a source term incorporating a Lagrange multiplier is applied. 
@@ -48,17 +48,17 @@ References:
 """
 struct ShallowWaterEquations3D{RealT <: Real} <:
        Trixi.AbstractShallowWaterEquations{3, 5}
-    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 ShallowWaterEquations3D(; gravity_constant, H0 = zero(gravity_constant))
-    T = promote_type(typeof(gravity_constant), typeof(H0))
-    ShallowWaterEquations3D(gravity_constant, H0)
+function ShallowWaterEquations3D(; gravity, H0 = zero(gravity))
+    T = promote_type(typeof(gravity), typeof(H0))
+    ShallowWaterEquations3D(gravity, H0)
 end
 
 Trixi.have_nonconservative_terms(::ShallowWaterEquations3D) = False() # Deactivate non-conservative terms for the moment...
@@ -346,7 +346,7 @@ end
     return SVector(h, h_v1, h_v2, h_v3, b)
 end
 
-@inline function waterheight(u, equations::ShallowWaterEquations3D)
+@inline function Trixi.waterheight(u, equations::ShallowWaterEquations3D)
     return u[1]
 end