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

Fix the wet/dry test for SWE #1727

Merged

Conversation

patrickersing
Copy link
Contributor

The goal of this PR is to fix the failing tests for the elixir_shallowwater_well_balanced_wet_dry.jl.

This test was observed to fail for CI runs on Intel Xeon Platinum CPUs. The L_inf error in this test seems to be highly sensitive to the specific CPU used in the run. In a sample of CI runs the following errors have been observed:

  • Intel Xeon Platinum: ~8.3339e-14
  • Intel Xeon E: ~1.2044e-13
  • AMD EPYC: ~1.2155e-13

As the differences are negligible and seem to depend only on the specific CPU, this PR adjusts the absolute tolerance of this test from atol=500*eps() to atol=1000*eps() such that the test passes on the Intel Xeon Platinum CPUs.

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.

sloede
sloede previously approved these changes Nov 10, 2023
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.

LGTM!

@sloede
Copy link
Member

sloede commented Nov 10, 2023

@patrickersing format check fails :-)

@patrickersing
Copy link
Contributor Author

@sloede I should probably add this automatic check from the style guide. It seems like the "Apply formatter"-commit is becoming part of my workflow 😄
Thanks for the review!

Copy link
Member

@andrewwinters5000 andrewwinters5000 left a comment

Choose a reason for hiding this comment

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

LGTM!

@sloede sloede closed this Nov 10, 2023
@sloede sloede reopened this Nov 10, 2023
@sloede sloede enabled auto-merge (squash) November 10, 2023 12:01
@ranocha ranocha disabled auto-merge November 10, 2023 14:58
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 cb8181f into trixi-framework:main Nov 10, 2023
34 of 62 checks passed
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.

4 participants