Skip to content

Implement Trixi.Threaded()#3003

Draft
vchuravy wants to merge 2 commits into
mainfrom
vc/threaded
Draft

Implement Trixi.Threaded()#3003
vchuravy wants to merge 2 commits into
mainfrom
vc/threaded

Conversation

@vchuravy
Copy link
Copy Markdown
Member

@vchuravy vchuravy commented May 7, 2026

Implements #2997 (comment)

I am not happy with the name Threaded since it is the one "owned" by FastBroadcast.jl,
but I am also too tired to come up with a better name.

  1. FastBroadcast.Threaded already exists as a type with the same name, so users might conflate the two                                    
  2. The original comment in the PR called the Parallel() name "bad" — Threaded() is arguably worse for the same reason                     
                                                                                                                                            
  Some alternatives to consider:                                                                                                            
                                                                                                                                            
  - thread_preference() — describes what it does (returns the thread kwarg value based on preference)                                       
  - ode_thread_arg() — explicit that it's for ODE solver thread= kwargs                                                                     
  - Trixi.thread() — short, mirrors the kwarg name thread = Trixi.thread()                                                                  
  - preferred_thread() — communicates it reads the preference                                                                               
                                                                                                                                            
  My suggestion would be thread_preference() since it makes it clear the value is derived from Trixi's configured preference. Or simply     
  thread() for terseness, which reads naturally as RDPK3SpFSAL49(thread = Trixi.thread()).

Replaces #2997

JoshuaLampert and others added 2 commits May 7, 2026 22:23
…e-exporting FastBroadcast

Replaces the `const Threaded` alias (which simply forwarded DiffEqBase/FastBroadcast types)
with a Trixi-owned function that reads `_PREFERENCE_THREADING`. When the backend is `:serial`,
`Trixi.Threaded()` now returns the non-threaded value (`Serial()`/`False()`), so users who
have disabled Polyester for Trixi cannot accidentally pass a threading argument that contradicts
their preference.

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 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 7, 2026

Codecov Report

❌ Patch coverage is 25.00000% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.12%. Comparing base (bb36217) to head (0f0c329).

Files with missing lines Patch % Lines
src/Trixi.jl 25.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3003      +/-   ##
==========================================
- Coverage   97.13%   97.12%   -0.01%     
==========================================
  Files         625      625              
  Lines       48514    48518       +4     
==========================================
+ Hits        47122    47123       +1     
- Misses       1392     1395       +3     
Flag Coverage Δ
unittests 97.12% <25.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.

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

Copy link
Copy Markdown
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.

My suggestion would be thread_preference()

Why did you not follow "your" suggestion?

Comment thread src/Trixi.jl
Comment on lines +94 to +106
@static if _PREFERENCE_THREADING === :serial
@static if isdefined(DiffEqBase, :Threaded)
Threaded() = DiffEqBase.Serial()
else
Threaded() = False()
end
else
@static if isdefined(DiffEqBase, :Threaded)
Threaded() = DiffEqBase.Threaded()
else
Threaded() = True()
end
end
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Shouldn't we check whether Trixi.jl threading uses Polyester.jl instead? I would expect to get problem when using Base threads in Trixi.jl and Polyester.jl threads in the time integrator.

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.

3 participants