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

resize! only when needed EulerGravity #2224

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

DanielDoehring
Copy link
Contributor

No description provided.

Copy link
Contributor

github-actions bot commented Jan 6, 2025

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 with its PR number.

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.

@DanielDoehring DanielDoehring added performance We are greedy refactoring Refactoring code without functional changes labels Jan 6, 2025
Copy link

codecov bot commented Jan 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.42%. Comparing base (a1be62b) to head (14a3365).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2224   +/-   ##
=======================================
  Coverage   96.42%   96.42%           
=======================================
  Files         486      486           
  Lines       39164    39167    +3     
=======================================
+ Hits        37761    37764    +3     
  Misses       1403     1403           
Flag Coverage Δ
unittests 96.42% <100.00%> (+<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.

@DanielDoehring DanielDoehring requested a review from sloede January 7, 2025 16:34
Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

What is the performance impact of this?

@DanielDoehring
Copy link
Contributor Author

Hm I guess you only save a couple if-clauses, true. Is more of a semantic change.

@ranocha
Copy link
Member

ranocha commented Jan 9, 2025

In that case, it would be consistent with the other code to use resize! right before the stuff is used, e.g.,

See also #215

@DanielDoehring
Copy link
Contributor Author

In that case, it would be consistent with the other code to use resize! right before the stuff is used, e.g.,

* https://github.com/trixi-framework/Trixi.jl/blob/62e3584e52da37dbdcdedb5d5737c2ff1e1c4b2d/src/solvers/dgmulti/shock_capturing.jl#L60

* https://github.com/trixi-framework/Trixi.jl/blob/62e3584e52da37dbdcdedb5d5737c2ff1e1c4b2d/src/solvers/dgsem_tree/indicators_2d.jl#L158

See also #215

Hm I am not sure if these should be compared, as there is no resize! for the indicators where this would be naturally placed. I have done this more or less consistent with the other integrators who only resize when necessary.

@ranocha
Copy link
Member

ranocha commented Jan 9, 2025

It's fine for me to merge this if @sloede agrees

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
performance We are greedy refactoring Refactoring code without functional changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants