Skip to content

Clarify parameters of Svärd-Kalisch equations#262

Merged
ranocha merged 1 commit intomainfrom
docstring-parameters-SK
Nov 18, 2025
Merged

Clarify parameters of Svärd-Kalisch equations#262
ranocha merged 1 commit intomainfrom
docstring-parameters-SK

Conversation

@JoshuaLampert
Copy link
Copy Markdown
Member

@JoshuaLampert JoshuaLampert commented Nov 18, 2025

Does this resolve your issue in #258, @pnavaro?
Closes #258.

@JoshuaLampert JoshuaLampert added the documentation Improvements or additions to documentation label Nov 18, 2025
@github-actions
Copy link
Copy Markdown
Contributor

Benchmark Results (Julia v1.10)

Time benchmarks
main dc15a63... main / dc15a63...
bbm_1d/bbm_1d_basic.jl - rhs!: 13.8 ± 0.3 μs 14.1 ± 0.84 μs 0.973 ± 0.062
bbm_1d/bbm_1d_fourier.jl - rhs!: 0.217 ± 0.15 ms 0.216 ± 0.0089 ms 1 ± 0.68
bbm_bbm_1d/bbm_bbm_1d_basic_reflecting.jl - rhs!: 0.0806 ± 0.00041 ms 0.0804 ± 0.0004 ms 1 ± 0.0071
bbm_bbm_1d/bbm_bbm_1d_dg.jl - rhs!: 0.0344 ± 0.00049 ms 0.034 ± 0.00049 ms 1.01 ± 0.021
bbm_bbm_1d/bbm_bbm_1d_relaxation.jl - rhs!: 27.1 ± 0.41 μs 27.1 ± 0.57 μs 1 ± 0.026
bbm_bbm_1d/bbm_bbm_1d_upwind_relaxation.jl - rhs!: 0.0491 ± 0.00049 ms 0.0482 ± 0.00055 ms 1.02 ± 0.015
hyperbolic_serre_green_naghdi_1d/hyperbolic_serre_green_naghdi_dingemans.jl - rhs!: 4.2 ± 0.03 μs 4.3 ± 0.031 μs 0.977 ± 0.0099
kdv_1d/kdv_1d_basic.jl - rhs!: 1.44 ± 0.019 μs 1.42 ± 0.02 μs 1.01 ± 0.02
kdv_1d/kdv_1d_implicit.jl - rhs!: 1.39 ± 0.019 μs 1.42 ± 0.02 μs 0.978 ± 0.019
serre_green_naghdi_1d/serre_green_naghdi_well_balanced.jl - rhs!: 0.203 ± 0.0087 ms 0.202 ± 0.0085 ms 1.01 ± 0.06
svaerd_kalisch_1d/svaerd_kalisch_1d_dingemans_relaxation.jl - rhs!: 0.148 ± 0.0043 ms 0.148 ± 0.0045 ms 1 ± 0.042
time_to_load 2.03 ± 0.0098 s 2 ± 0.0043 s 1.01 ± 0.0054
Memory benchmarks
main dc15a63... main / dc15a63...
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
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@coveralls
Copy link
Copy Markdown
Collaborator

Pull Request Test Coverage Report for Build 19472493470

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.552%

Totals Coverage Status
Change from base Build 19433129167: 0.0%
Covered Lines: 2314
Relevant Lines: 2348

💛 - Coveralls

Copy link
Copy Markdown
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@ranocha ranocha merged commit 6d5248b into main Nov 18, 2025
13 checks passed
@ranocha ranocha deleted the docstring-parameters-SK branch November 18, 2025 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Svaerd-Kalisch model

5 participants