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: Use forced approach for MultiStepperSurfaceReached #4025

Merged
merged 3 commits into from
Jan 14, 2025

Conversation

andiwand
Copy link
Contributor

@andiwand andiwand commented Jan 13, 2025

Currently we respect the overstepping tolerance in the MultiStepperSurfaceReached aborter. This can lead to problems with overstepping in situations with high curvature or surfaces that bent like cylinders and perigees. To fix this we can use directly ForcedSurfaceReached as a base which will always target the requested surface without checking the overstep tolerance.

This can cause problems with cylinders but we usually do not target them with the GSF or one of the solutions should be strictly closer which suppresses the problem.

Discovered and pulled out of #3449

Summary by CodeRabbit

  • Refactor
    • Updated inheritance for MultiStepperSurfaceReached struct
    • Simplified constructor initialization for the struct

@andiwand andiwand requested a review from benjaminhuth January 13, 2025 10:25
Copy link

coderabbitai bot commented Jan 13, 2025

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

💤 Files selected but had no reviewable changes (1)
  • CI/physmon/reference/trackfitting_gsf/performance_trackfitting.root

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

In the realm of Acts Core, a subtle transformation has occurred within the MultiStepperSurfaceReached struct. The inheritance pattern has shifted from SurfaceReached to ForcedSurfaceReached, signaling a nuanced change in how surface reaching abort conditions are processed. The constructor has been streamlined, removing the explicit initialization parameter, which suggests a more direct approach to surface interaction logic.

Changes

File Change Summary
Core/include/Acts/Propagator/MultiStepperAborters.hpp - Inheritance changed from SurfaceReached to ForcedSurfaceReached
- Removed explicit constructor with oLimit parameter

Suggested labels

Component - Core, Track Finding

Suggested reviewers

  • benjaminhuth
  • paulgessinger

Possibly related PRs

Poem

Surfaces reached, a Jedi's path,
Code flows like the Force, swift and light,
Inheritance shifts, a subtle craft,
In Acts' core, algorithms take flight! 🚀
Wisdom in lines, changes take hold 🧘‍♂️

Hmm, refactoring, the way of the code is.


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the Component - Core Affects the Core module label Jan 13, 2025
@github-actions github-actions bot added this to the next milestone Jan 13, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
Core/include/Acts/Propagator/MultiStepperAborters.hpp (1)

16-16: Wise choice, the inheritance change is, hmm.

From SurfaceReached to ForcedSurfaceReached, the path now leads. Align with the PR objectives, this change does, addressing the challenges of high curvature surfaces, it does.

Consider documenting in comments, you should, why this approach better serves the curved surfaces than the previous one, yes.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bc035b1 and a81c0d6.

📒 Files selected for processing (1)
  • Core/include/Acts/Propagator/MultiStepperAborters.hpp (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: merge-sentinel
  • GitHub Check: unused_files
  • GitHub Check: missing_includes
  • GitHub Check: macos
  • GitHub Check: linux_ubuntu_extra (ubuntu2204_clang, 20)
  • GitHub Check: linux_ubuntu_extra (ubuntu2204, 20)
  • GitHub Check: linux_ubuntu
  • GitHub Check: docs
  • GitHub Check: build_debug
🔇 Additional comments (2)
Core/include/Acts/Propagator/MultiStepperAborters.hpp (2)

Line range hint 16-99: Test coverage for cylindrical surfaces, ensure we must.

Given the changes to surface reaching behavior, comprehensive tests for cylindrical surfaces, essential they are. Particularly important for high curvature scenarios, this is.

Help you create additional test cases, I can, if needed they are.


84-85: Consistent with base class change, this modification is.

Changed from SurfaceReached::checkAbort to ForcedSurfaceReached::checkAbort, the implementation has. But verify the impact on cylindrical surfaces, we must.

Run this script to find usage patterns, we shall:

✅ Verification successful

Safe for cylindrical surfaces, this change is. Hmmmm.

The change from SurfaceReached to ForcedSurfaceReached affects only the distance limit for checking intersections, it does. Surface-type specific behavior, it does not modify. Work with all surface types including cylindrical ones, the underlying intersection logic does.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for cylindrical surface usage with MultiStepperSurfaceReached
rg -l "CylinderSurface|CylinderBounds" | xargs rg "MultiStepperSurfaceReached"

# Look for existing test cases with cylindrical surfaces
ast-grep --pattern 'TEST_CASE($$$CylinderSurface$$$)'

Length of output: 134


Script:

#!/bin/bash
# Compare implementations of surface reached conditions
ast-grep --pattern 'class SurfaceReached {
  $$$
  static bool checkAbort($$$) {
    $$$
  }
  $$$
}'

ast-grep --pattern 'class ForcedSurfaceReached {
  $$$
  static bool checkAbort($$$) {
    $$$
  }
  $$$
}'

# Find surface navigation tests
rg -A 5 "TEST_CASE.*[Ss]urface.*[Nn]avigation"

# Look for cylindrical surface usage in navigation context
rg -A 3 "CylinderSurface.*navigator|navigator.*CylinderSurface"

Length of output: 328


Script:

#!/bin/bash
# Find files containing surface abort conditions
fd . -e hpp -e cpp | xargs rg -l "SurfaceReached|ForcedSurfaceReached"

# Look for surface navigation in propagator
fd . -g "*Propagator*.hpp" -g "*Propagator*.cpp" | xargs rg -l "Surface"

# Find surface-related test files
fd Tests -e cpp | xargs rg -l "TEST_CASE.*Surface"

# Get content of specific files if found
cat Core/include/Acts/Propagator/StandardAborters.hpp

Length of output: 61669

paulgessinger
paulgessinger previously approved these changes Jan 13, 2025
Copy link

github-actions bot commented Jan 13, 2025

📊: Physics performance monitoring for e3643c9

Full contents

physmon summary

@paulgessinger
Copy link
Member

Physmon changes but changes look fine to me.

@kodiakhq kodiakhq bot merged commit 7806575 into acts-project:main Jan 14, 2025
42 checks passed
@andiwand andiwand deleted the multi-surface-reached-forced branch January 14, 2025 10:08
kodiakhq bot pushed a commit that referenced this pull request Jan 15, 2025
…perSurfaceReached` (#4027)

After facing another problem with the GSF in #3449 this might resolve it. The problem seems to be that the navigator and the surface reached aborter are fighting over the surface reached status which can lead to removing all components if the target surface is not reached and the maximum step trials for the multi stepper are reached.

This might introduce other problems so waiting for physmon report.

blocked by
- #4025

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->

## Summary by CodeRabbit

- **Refactor**
	- Updated inheritance for `MultiStepperSurfaceReached` struct to use `ForcedSurfaceReached` as base class
	- Removed explicit constructor for `MultiStepperSurfaceReached`
	- Modified `checkAbort` method to use new base class implementation

- **Chores**
	- Improved component handling and logging in `MultiEigenStepperLoop` class
	- Enhanced state management for components during stepping process

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
@paulgessinger paulgessinger modified the milestones: next, v39.0.0 Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changes Performance Component - Core Affects the Core module Infrastructure Changes to build tools, continous integration, ...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants