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

Time integrator in the paired explicit Runge Kutta scheme: Perk p3 single ext #35

Closed
wants to merge 96 commits into from

Conversation

warisa-r
Copy link

@warisa-r warisa-r commented Jun 6, 2024

Here is the minimal implementation and some tests added in regard to PERK3

  • NLsolve has now been added as a weak dependency

TODO:

  • Clean up and recheck #1908 so that mistakes in PERK2 are not repeated
  • Try the linear case: It does work
  • Try the values in matlab script
  • Update the tests: test_uni.jl
  • test in structured_1d_dgsem

Copy link

github-actions bot commented Jun 6, 2024

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.

Copy link
Owner

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

Great work! I added mostly descriptive comments.

ext/TrixiNLsolveExt.jl Outdated Show resolved Hide resolved
ext/TrixiNLsolveExt.jl Outdated Show resolved Hide resolved
ext/TrixiNLsolveExt.jl Outdated Show resolved Hide resolved
ext/TrixiNLsolveExt.jl Outdated Show resolved Hide resolved
ext/TrixiNLsolveExt.jl Outdated Show resolved Hide resolved
@warisa-r
Copy link
Author

warisa-r commented Jun 6, 2024

I'm taking "Make fixed time step and SaveSolutionCallback as per #1958" off the TODO list since:

The reason being, this alteration is directly tied to that pull request. In particular, many abstract objects are defined in methods_PERK2.jl, and they undergo modifications in #1958 By waiting until the said PR is merged, IMHO would minimize any potential conflicts or inconsistencies.

However, if you'd like me to do it anyway, I can assume that it will be merged and make changes to methods_PERK2.jl so that things can be implemented in methods_PERK3.jl so that SaveSolutionCallback works without StepSizeCallback in PERK3.

@warisa-r
Copy link
Author

warisa-r commented Jul 8, 2024

I'm sorry, but I'm unsure if I understand what you say here. Are you suggesting I wait until #1967 is done then come back to this issue later?

@DanielDoehring
Copy link
Owner

I'm sorry, but I'm unsure if I understand what you say here. Are you suggesting I wait until #1967 is done then come back to this issue later?

Oh no sorry, I clicked the wrong tab in my browser.
I meant (trixi-framework#1958) which is now merged, so you can proceed bringing in the functionality also here :)

Copy link
Owner

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

Okay, final request for changes (I hope)! If you have addressed them we can close this here and you can open up the proper PR to the main repository :)

NEWS.md Outdated Show resolved Hide resolved
ext/TrixiNLsolveExt.jl Outdated Show resolved Hide resolved
ext/TrixiNLsolveExt.jl Outdated Show resolved Hide resolved
ext/TrixiNLsolveExt.jl Outdated Show resolved Hide resolved
@warisa-r
Copy link
Author

warisa-r commented Jul 9, 2024

In order to make save_solution work like the second-order integrator, some functions in methods_PERK2.jl needed to be modified. I'll do this in the draft PR I will open in the main branch. Thank you for the feedback! Good luck with JuliaCon :D @DanielDoehring

@warisa-r warisa-r closed this Jul 10, 2024
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