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

Speed up bar states bounds calculation of entropies #120

Merged
merged 3 commits into from
Nov 23, 2023

Conversation

bennibolm
Copy link
Owner

This PR speeds up the calculation of bounds for mathematical and specific entropy.
Before, we looped through every node, look at the bar states on the right, top, left, bottom and calculated the entropy every time. This resulted in doubled entropy calculation.

Now, we just look at the bar states on the left and bottom, calculate the entropy and save it for the node itself and the respective neighbor. In the end, we add the calculation at the interface/boundary far right and top.

The new implementation only takes about 70% of the time the old one took.
Before:
calc_variable_bounds! 4.34k 992ms 20.4% 229μs 577KiB 19.9% 136B
Now:
calc_variable_bounds! 4.34k 704ms 15.5% 162μs 577KiB 19.9% 136B

This is not necessary for the calculation of the bounds for the local limiting, since there we can directly use the bar states without further calculations.

Copy link

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.

@bennibolm
Copy link
Owner Author

I think this PR is directly mergeable. Of course, I checked that we get the same results as before and (hopefully) all tests pass.
Could you take a quick look anyway?@amrueda

@bennibolm bennibolm requested a review from amrueda November 20, 2023 16:20
Copy link
Collaborator

@amrueda amrueda left a comment

Choose a reason for hiding this comment

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

Looks great. Just one comment:

src/solvers/dgsem_tree/dg_2d_subcell_limiters.jl Outdated Show resolved Hide resolved
@bennibolm bennibolm merged commit 73e26c4 into subcell-limiting Nov 23, 2023
29 of 30 checks passed
@bennibolm bennibolm deleted the revise-entropy-bounds-calc-barstates branch November 23, 2023 10:16
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.

2 participants