Rename gravity_constant to gravity (#174)

Author: JoshuaLampert

NEWS.md

@@ -5,10 +5,16 @@ DispersiveShallowWater.jl follows the interpretation of
 used in the Julia ecosystem. Notable changes will be documented in this file
 for human readability.
 
+## Changes when updating to v0.6 from v0.5.x
+
+#### Changed
+
+- The keyword argument and function `gravity_constant` have been changed to `gravity` ([#174]).
 
 ## Changes in the v0.5 lifecycle
 
 #### Added
+
 - Add `LinearDispersionRelation` and documentation about dispersion ([#168]).
 - Reflecting boundary conditions are added for the Svärd-Kalisch equations with `alpha = gamma = 0` ([#166]).
 - Fix a bug in the upwind discretization of the `SvärdKalischEquations1D`.
@@ -20,6 +26,7 @@ for human readability.
 ## Changes when updating to v0.5 from v0.4.x
 
 #### Changed
+
 - The `BBMBBMVariableEquations1D` were removed and `BBMBBMEquations1D` now supports a `bathymetry_type` to
   choose between a flat and a variable bathymetry ([#147]).
 - The default of `bathymetry_type` for the `SerreGreenNaghdiEquations1D` changed from `bathymetry_flat` to
@@ -31,6 +38,7 @@ for human readability.
 ## Changes in the v0.4 lifecycle
 
 #### Added
+
 - The `SerreGreenNaghdiEquations1D` were added for different types of bathymetry ([#127], [#135]).
 - The `HyperbolicSerreGreenNaghdiEquations1D` were added for different types of bathymetry ([#139]).
 - The abstract interface `AbstractShallowWaterEquations` was added to unify several
@@ -41,11 +49,13 @@ for human readability.
 ## Changes when updating to v0.4 from v0.3.x
 
 #### Changed
+
 - Use `ArrayPartition` from RecursiveArrayTools.jl to store the solution of the `ODEProblem` ([#118]).
 
 ## Changes in the v0.3 lifecycle
 
 #### Added
+
 - Add possibility to pass vector of `Ns` to `convergence_test` ([#113]).
 - Performance improvements by using factorized matrices for linear systems solves ([#108], [#112], [#114]).
 - Reflecting boundary conditions are added for the BBM-BBM equations ([#104], [#109]).
@@ -55,17 +65,20 @@ for human readability.
 ## Changes when updating to v0.3 from v0.2.x
 
 #### Changed
+
 - Add keyword argument `start_from` when plotting `AnalysisCallback` ([#87]).
 - Manufactured solution for Svärd-Kalisch equations uses a variable bathymetry ([#84]).
 
 ## Changes in the v0.2 lifecycle
 
 #### Added
+
 - Add `SummaryCallback` ([#75]).
 
 ## Changes when updating to v0.2 from v0.1.x
 
 #### Changed
+
 - The code from the master thesis of Joshua Lampert was separated ([#69]).
 - Add support for source terms ([#65]).
 - A higher order interpolation is used when plotting the solution at a value `x` outside

Project.toml

@@ -35,7 +35,7 @@ RecipesBase = "1.3.4"
 RecursiveArrayTools = "3.27"
 Reexport = "1.2.2"
 Roots = "2.0.17"
-SciMLBase = "2.56"
+SciMLBase = "2.78"
 SimpleUnPack = "1.1"
 SparseArrays = "1"
 StaticArrays = "1.9.7"

docs/src/dispersion.md

@@ -42,19 +42,19 @@ g = 9.81
 disp_rel = LinearDispersionRelation(h0)
 k = 0.01:0.01:5.0
 
-euler = EulerEquations1D(; gravity_constant = g, eta0 = eta0)
+euler = EulerEquations1D(; gravity = g, eta0 = eta0)
 c_euler = wave_speed.(disp_rel, euler, k; normalize = true)
 plot(k, c_euler, label = "Euler", xlabel = "k", ylabel = "c / c_0", legend = :topright)
 
-bbm = BBMEquation1D(; gravity_constant = g, eta0 = eta0, D = h0)
+bbm = BBMEquation1D(; gravity = g, eta0 = eta0, D = h0)
 c_bbm = wave_speed.(disp_rel, bbm, k; normalize = true)
 plot!(k, c_bbm, label = "BBM")
 
-sk = SvaerdKalischEquations1D(; gravity_constant = g, eta0 = eta0)
+sk = SvaerdKalischEquations1D(; gravity = g, eta0 = eta0)
 c_sk = wave_speed.(disp_rel, sk, k; normalize = true)
 plot!(k, c_sk, label = "Svärd-Kalisch")
 
-sgn = SerreGreenNaghdiEquations1D(; gravity_constant = g, eta0 = eta0)
+sgn = SerreGreenNaghdiEquations1D(; gravity = g, eta0 = eta0)
 c_sgn = wave_speed.(disp_rel, sgn, k; normalize = true)
 plot!(k, c_sgn, label = "Serre-Green-Naghdi")
 

docs/src/overview.md

@@ -37,7 +37,7 @@ including physical parameters, initial and boundary conditions as well as the do
 describes a traveling wave that moves towards a beach, which is modeled by a linearly increasing bathymetry.
 
 ```@example overview
-equations = BBMBBMEquations1D(bathymetry_type = bathymetry_variable, gravity_constant = 9.81)
+equations = BBMBBMEquations1D(bathymetry_type = bathymetry_variable, gravity = 9.81)
 
 function initial_condition_shoaling(x, t, equations::BBMBBMEquations1D, mesh)
     A = 0.07 # amplitude of wave

examples/bbm_1d/bbm_1d_basic.jl

@@ -4,7 +4,7 @@ using DispersiveShallowWater
 ###############################################################################
 # Semidiscretization of the BBM equation (conserves the quadratic invariant)
 
-equations = BBMEquation1D(gravity_constant = 9.81, split_form = true)
+equations = BBMEquation1D(gravity = 9.81, split_form = true)
 
 initial_condition = initial_condition_convergence_test
 boundary_conditions = boundary_condition_periodic

examples/bbm_1d/bbm_1d_fourier.jl

@@ -5,7 +5,7 @@ using SummationByPartsOperators: fourier_derivative_operator
 ###############################################################################
 # Semidiscretization of the BBM equation
 
-equations = BBMEquation1D(gravity_constant = 9.81)
+equations = BBMEquation1D(gravity = 9.81)
 
 initial_condition = initial_condition_convergence_test
 boundary_conditions = boundary_condition_periodic

examples/bbm_1d/bbm_1d_hamiltonian_relaxation.jl

@@ -4,7 +4,7 @@ using DispersiveShallowWater
 ###############################################################################
 # Semidiscretization of the BBM equation (conserves the cubic Hamiltonian)
 
-equations = BBMEquation1D(gravity_constant = 9.81, split_form = false)
+equations = BBMEquation1D(gravity = 9.81, split_form = false)
 
 initial_condition = initial_condition_convergence_test
 boundary_conditions = boundary_condition_periodic

examples/bbm_1d/bbm_1d_manufactured.jl

@@ -4,7 +4,7 @@ using DispersiveShallowWater
 ###############################################################################
 # Semidiscretization of the BBM equation
 
-equations = BBMEquation1D(gravity_constant = 9.81, D = 2.0)
+equations = BBMEquation1D(gravity = 9.81, D = 2.0)
 
 initial_condition = initial_condition_manufactured
 source_terms = source_terms_manufactured

examples/bbm_1d/bbm_1d_relaxation.jl

@@ -4,7 +4,7 @@ using DispersiveShallowWater
 ###############################################################################
 # Semidiscretization of the BBM equation
 
-equations = BBMEquation1D(gravity_constant = 9.81)
+equations = BBMEquation1D(gravity = 9.81)
 
 initial_condition = initial_condition_convergence_test
 boundary_conditions = boundary_condition_periodic

examples/bbm_bbm_1d/bbm_bbm_1d_basic.jl

@@ -5,7 +5,7 @@ using DispersiveShallowWater
 # Semidiscretization of the BBM-BBM equations
 
 # or bathymetry_variable instead of bathymetry_flat
-equations = BBMBBMEquations1D(bathymetry_type = bathymetry_flat, gravity_constant = 9.81)
+equations = BBMBBMEquations1D(bathymetry_type = bathymetry_flat, gravity = 9.81)
 
 # initial_condition_convergence_test needs periodic boundary conditions
 initial_condition = initial_condition_convergence_test