Skip to content

Replace Trixi.True() by Trixi.Threaded()#2997

Open
JoshuaLampert wants to merge 5 commits into
mainfrom
threaded
Open

Replace Trixi.True() by Trixi.Threaded()#2997
JoshuaLampert wants to merge 5 commits into
mainfrom
threaded

Conversation

@JoshuaLampert
Copy link
Copy Markdown
Member

Split out of #2910.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

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.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.13%. Comparing base (bb36217) to head (af92b27).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2997   +/-   ##
=======================================
  Coverage   97.13%   97.13%           
=======================================
  Files         625      625           
  Lines       48514    48514           
=======================================
  Hits        47122    47122           
  Misses       1392     1392           
Flag Coverage Δ
unittests 97.13% <ø> (ø)

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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

vchuravy
vchuravy previously approved these changes May 5, 2026
Copy link
Copy Markdown
Member

@vchuravy vchuravy left a comment

Choose a reason for hiding this comment

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

Technically a breaking change?

@JoshuaLampert
Copy link
Copy Markdown
Member Author

JoshuaLampert commented May 5, 2026

Technically a breaking change?

Yes, we could also name it True again, but then it would be inconsistent with newer versions of OrdinaryDiffEq.jl. So probably it's better to put into a breaking release.

@ranocha
Copy link
Copy Markdown
Member

ranocha commented May 7, 2026

I think this is not breaking from our side but from OrdinaryDIffEq.jl. Do they export their Threaded type so that we can replace Trixi.Threaded() by something coming from th OrdinaryDiffEq packages? It is not really clean to use something from Trixi.jl for an API created by the DiffEq ecosystem.

@JoshuaLampert
Copy link
Copy Markdown
Member Author

No, it is not exported, but only used from FastBroadcast.jl here.

@vchuravy
Copy link
Copy Markdown
Member

vchuravy commented May 7, 2026

From the weekly meeting:

It would make sense to take ownership of this, instead of punting the problem to FastBroadcast/OrdinaryDiffEq.

As an example, we already have a preference for the threading backend, and it would make sense to have a function Trixi.Parallel() (bad name) that looks at the preference. That way we are not reexporting something from FastBroadcast and avoid the scenario where someone turned off Polyester for Trixi, but is still passing Threaded()

@JoshuaLampert
Copy link
Copy Markdown
Member Author

Ok, could you take over the PR then @vchuravy (sorry I couldn't make it to the meeting today)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants