From 86883cf02b973429b1d63359561a3a1012edd9d0 Mon Sep 17 00:00:00 2001 From: Joshua Lampert <51029046+JoshuaLampert@users.noreply.github.com> Date: Sat, 17 Aug 2024 14:17:16 +0200 Subject: [PATCH 1/2] Apply suggestions from code review Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs/make.jl | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 56dc136d..8503ee40 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -16,10 +16,12 @@ lines = readlines(ref_path) open(ref_path, "w") do io for line in lines if contains(line, "EQUATIONS_FILES_TO_BE_INSERTED") - line = replace(line, "EQUATIONS_FILES_TO_BE_INSERTED" => EQUATIONS_FILES_TO_BE_INSERTED) + line = replace(line, + "EQUATIONS_FILES_TO_BE_INSERTED" => EQUATIONS_FILES_TO_BE_INSERTED) end if contains(line, "CALLBACKS_STEP_FILES_TO_BE_INSERTED") - line = replace(line, "CALLBACKS_STEP_FILES_TO_BE_INSERTED" => CALLBACKS_STEP_FILES_TO_BE_INSERTED) + line = replace(line, + "CALLBACKS_STEP_FILES_TO_BE_INSERTED" => CALLBACKS_STEP_FILES_TO_BE_INSERTED) end println(io, line) end From c4fb1c9d885af2fc579e0b1d44f616e286dc54de Mon Sep 17 00:00:00 2001 From: Joshua Lampert <51029046+JoshuaLampert@users.noreply.github.com> Date: Sat, 17 Aug 2024 14:38:27 +0200 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Hendrik Ranocha --- src/DispersiveShallowWater.jl | 9 ++++++--- src/equations/svaerd_kalisch_1d.jl | 6 ++---- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/src/DispersiveShallowWater.jl b/src/DispersiveShallowWater.jl index e20e3cf1..294bb2e5 100644 --- a/src/DispersiveShallowWater.jl +++ b/src/DispersiveShallowWater.jl @@ -2,10 +2,13 @@ DispersiveShallowWater **DispersiveShallowWater.jl** is a Julia package that implements structure-preserving numerical methods for dispersive shallow water models. -It provides provably conservative, entropy-conserving and well-balanced numerical schemes for some dispersive shallow water models. +It provides provably conservative, entropy-conserving, and well-balanced numerical schemes for some dispersive shallow water models. -The semidiscretizations are based on summation-by-parts (SBP) operators, which are implemented in SummationByPartsOperators.jl. To -obtain fully discrete schemes, the time integration methods from OrdinaryDiffEq.jl are used to solve the resulting ordinary differential equations. +The semidiscretizations are based on summation-by-parts (SBP) operators, which are implemented in +[SummationByPartsOperators.jl](https://github.com/ranocha/SummationByPartsOperators.jl). To +obtain fully discrete schemes, the time integration methods from +[OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl) +are used to solve the resulting ordinary differential equations. Fully discrete entropy-conservative methods can be obtained by using the relaxation method provided by DispersiveShallowWater.jl. See also: [DispersiveShallowWater.jl](https://github.com/JoshuaLampert/DispersiveShallowWater.jl) diff --git a/src/equations/svaerd_kalisch_1d.jl b/src/equations/svaerd_kalisch_1d.jl index 042a5d41..0a5949ea 100644 --- a/src/equations/svaerd_kalisch_1d.jl +++ b/src/equations/svaerd_kalisch_1d.jl @@ -338,10 +338,8 @@ end Return the modified total energy of the primitive variables `q_global` for the [`SvaerdKalischEquations1D`](@ref). It contains an additional term containing a -derivative compared to the usual `energy_total`. The `energy_total_modified` -is a conserved quantity of the Svärd-Kalisch equations. - -The total energy is given by +derivative compared to the usual [`energy_total`](@ref). The `energy_total_modified` +is a conserved quantity of the Svärd-Kalisch equations given by ```math \\frac{1}{2} g h^2 + \\frac{1}{2} h v^2 + \\frac{1}{2} \\hat\\beta v_x^2. ```