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

Refactor time integrator 2N and 3Star more similar to OrdinaryDiffEq.jl integrators #1975

Merged
merged 11 commits into from
Jun 19, 2024

Conversation

warisa-r
Copy link
Contributor

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

Closes #1886 by @DanielDoehring , this PR makes changes to the integrator in method2N.jl and methods_3Sstar.jl.

Please let me know if there is something wrong or any changes have to be made!

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

@warisa-r warisa-r marked this pull request as ready for review June 11, 2024 12:29
@DanielDoehring DanielDoehring self-assigned this Jun 11, 2024
@DanielDoehring DanielDoehring self-requested a review June 11, 2024 12:50
@DanielDoehring DanielDoehring added the refactoring Refactoring code without functional changes label Jun 11, 2024
DanielDoehring
DanielDoehring previously approved these changes Jun 11, 2024
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.

Thanks. Please find some comments below. Additionally, it would be nice to test the new functionality for the use case motivating this change.

src/time_integration/methods_2N.jl Outdated Show resolved Hide resolved
src/time_integration/methods_2N.jl Show resolved Hide resolved
src/time_integration/methods_3Sstar.jl Show resolved Hide resolved
Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>
Copy link

codecov bot commented Jun 14, 2024

Codecov Report

Attention: Patch coverage is 95.00000% with 4 lines in your changes missing coverage. Please review.

Project coverage is 96.16%. Comparing base (75d8c67) to head (a169e57).

Files Patch % Lines
src/time_integration/methods_2N.jl 94.74% 2 Missing ⚠️
src/time_integration/methods_3Sstar.jl 95.24% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1975   +/-   ##
=======================================
  Coverage   96.16%   96.16%           
=======================================
  Files         460      460           
  Lines       36957    36971   +14     
=======================================
+ Hits        35537    35551   +14     
  Misses       1420     1420           
Flag Coverage Δ
unittests 96.16% <95.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.

ranocha
ranocha previously approved these changes Jun 18, 2024
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.

Thanks!

src/time_integration/methods_2N.jl Outdated Show resolved Hide resolved
src/time_integration/methods_2N.jl Outdated Show resolved Hide resolved
src/time_integration/methods_3Sstar.jl Outdated Show resolved Hide resolved
src/time_integration/methods_3Sstar.jl Outdated Show resolved Hide resolved
Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>
@ranocha
Copy link
Member

ranocha commented Jun 18, 2024

Could you please run the formatter?

docs/literate/make.jl Outdated Show resolved Hide resolved
@ranocha
Copy link
Member

ranocha commented Jun 18, 2024

Could you please add your name to our list of authors?

https://github.com/trixi-framework/Trixi.jl/blob/main/AUTHORS.md

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 for doing this!

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.

Thanks!

@ranocha ranocha merged commit 5a642f2 into trixi-framework:main Jun 19, 2024
36 of 37 checks passed
@warisa-r warisa-r deleted the refactor_time_integration branch June 19, 2024 07:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Refactoring code without functional changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make custom integrators more similar to OrdinaryDiffEq.jl integrators?
3 participants