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

Revise bounds check for MCL #118

Merged
merged 14 commits into from
Nov 6, 2023

Conversation

bennibolm
Copy link
Owner

As for the IDP limiting, the bounds check now also exports the maximum deviation since the last export.

@github-actions
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.

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.

In general looks good to me. A couple of minor comments below.

src/solvers/dgsem_tree/subcell_limiters_2d.jl Outdated Show resolved Hide resolved
src/solvers/dgsem_tree/subcell_limiters_2d.jl Outdated Show resolved Hide resolved
test/test_tree_2d_euler.jl Outdated Show resolved Hide resolved
bennibolm and others added 7 commits October 27, 2023 14:40
* Fix allocs

* remove unnecessary code

* rerun fmt

* format
* HLLE CEE 2D3D NonCartesian Meshes

* format

* hlle via hll

* format test

* format test

* format

* do not export hlle

* Correct test vals

* test values CI

* Update src/equations/compressible_euler_2d.jl

Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>

* Update src/equations/compressible_euler_1d.jl

Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>

* Update src/equations/compressible_euler_2d.jl

Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>

* Update src/equations/compressible_euler_3d.jl

Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>

* Update src/equations/compressible_euler_3d.jl

Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>

* apply suggestions

* additional sentence

* Fix typo

* typos

* correct test vals

---------

Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>
Bumps [crate-ci/typos](https://github.com/crate-ci/typos) from 1.16.15 to 1.16.21.
- [Release notes](https://github.com/crate-ci/typos/releases)
- [Changelog](https://github.com/crate-ci/typos/blob/master/CHANGELOG.md)
- [Commits](crate-ci/typos@v1.16.15...v1.16.21)

---
updated-dependencies:
- dependency-name: crate-ci/typos
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
sloede and others added 5 commits November 3, 2023 10:45
* Add NumFOCUS + ACTRIX to acknowledgments

* Try to avoid spaces

* Another try to avoid gaps between images

* Hopefully fix image alignment in docs

* Try new logo formats

* Use smaller DUBS logo and add DUBS funding statement

* Add markdown-based table for logos in docs

* Try another table approach

* Hopefully get a layout that finally *works*...

* Arrrrrrgggggghhhhh
* format examples

* check formatting of examples in CI

* update style guide

* fix weird formatting

* fix formatting of binary operators

* format again
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 to me!
Just a minor comment:

src/callbacks_stage/subcell_bounds_check.jl Show resolved Hide resolved
@bennibolm bennibolm merged commit cb899fe into subcell-limiting Nov 6, 2023
@bennibolm bennibolm deleted the subcell-limiting-boundscheck-MCL branch November 6, 2023 11:25
@bennibolm bennibolm restored the subcell-limiting-boundscheck-MCL branch November 6, 2023 11:27
bennibolm added a commit that referenced this pull request Nov 6, 2023
@bennibolm bennibolm deleted the subcell-limiting-boundscheck-MCL branch November 6, 2023 11:28
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.

6 participants