Changes to Dingemans initital condition

[JoshuaLampert]

This PR

• changes the range of the initial wave train to $$[-34.5\pi/k, -4.5\pi/k]$$,
• substracts an equation-specific offset to the initial wave train to compensate for a phase shift between the initial condition and the experimental data
• renames h to eta_prime to avoid confusion (eta_prime is the deviation of eta from the lake-at-rest state, i.e. $$\eta = \eta' + \eta_0$$)

TODO: fix test reference values

[github-actions]

Benchmark Results (Julia v1.10)

Time benchmarks

	main	fb08e19...	main / fb08e19...
bbm_1d/bbm_1d_basic.jl - rhs!:	14.1 ± 0.37 μs	14 ± 0.76 μs	1.01 ± 0.061
bbm_1d/bbm_1d_fourier.jl - rhs!:	0.526 ± 0.32 ms	0.452 ± 0.23 ms	1.16 ± 0.92
bbm_bbm_1d/bbm_bbm_1d_basic_reflecting.jl - rhs!:	0.0812 ± 0.00042 ms	0.0806 ± 0.00041 ms	1.01 ± 0.0073
bbm_bbm_1d/bbm_bbm_1d_dg.jl - rhs!:	0.0341 ± 0.00048 ms	0.0341 ± 0.0015 ms	1 ± 0.047
bbm_bbm_1d/bbm_bbm_1d_relaxation.jl - rhs!:	27.5 ± 0.45 μs	27.4 ± 0.45 μs	1 ± 0.023
bbm_bbm_1d/bbm_bbm_1d_upwind_relaxation.jl - rhs!:	0.0486 ± 0.00056 ms	0.0485 ± 0.0028 ms	1 ± 0.059
hyperbolic_serre_green_naghdi_1d/hyperbolic_serre_green_naghdi_dingemans.jl - rhs!:	4.34 ± 0.05 μs	4.22 ± 0.039 μs	1.03 ± 0.015
kdv_1d/kdv_1d_basic.jl - rhs!:	1.47 ± 0.02 μs	1.43 ± 0.021 μs	1.03 ± 0.021
kdv_1d/kdv_1d_implicit.jl - rhs!:	1.42 ± 0.011 μs	1.4 ± 0.03 μs	1.01 ± 0.023
serre_green_naghdi_1d/serre_green_naghdi_well_balanced.jl - rhs!:	0.201 ± 0.0087 ms	0.199 ± 0.0074 ms	1.01 ± 0.058
svaerd_kalisch_1d/svaerd_kalisch_1d_dingemans_relaxation.jl - rhs!:	0.147 ± 0.0043 ms	0.145 ± 0.0036 ms	1.01 ± 0.039
time_to_load	1.93 ± 0.0068 s	1.94 ± 0.027 s	0.994 ± 0.014

Memory benchmarks

	main	fb08e19...	main / fb08e19...
bbm_1d/bbm_1d_basic.jl - rhs!:	1 allocs: 4.12 kB	1 allocs: 4.12 kB	1
bbm_1d/bbm_1d_fourier.jl - rhs!:	1 allocs: 4.12 kB	1 allocs: 4.12 kB	1
bbm_bbm_1d/bbm_bbm_1d_basic_reflecting.jl - rhs!:	5 allocs: 1.17 kB	5 allocs: 1.17 kB	1
bbm_bbm_1d/bbm_bbm_1d_dg.jl - rhs!:	10 allocs: 8.62 kB	10 allocs: 8.62 kB	1
bbm_bbm_1d/bbm_bbm_1d_relaxation.jl - rhs!:	2 allocs: 8.25 kB	2 allocs: 8.25 kB	1
bbm_bbm_1d/bbm_bbm_1d_upwind_relaxation.jl - rhs!:	2 allocs: 8.25 kB	2 allocs: 8.25 kB	1
hyperbolic_serre_green_naghdi_1d/hyperbolic_serre_green_naghdi_dingemans.jl - rhs!:	0 allocs: 0 B	0 allocs: 0 B
kdv_1d/kdv_1d_basic.jl - rhs!:	0 allocs: 0 B	0 allocs: 0 B
kdv_1d/kdv_1d_implicit.jl - rhs!:	0 allocs: 0 B	0 allocs: 0 B
serre_green_naghdi_1d/serre_green_naghdi_well_balanced.jl - rhs!:	0.075 k allocs: 0.66 MB	0.075 k allocs: 0.66 MB	1
svaerd_kalisch_1d/svaerd_kalisch_1d_dingemans_relaxation.jl - rhs!:	0.042 k allocs: 0.315 MB	0.042 k allocs: 0.315 MB	1
time_to_load	0.153 k allocs: 14.5 kB	0.153 k allocs: 14.5 kB	1

[codecov-commenter]

Codecov Report

❌ Patch coverage is 94.11765% with 1 line in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/equations/equations.jl	85.71%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

[coveralls]

Pull Request Test Coverage Report for Build 17211214456

Details

• 16 of 17 (94.12%) changed or added relevant lines in 5 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage decreased (-0.04%) to 98.285%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/equations/equations.jl	6	7	85.71%

Totals
Change from base Build 17155945350:	-0.04%
Covered Lines:	2292
Relevant Lines:	2332

---

💛 - Coveralls

[ranocha]

Thanks! I did not check the results manually but assume that you optimized the setup appropriately.