Skip to content

Conversation

@fderuiter
Copy link
Owner

⚙️ Core: Refactor Dose Calculation Strategy

🔧 The Violation:
The dose_calculation.rs module relied on "Primitive Obsession" (passing raw f64s) and violated the Open/Closed Principle (adding a new kernel would require modifying existing code). It also used stringly-typed errors.

🛠️ The Fix:
Applied the Strategy Pattern and Parameter Object Pattern.

  1. Parameter Objects: TermaInput and KernelInput encapsulate arguments and enforce invariants (e.g., non-negative fluence) at construction time ("Parse, don't validate").
  2. Strategies: TermaModel and DoseKernel traits allow users to inject custom physics models without touching the core logic.
  3. Error Hierarchy: Introduced DoseError to replace String errors.

📉 Debt Reduction:

  • Centralized validation logic (DRY).
  • Eliminated magic behavior (returning 0.0 silently on error) in the new API (legacy wrappers preserve it for compatibility).

🧪 Integrity:

  • Logic preserved bit-identically.
  • Existing tests passed.
  • New tests added for validation and strategies.

PR created automatically by Jules for task 2593254931381143047 started by @fderuiter

- Defined `DoseError` enum for typed error handling.
- Introduced `TermaInput` and `KernelInput` parameter objects with strict validation.
- Extracted `TermaModel` and `DoseKernel` traits to decouple algorithms.
- Implemented `ExponentialTerma` and `PointSpreadKernel` strategies.
- Deprecated legacy functions `calculate_terma` and `point_kernel`, delegating to new strategies.
- Added comprehensive unit tests for validation and strategy logic.

This refactor addresses Primitive Obsession and improves Composability/OCP.

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
@google-labs-jules
Copy link
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

Ran `cargo fmt` to address CI failure.

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
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.

2 participants