rename h to eta_prime

Author: JoshuaLampert

docs/src/dispersion.md

@@ -88,9 +88,9 @@ function initial_condition_traveling_wave(x, t, equations, mesh)
     omega = frequency(k)
     h0 = reference_height()
     A = 0.02
-    h = A * cos(k * x - omega * t)
-    v = sqrt(equations.gravity / k * tanh(k * h0)) * h / h0
-    eta = h + equations.eta0
+    eta_prime = A * cos(k * x - omega * t)
+    v = sqrt(equations.gravity / k * tanh(k * h0)) * eta_prime / h0
+    eta = eta_prime + equations.eta0
     D = h0
     return SVector(eta, v, D)
 end

src/equations/bbm_bbm_1d.jl

@@ -253,11 +253,11 @@ function initial_condition_dingemans(x, t, equations::BBMBBMEquations1D, mesh)
     k = 0.8406220896381442 # precomputed result of find_zero(k -> omega^2 - g * k * tanh(k * h0), 1.0) using Roots.jl
     offset = dingemans_calibration(equations)
     if x - offset < -34.5 * pi / k || x - offset > -4.5 * pi / k
-        h = 0.0
+        eta_prime = 0.0
     else
-        h = A * cos(k * (x - offset))
+        eta_prime = A * cos(k * (x - offset))
     end
-    v = sqrt(g / k * tanh(k * h0)) * h / h0
+    v = sqrt(g / k * tanh(k * h0)) * eta_prime / h0
     if 11.01 <= x && x < 23.04
         b = 0.6 * (x - 11.01) / (23.04 - 11.01)
     elseif 23.04 <= x && x < 27.04
@@ -267,9 +267,9 @@ function initial_condition_dingemans(x, t, equations::BBMBBMEquations1D, mesh)
     else
         b = 0.0
     end
-    # Here, we compute eta - h0!! To obtain the original eta, h0 = 0.8 needs to be added again!
+    # Here, we compute eta - eta0!! To obtain the original eta, eta0 = 0.8 needs to be added again!
     # This is because the BBM-BBM equations are only implemented for eta0 = 0
-    eta = h
+    eta = eta_prime
     D = h0 - b
     return SVector(eta, v, D)
 end

src/equations/equations.jl

@@ -641,11 +641,11 @@ function initial_condition_dingemans(x, t, equations::AbstractShallowWaterEquati
     k = 0.8406220896381442 # precomputed result of find_zero(k -> omega^2 - g * k * tanh(k * h0), 1.0) using Roots.jl
     offset = dingemans_calibration(equations)
     if x - offset < -34.5 * pi / k || x - offset > -4.5 * pi / k
-        h = 0.0
+        eta_prime = 0.0
     else
-        h = A * cos(k * (x - offset))
+        eta_prime = A * cos(k * (x - offset))
     end
-    v = sqrt(g / k * tanh(k * h0)) * h / h0
+    v = sqrt(g / k * tanh(k * h0)) * eta_prime / h0
     if 11.01 <= x && x < 23.04
         b = 0.6 * (x - 11.01) / (23.04 - 11.01)
     elseif 23.04 <= x && x < 27.04
@@ -656,7 +656,7 @@ function initial_condition_dingemans(x, t, equations::AbstractShallowWaterEquati
         b = 0.0
     end
     eta0 = equations.eta0
-    eta = h + h0
+    eta = eta_prime + eta0
     D = eta0 - b
     return SVector(eta, v, D)
 end