Add 2D-SWE and move wet/dry functionality from Trixi.jl #18

patrickersing · 2024-01-23T16:30:32Z

This PR introduces the 2D shallow water equations and the wet/dry functionality, that is to be removed from Trixi.jl in trixi-framework/Trixi.jl#1809. The two-layer SWE, that are also removed will be introduced in a separate PR.

One notable change in this PR is that I changed from using Trixi: Trixi => using Trixi. While moving more code to TrixiShallowWater.jl, I noticed that it is becoming to cumbersome and hard to read when we qualify every symbol from Trixi.jl, especially when using repetitive basic functionalities such as nnodes or eachelement.
With this change we now only need to qualify functions that will be extended by TrixiShallowWater.jl or when accessing functions that are not exported by Trixi.jl.

Besides that most of the code changes are just copied over from Trixi.jl and adapted to the new package.

The PR should only be merged after removing these features from Trixi.jl in trixi-framework/Trixi.jl#1809

Reminder: We will need to bump the compat bounds in the Project.toml for Trixi to 0.7 once it is released.

codecov · 2024-02-23T18:01:49Z

Codecov Report

Attention: Patch coverage is 99.18888% with 7 lines in your changes are missing coverage. Please review.

Project coverage is 99.25%. Comparing base (7d236c4) to head (42cf9ee).

Files	Patch %	Lines
...c/callbacks_stage/positivity_shallow_water_dg1d.jl	95.12%	2 Missing ⚠️
...c/callbacks_stage/positivity_shallow_water_dg2d.jl	95.45%	2 Missing ⚠️
src/solvers/indicators.jl	94.73%	1 Missing ⚠️
src/solvers/indicators_1d.jl	97.82%	1 Missing ⚠️
src/solvers/indicators_2d.jl	97.87%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##              main      #18      +/-   ##
===========================================
- Coverage   100.00%   99.25%   -0.75%     
===========================================
  Files            4       32      +28     
  Lines           85      941     +856     
===========================================
+ Hits            85      934     +849     
- Misses           0        7       +7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

andrewwinters5000

Mostly just formatting or some text updates to the docstrings. I only left two questions regarding how the min_max_speed_chen_noelle dispatches within the new package.

Project.toml

examples/tree_1d_dgsem/elixir_shallowwater_beach.jl

examples/tree_1d_dgsem/elixir_shallowwater_shock_capturing.jl

src/TrixiShallowWater.jl

test/test_tree_2d_shallowwater_wet_dry.jl

src/solvers/indicators.jl

src/solvers/indicators_1d.jl

src/solvers/indicators_2d.jl

src/equations/shallow_water_wet_dry_1d.jl

src/equations/shallow_water_wet_dry_2d.jl

…Algebra

andrewwinters5000

Things are looking very nice! Just one small changes that I think is necessary.

src/equations/shallow_water_wet_dry_2d.jl

andrewwinters5000

LGTM! Fantastic work @patrickersing! I think we can merge this and continue onto adding in the two-layer equations. Do you want one last look @sloede ?

sloede

Overall this looks good to me and nearly ready to merge. I've just left a few suggestions, most of which are food for thought and could be addressed later.

Great job, @patrickersing, I am looking forward to seeing TrixiShallowWater.jl as a registered package :-)

.github/workflows/FormatCheck.yml

src/TrixiShallowWater.jl

src/equations/shallow_water_wet_dry_2d.jl

…trixi

src/equations/shallow_water_wet_dry_2d.jl

sloede

LGTM! Great job, @patrickersing!

patrickersing · 2024-03-08T14:10:25Z

Great, @andrewwinters5000 then we should be ready to merge! 🎉
Thanks a lot for the reviews!

andrewwinters5000

We are good to go!

patrickersing and others added 30 commits December 18, 2023 09:03

add equation SWEWetDry1D

c9cb2ea

add tests and elixirs

6f23516

add OrdinaryDiffEq as a test dependency

49e1ef4

comment functions related to HR_chen_noelle

83f321a

fix tests

02c2884

fix tests #2

b86c4ae

fix tests #3

9f49340

fix tests 4

df7d15e

fix tests 5

dba63bc

fix tests 6

5d5d29a

add unit tests and namespace conflict test

b58e902

update unit tests, comment wave speed estimates

d0eb6dd

update unit test

5fc8eec

add compat bounds

c02cbf6

add some comments

64b9bf3

clean some comments, remove wave speed estimates

6b585b9

Merge branch 'main'

aea21a8

Merge branch 'main' into main

209d746

comment unused lines

9ffdc27

include examples folder for coverage test

5fc3c36

add upstream tests

aa21b7f

fix ci

00247c4

Adjust comment

d256bc7

remove comments

8184d68

do using Trixi instead of using Trixi : Trixi

cd95eab

update swe-1d

1c6dcee

add swe-2d

c99ee93

add wet/dry functionality, tests and examples

b612cc1

add unit tests

c47527e

Update comments in test files

7eeb2ab

patrickersing added 2 commits February 23, 2024 16:23

add Printf to Project.toml

6f0ab56

Change wavespeed estimate to fix tests with hll fluxes

60d4ed0

patrickersing added 2 commits February 26, 2024 10:23

add unit tests, remove unused function

26f7b89

apply formatter

e3007ae

andrewwinters5000 requested changes Feb 26, 2024

View reviewed changes

patrickersing added 3 commits February 27, 2024 09:31

Change comments according to code review, add compat bound for Linear…

77f44c6

…Algebra

reorganize single test files for each mesh type

92f2fdd

Add own flux hll and wave speed estimates; add unit tests

0fc33bc

patrickersing marked this pull request as ready for review February 29, 2024 10:58

andrewwinters5000 requested changes Mar 1, 2024

View reviewed changes

src/equations/shallow_water_wet_dry_2d.jl Outdated Show resolved Hide resolved

patrickersing added 2 commits March 1, 2024 07:51

remove unnecessary qualifier

276990a

apply formatter

9cc7904

patrickersing mentioned this pull request Mar 6, 2024

Introduce additional abstraction layer for the SWE/SWEWD to reduce code duplication #24

Open

Merge branch 'main' into swe_wetdry

be35c59

andrewwinters5000 previously approved these changes Mar 6, 2024

View reviewed changes

sloede reviewed Mar 8, 2024

View reviewed changes

Apply changes from code review and introduce new field equations.swe_…

033bb48

…trixi

patrickersing dismissed andrewwinters5000’s stale review via 033bb48 March 8, 2024 10:15

apply formatter

595caf2

sloede reviewed Mar 8, 2024

View reviewed changes

src/equations/shallow_water_wet_dry_2d.jl Outdated Show resolved Hide resolved

Update name and type assignment of swe_trixi -> basic_swe

8e14bba

sloede reviewed Mar 8, 2024

View reviewed changes

src/equations/shallow_water_wet_dry_2d.jl Show resolved Hide resolved

add comment about duplication of g and H0

42cf9ee

sloede approved these changes Mar 8, 2024

View reviewed changes

andrewwinters5000 approved these changes Mar 8, 2024

View reviewed changes

andrewwinters5000 merged commit c9b159c into trixi-framework:main Mar 8, 2024
6 of 9 checks passed

patrickersing mentioned this pull request Mar 8, 2024

Decide how to deal with shared functionality of the SWE #27

Open

patrickersing deleted the swe_wetdry branch March 8, 2024 14:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add 2D-SWE and move wet/dry functionality from Trixi.jl #18

Add 2D-SWE and move wet/dry functionality from Trixi.jl #18

patrickersing commented Jan 23, 2024 •

edited by andrewwinters5000

Loading

codecov bot commented Feb 23, 2024 •

edited

Loading

andrewwinters5000 left a comment

andrewwinters5000 left a comment

andrewwinters5000 left a comment

sloede left a comment

sloede left a comment

patrickersing commented Mar 8, 2024

andrewwinters5000 left a comment

Add 2D-SWE and move wet/dry functionality from Trixi.jl #18

Add 2D-SWE and move wet/dry functionality from Trixi.jl #18

Conversation

patrickersing commented Jan 23, 2024 • edited by andrewwinters5000 Loading

codecov bot commented Feb 23, 2024 • edited Loading

Codecov Report

andrewwinters5000 left a comment

Choose a reason for hiding this comment

andrewwinters5000 left a comment

Choose a reason for hiding this comment

andrewwinters5000 left a comment

Choose a reason for hiding this comment

sloede left a comment

Choose a reason for hiding this comment

sloede left a comment

Choose a reason for hiding this comment

patrickersing commented Mar 8, 2024

andrewwinters5000 left a comment

Choose a reason for hiding this comment

patrickersing commented Jan 23, 2024 •

edited by andrewwinters5000

Loading

codecov bot commented Feb 23, 2024 •

edited

Loading