search

FairRootGroup / FairRoot

C++ simulation, reconstruction and analysis framework for particle physics experiments
http://fairroot.gsi.de
Other
57 stars 96 forks source link

Move FairModule::fAllSensitiveVolumes to FairRunSim #1500

Open ChristianTackeGSI opened 6 months ago

ChristianTackeGSI commented 6 months ago

Instead of using a thread local, let's use something that is tied to the "simulaion session" (as noted in some places).

FairRunSim has all the Modules anyway, so let it also have the list of sensitive Volumes.

OR should we move it to FairMCApplcation instead?

waiting for:

Checklist:

coderabbitai[bot] commented 6 months ago
Walkthrough ## Walkthrough The updates refine how the Fair simulation framework manages sensitive volumes by centralizing relevant functionality within the `FairRunSim` class. This involves using `UpdateSensitiveVolumesForModule` in the `FairDetector` class and modifying iterations over sensitive volumes to utilize this new method. Additionally, the `RegisterSensitiveVolume` function now requires a `FairRunSim` instance, streamlining the association between modules and MC IDs. ## Changes | Files | Change Summary | | ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `fairroot/base/sim/FairDetector.cxx` | `FairDetector::Initialize()` now uses `GetRunSim().UpdateSensitiveVolumesForModule(*this)` to update MC IDs for sensitive volumes. | | `fairroot/base/sim/FairMCApplication.cxx` | Loop iteration over sensitive volumes updated to use `fRun->RangeAllSensitiveVolumes()` instead of `FairModule::fAllSensitiveVolumes`. | | `fairroot/base/sim/FairModule.cxx`, `fairroot/base/sim/FairModule.h` | Removed thread-local vector `fAllSensitiveVolumes`, updated `RegisterSensitiveVolume` to call `fRunSim->RegisterSensitiveVolume(vol)`, and added assertions for `fRunSim`. | | `fairroot/base/steer/FairRunSim.cxx`, `fairroot/base/steer/FairRunSim.h` | Introduced `UpdateSensitiveVolumesForModule`, `RegisterSensitiveVolume`, and `RangeAllSensitiveVolumes` methods, and added `fAllSensitiveVolumes` as a member variable. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant FairDetector participant FairRunSim participant FairMCApplication FairDetector->>FairRunSim: Initialize() FairRunSim->>FairDetector: UpdateSensitiveVolumesForModule(*this) FairMCApplication->>FairRunSim: InitGeometry() FairRunSim->>FairMCApplication: Access RangeAllSensitiveVolumes() ``` This diagram illustrates the interaction between `FairDetector`, `FairRunSim`, and `FairMCApplication` in initializing and updating sensitive volumes.
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 18cf4e38c1ff7774804d491620862420c9e5b1a8 and fcddccbaf8a8dc87f8e0280c445df1be84930af7.
Files selected for processing (3) * fairroot/base/sim/FairDetector.cxx (2 hunks) * fairroot/base/steer/FairRunSim.cxx (2 hunks) * fairroot/base/steer/FairRunSim.h (3 hunks)
Files skipped from review as they are similar to previous changes (2) * fairroot/base/steer/FairRunSim.cxx * fairroot/base/steer/FairRunSim.h
Additional comments not posted (2)
fairroot/base/sim/FairDetector.cxx (2)
`17-17`: **LGTM!** The code change is approved. --- `97-97`: **Excellent refactoring!** The code change simplifies the `Initialize()` method by replacing the loop that iterated over all sensitive volumes with a single call to `GetRunSim().UpdateSensitiveVolumesForModule(*this)`. This change: - Removes the explicit loop and related variable declarations, making the code more concise and readable. - Delegates the responsibility for updating sensitive volumes to the `GetRunSim()` method, which encapsulates the previous functionality in a more streamlined manner. - Enhances the maintainability of the code by promoting a more modular approach.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` or `@coderabbitai title` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
karabowi commented 3 months ago

@ChristianTackeGSI, can you add an entry in the changelog? For some users that change may be worth mentioning. I have tested the PR with PandaRoot.

ChristianTackeGSI commented 3 months ago

@ChristianTackeGSI, can you add an entry in the changelog? For some users that change may be worth mentioning. I have tested the PR with PandaRoot.

fAllSenstiveVolumes was introduced during a rename for 19.0. So the rename was a breaking change. You correctly identified, that we did not document it properly. So let's document it now: #1555

After the docs have been reviewed and merged (and backported to 19.0), I will rebase this one.

ChristianTackeGSI commented 1 week ago

@ChristianTackeGSI, can you add an entry in the changelog? For some users that change may be worth mentioning. I have tested the PR with PandaRoot.

fAllSenstiveVolumes was introduced during a rename for 19.0. So the rename was a breaking change. You correctly identified, that we did not document it properly. So let's document it now: #1555

After the docs have been reviewed and merged (and backported to 19.0), I will rebase this one.