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

Add tutorial for subcell IDP limiting #1882

Merged
merged 24 commits into from
May 7, 2024

Conversation

bennibolm
Copy link
Contributor

@bennibolm bennibolm commented Mar 20, 2024

Adding a tutorial for the use of subcell limiting implementation in Trixi.jl.
Closes #1823.

TODOs:

Used figures:
Paraview_DropdownMenu
blast_wave_paraview
blast_wave_paraview_reinterpolate=false

@bennibolm bennibolm added the documentation Improvements or additions to documentation label Mar 20, 2024
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
Contributor

@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 good!
Here a bunch of changes, mainly aiming for a more understandable description of the methods.

docs/literate/src/files/hohqmesh_tutorial.jl Show resolved Hide resolved
docs/literate/src/files/index.jl Outdated Show resolved Hide resolved
docs/literate/src/files/subcell_shock_capturing.jl Outdated Show resolved Hide resolved
docs/literate/src/files/subcell_shock_capturing.jl Outdated Show resolved Hide resolved
docs/literate/src/files/subcell_shock_capturing.jl Outdated Show resolved Hide resolved
docs/literate/src/files/subcell_shock_capturing.jl Outdated Show resolved Hide resolved
docs/literate/src/files/subcell_shock_capturing.jl Outdated Show resolved Hide resolved
docs/literate/src/files/subcell_shock_capturing.jl Outdated Show resolved Hide resolved
docs/literate/src/files/subcell_shock_capturing.jl Outdated Show resolved Hide resolved
docs/literate/src/files/subcell_shock_capturing.jl Outdated Show resolved Hide resolved
@bennibolm
Copy link
Contributor Author

Thanks @amrueda.
I will not answer every suggestion with "Done in 7cb739b" to not send you about 1000 emails, but I will just resolve the solved suggestions.

I will work on the open issues in the next days or weeks.

@bennibolm bennibolm requested a review from amrueda April 29, 2024 10:18
@bennibolm
Copy link
Contributor Author

@amrueda Do you want to have a last quick look? Otherwise, I would mark the PR as "Ready for review" and ping some other guys.

amrueda
amrueda previously approved these changes May 6, 2024
Copy link
Contributor

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

I'm fine with it, you can ping the others 🙂

@bennibolm bennibolm marked this pull request as ready for review May 6, 2024 09:55
Copy link
Contributor

@DanielDoehring DanielDoehring left a comment

Choose a reason for hiding this comment

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

Thanks a lot for the time you out into this!
I have some minor proposed changes.

docs/literate/src/files/index.jl Show resolved Hide resolved
docs/literate/src/files/subcell_shock_capturing.jl Outdated Show resolved Hide resolved
docs/literate/src/files/subcell_shock_capturing.jl Outdated Show resolved Hide resolved
docs/literate/src/files/subcell_shock_capturing.jl Outdated Show resolved Hide resolved
@bennibolm bennibolm requested a review from sloede May 7, 2024 12:33
@bennibolm bennibolm changed the title WIP: Add tutorial for subcell IDP limiting Add tutorial for subcell IDP limiting May 7, 2024
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.

I haven't checked the tutorial content itself, assuming that @amrueda and/or @DanielDoehring already did that. The rest LGTM!

@sloede sloede merged commit 9ac9b3e into trixi-framework:main May 7, 2024
6 checks passed
@bennibolm bennibolm deleted the subcell-limiting-add-tutorial branch May 7, 2024 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for IDP Limiter
4 participants