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

GLM speed calculations for coupled semidiscretizations #1835

Merged
merged 86 commits into from
May 3, 2024

Conversation

SimonCan
Copy link
Contributor

@SimonCan SimonCan commented Feb 6, 2024

The callback that computes the glm speed was only working for single semidiscretizations. With this change we can now use it for coupled semidiscretizations with arbitrarily many GLM-MHD systems and the user can specify which semidiscretization needs to get its glm speed calculated.

Copy link
Contributor

github-actions bot commented Feb 6, 2024

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.

src/callbacks_step/glm_speed.jl Outdated Show resolved Hide resolved
src/callbacks_step/glm_speed.jl Outdated Show resolved Hide resolved
SimonCan and others added 4 commits February 7, 2024 15:11
Just had to make sure it can handle the situation
where there is only one semidiscretization.
Copy link

codecov bot commented Feb 7, 2024

Codecov Report

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

Project coverage is 96.10%. Comparing base (adba1bb) to head (d195d97).

Files Patch % Lines
src/callbacks_step/glm_speed.jl 81.82% 2 Missing ⚠️
...c/semidiscretization/semidiscretization_coupled.jl 90.91% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1835      +/-   ##
==========================================
+ Coverage   96.08%   96.10%   +0.01%     
==========================================
  Files         450      451       +1     
  Lines       36215    36241      +26     
==========================================
+ Hits        34797    34826      +29     
+ Misses       1418     1415       -3     
Flag Coverage Δ
unittests 96.10% <89.19%> (+0.01%) ⬆️

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.

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.

Why is another version of the flux_nonconservative_powell needed for the coupling procedure?

src/callbacks_step/glm_speed.jl Outdated Show resolved Hide resolved
src/callbacks_step/glm_speed.jl Outdated Show resolved Hide resolved
src/semidiscretization/semidiscretization_coupled.jl Outdated Show resolved Hide resolved
src/equations/ideal_glm_mhd_2d.jl Outdated Show resolved Hide resolved
src/equations/ideal_glm_mhd_2d.jl Outdated Show resolved Hide resolved
examples/structured_2d_dgsem/elixir_mhd_coupled.jl Outdated Show resolved Hide resolved
examples/structured_2d_dgsem/elixir_mhd_coupled.jl Outdated Show resolved Hide resolved
@SimonCan SimonCan requested a review from sloede April 24, 2024 17:08
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

Thanks, this looks almost ready. I noticed a few small things, but afterwards this is good to go IMHO

examples/structured_2d_dgsem/elixir_mhd_coupled.jl Outdated Show resolved Hide resolved
src/callbacks_step/glm_speed.jl Outdated Show resolved Hide resolved
src/callbacks_step/glm_speed.jl Outdated Show resolved Hide resolved
src/callbacks_step/glm_speed.jl Outdated Show resolved Hide resolved
src/callbacks_step/glm_speed.jl Outdated Show resolved Hide resolved
src/callbacks_step/glm_speed.jl Outdated Show resolved Hide resolved
src/callbacks_step/glm_speed.jl Outdated Show resolved Hide resolved
src/callbacks_step/glm_speed.jl Outdated Show resolved Hide resolved
src/callbacks_step/glm_speed.jl Show resolved Hide resolved
src/callbacks_step/glm_speed.jl Outdated Show resolved Hide resolved
@SimonCan SimonCan requested a review from sloede May 2, 2024 11:36
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

Final note, then ready to merge 🙂

src/callbacks_step/glm_speed.jl Outdated Show resolved Hide resolved
Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

LGTM, thank you for bearing with me!

@sloede sloede enabled auto-merge (squash) May 3, 2024 10:33
@sloede sloede merged commit cd097fc into main May 3, 2024
37 of 38 checks passed
@sloede sloede deleted the sc/glm_speed_coupled_semis branch May 3, 2024 12:10
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.

5 participants