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

Remove interfaces and boundaries from cache_parabolic #1754

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

jlchan
Copy link
Contributor

@jlchan jlchan commented Nov 22, 2023

Addresses step 3 of #1674

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.

Copy link

codecov bot commented Nov 22, 2023

Codecov Report

Attention: 24 lines in your changes are missing coverage. Please review.

Comparison is base (ad384c6) 96.27% compared to head (d93198d) 86.60%.

Files Patch % Lines
src/solvers/dgsem_tree/dg_1d_parabolic.jl 0.00% 20 Missing ⚠️
src/callbacks_step/amr_dg1d.jl 0.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1754      +/-   ##
==========================================
- Coverage   96.27%   86.60%   -9.67%     
==========================================
  Files         438      438              
  Lines       35623    35609      -14     
==========================================
- Hits        34294    30836    -3458     
- Misses       1329     4773    +3444     
Flag Coverage Δ
unittests 86.60% <45.45%> (-9.67%) ⬇️

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 self-assigned this Nov 23, 2023
@DanielDoehring
Copy link
Contributor

@jlchan thanks for starting working on this! Sorry for not helping out on this, I thought (based on a comment during one of the Trixi meetings) that merging the 3D functionality would come first prior to addressing possible optimizations.

Anyways, feel free to ask for a review once you are done with the optimizations.

@jlchan
Copy link
Contributor Author

jlchan commented Nov 26, 2023

Good point @DanielDoehring. We can merge 3D first and simply use this as a CI testing PR until then.

@DanielDoehring
Copy link
Contributor

Having merged #1765 we can now turn our attention on this.

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

Successfully merging this pull request may close these issues.

2 participants