Trixi.jl icon indicating copy to clipboard operation
Trixi.jl copied to clipboard

Add moist Euler equations with warm bubble test case

Open benegee opened this issue 1 year ago • 2 comments

This PR restructures CompressibleEulerMulticomponentEquations

  • AbstractCompressibleEulerMulticomponentEquations{2} is introduced as another abstract type. All common methods are implemented for this abstract type
  • CompressibleEulerMulticomponentEquations{2} now is a subtype of AbstractCompressibleEulerMulticomponentEquations{2}. It holds the data (gammas, gas constants, ...) as before. Methods depending on that data are implemented for this type as before.
  • CompressibleMoistEulerEquations2D is introduced as another subtype of CompressibleEulerMulticomponentEquations. Compared to CompressibleEulerMulticomponentEquations the latent head of vaporization is added. Methods needing to account for it are implemented for this type, possibly overriding common methods.

Also a test case is added.

Part of #1778

benegee avatar Jan 25 '24 10:01 benegee

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 :heart: by the Trixi.jl community.

github-actions[bot] avatar Jan 25 '24 10:01 github-actions[bot]

Codecov Report

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

Project coverage is 91.60%. Comparing base (2dfde7f) to head (1e4e76d).

Files Patch % Lines
...ions/compressible_euler_multicomponent_moist_2d.jl 0.00% 195 Missing :warning:
...red_2d_dgsem/elixir_eulermultimoist_warm_bubble.jl 0.00% 165 Missing :warning:
...s/compressible_euler_multicomponent_abstract_2d.jl 79.91% 85 Missing :warning:
.../equations/compressible_euler_multicomponent_2d.jl 45.19% 57 Missing :warning:
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1813      +/-   ##
==========================================
- Coverage   96.30%   91.60%   -4.70%     
==========================================
  Files         439      442       +3     
  Lines       35749    36307     +558     
==========================================
- Hits        34428    33259    -1169     
- Misses       1321     3048    +1727     
Flag Coverage Δ
unittests 91.60% <43.40%> (-4.70%) :arrow_down:

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Jan 25 '24 11:01 codecov[bot]