Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dry air warm bubble test case #1779

Merged
merged 36 commits into from
Jan 12, 2024
Merged

Add dry air warm bubble test case #1779

merged 36 commits into from
Jan 12, 2024

Conversation

benegee
Copy link
Contributor

@benegee benegee commented Dec 18, 2023

Easy part of #1778

Copy link
Contributor

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

@benegee benegee changed the title Add dry air warm bubble test case WIP: Add dry air warm bubble test case Dec 18, 2023
@benegee benegee marked this pull request as draft December 18, 2023 14:45
@benegee benegee self-assigned this Dec 18, 2023
examples/structured_2d_dgsem/elixir_euler_warm_bubble.jl Outdated Show resolved Hide resolved
examples/structured_2d_dgsem/elixir_euler_warm_bubble.jl Outdated Show resolved Hide resolved
examples/structured_2d_dgsem/elixir_euler_warm_bubble.jl Outdated Show resolved Hide resolved
src/equations/compressible_euler_2d.jl Outdated Show resolved Hide resolved
src/equations/compressible_euler_2d.jl Outdated Show resolved Hide resolved
src/equations/compressible_euler_3d.jl Show resolved Hide resolved
@benegee
Copy link
Contributor Author

benegee commented Dec 19, 2023

Thanks for the review @ranocha. You were way too fast for me. I will add further remarks soon!

@benegee
Copy link
Contributor Author

benegee commented Dec 19, 2023

Concerning testing:
Is it sufficient (and necessary) to add the elixir to the test suite? I reduced resolution and final solution time s.t. it has a runtime of about 2 seconds on my laptop.

@ranocha
Copy link
Member

ranocha commented Dec 19, 2023

Concerning testing: Is it sufficient (and necessary) to add the elixir to the test suite? I reduced resolution and final solution time s.t. it has a runtime of about 2 seconds on my laptop.

Yes, please. The elixir can have settings such that it is somewhat useful - maybe with a warning about the execution time and required resources. We can reduce the resolution and final time for testing via keyword arguments of of the testing macro.

Copy link

codecov bot commented Dec 21, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (2463b38) 88.88% compared to head (db447f8) 96.30%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1779      +/-   ##
==========================================
+ Coverage   88.88%   96.30%   +7.42%     
==========================================
  Files         439      441       +2     
  Lines       35635    35734      +99     
==========================================
+ Hits        31672    34413    +2741     
+ Misses       3963     1321    -2642     
Flag Coverage Δ
unittests 96.30% <100.00%> (+7.42%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@benegee benegee marked this pull request as ready for review December 21, 2023 13:18
@benegee benegee changed the title WIP: Add dry air warm bubble test case Add dry air warm bubble test case Dec 21, 2023
@benegee benegee requested a review from ranocha January 9, 2024 13:25
Copy link
Member

@andrewwinters5000 andrewwinters5000 left a comment

Choose a reason for hiding this comment

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

The results are looking good. I left a few comments because I feel that the warm bubble test setup needs some clarification.

examples/structured_2d_dgsem/elixir_euler_warm_bubble.jl Outdated Show resolved Hide resolved
src/equations/compressible_euler_2d.jl Outdated Show resolved Hide resolved
src/equations/compressible_euler_2d.jl Outdated Show resolved Hide resolved
src/equations/compressible_euler_3d.jl Outdated Show resolved Hide resolved
src/equations/compressible_euler_3d.jl Outdated Show resolved Hide resolved
test/test_p4est_3d.jl Show resolved Hide resolved
Copy link
Member

@andrewwinters5000 andrewwinters5000 left a comment

Choose a reason for hiding this comment

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

LGTM!

@benegee
Copy link
Contributor Author

benegee commented Jan 12, 2024

Thank you all for your support!

@ranocha ranocha merged commit 4bb74f8 into main Jan 12, 2024
32 of 33 checks passed
@ranocha ranocha deleted the add-warm-bubble-test-case branch January 12, 2024 12:30
@DanielDoehring
Copy link
Contributor

What about PRs #171 and #1017 ?
Can they be closed as tackled?

@sloede
Copy link
Member

sloede commented Jan 14, 2024

What about PRs #171 and #1017 ? Can they be closed as tackled?

Good point! @bgeihe Do you feel like there is something in the other two PRs that is missing from your PR? If yes, it would be great to document this (maybe in an issue) but if not, it would be nice to close the PRs with a friendly & explanatory message

@benegee
Copy link
Contributor Author

benegee commented Jan 15, 2024

What about PRs #171 and #1017 ? Can they be closed as tackled?

Not yet. This PR covers the first part of #1778 (warm rising bubble in dry air, no changes to the underlying equations). The next part will deal with moist air.

Thanks for the reference to #1017!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants