Skip to content

Fix physics Force relation#90

Merged
leynos merged 1 commit intomainfrom
codex/fix-body-stream-rule-validation-error
Jun 22, 2025
Merged

Fix physics Force relation#90
leynos merged 1 commit intomainfrom
codex/fix-body-stream-rule-validation-error

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 22, 2025

Summary

  • define Force as an input relation instead of a stream in physics.dl
  • document per-tick Force usage in physics design docs and BDD guide

Testing

  • make fmt
  • make markdownlint
  • make lint
  • make test

https://chatgpt.com/codex/tasks/task_e_6857e13457508322a1be6f184c10029d

Summary by Sourcery

Fix the Force relation definition in the physics datalog rules to be an input relation overwritten each tick and update corresponding documentation.

Bug Fixes:

  • Treat Force as a per-tick input relation instead of a stream in physics.dl

Documentation:

  • Update physics design and BDD documentation to describe the new per-frame Force relation behavior

Summary by CodeRabbit

  • Documentation
    • Updated documentation to clarify that force inputs are now provided as per-tick relations, overwritten each frame, rather than as input streams.
  • Refactor
    • Modified the way force data is ingested, changing from a streaming input to a per-tick relation for improved clarity and consistency.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 22, 2025

Reviewer's Guide

This PR redefines the Force predicate from an ephemeral input stream to an explicit per-tick input relation in the DDlog schema and updates the BDD and physics design documentation to clarify that the host engine overwrites force inputs each frame.

Class diagram for Force as per-tick input relation

classDiagram
    class Force {
        +EntityID entity
        +GCoord fx
        +GCoord fy
        +GCoord fz
        <<input relation>>
    }
    class Velocity {
        +EntityID entity
        +GCoord vx
        +GCoord vy
        +GCoord vz
        <<input relation>>
    }
    class Mass {
        +EntityID entity
        +GCoord kg
        <<input relation>>
    }
    Force --|> Velocity : affects
    Force --|> Mass : uses
Loading

Class diagram showing change from input stream to input relation for Force

classDiagram
    class Force {
        +EntityID entity
        +GCoord fx
        +GCoord fy
        +GCoord fz
    }
    note for Force "Changed from input stream to input relation (per-tick, overwritten each frame)"
Loading

File-Level Changes

Change Details Files
Redefine Force as an input relation in the DDlog schema
  • Replace ‘input stream Force’ with ‘input relation Force’ declaration
  • Update accompanying comments to reflect relation semantics
src/ddlog/physics.dl
Revise physics documentation for per-tick Force usage
  • Change section headers to ‘New Per-Tick Input Relation’
  • Add note that the host engine overwrites the Force relation each frame
  • Clarify force inputs vs. direct accelerations in descriptions
docs/bdd-strategies-for-differential-datalog-rulesets.md
docs/lille-physics-engine-design.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 22, 2025

Walkthrough

The Force input in the physics model has been changed from an input stream to a per-tick input relation across documentation and source files. Comments are updated to clarify that Force is overwritten each frame and represents instantaneous forces applied for a single tick, with no changes to its semantic meaning.

Changes

File(s) Change Summary
docs/bdd-strategies-for-differential-datalog-rulesets.md Updated Force from input stream to input relation; revised comments to clarify per-tick overwriting semantics.
docs/lille-physics-engine-design.md Changed Force from ephemeral stream to per-tick relation; updated commentary for per-frame overwrite behaviour.
src/ddlog/physics.dl Modified Force declaration to input relation; added comment on per-tick replacement by host application.

Sequence Diagram(s)

sequenceDiagram
    participant HostEngine
    participant DDlogPhysics

    loop Each Frame (Tick)
        HostEngine->>DDlogPhysics: Overwrite Force relation with current tick's forces
        DDlogPhysics->>DDlogPhysics: Compute acceleration from Force and Mass
        DDlogPhysics->>HostEngine: Output updated entity states
    end
Loading

Suggested reviewers

  • codescene-delta-analysis

Poem

A tick, a hop, a force anew,
Each frame refreshed, as rabbits do.
No streams that trickle, just a leap,
Relations strong, not buried deep.
A gentle nudge, a timely push—
Physics in code, in one swift whoosh!
🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7b6b38a and fd5db2b.

📒 Files selected for processing (3)
  • docs/bdd-strategies-for-differential-datalog-rulesets.md (1 hunks)
  • docs/lille-physics-engine-design.md (1 hunks)
  • src/ddlog/physics.dl (1 hunks)
🔇 Additional comments (3)
src/ddlog/physics.dl (1)

7-9: LGTM! Clear documentation of the semantic change.

The change from input stream to input relation is well-documented with a clear explanation that the host application should replace this relation each frame. This properly communicates the shift from ephemeral streaming data to per-tick overwritten data.

docs/lille-physics-engine-design.md (1)

173-177: Excellent documentation consistency.

The documentation properly reflects the code changes, clearly explaining the shift from ephemeral streaming to per-tick relation overwriting. The clarification that these are force inputs (not direct accelerations) maintains semantic accuracy.

docs/bdd-strategies-for-differential-datalog-rulesets.md (1)

168-172: Well-coordinated documentation update.

The documentation changes are perfectly consistent with both the code changes and the other documentation files, ensuring a coherent understanding of the Force relation's new semantics across the entire codebase.

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch codex/fix-body-stream-rule-validation-error

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this 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 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.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @leynos - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@leynos leynos merged commit b25e003 into main Jun 22, 2025
4 checks passed
@leynos leynos deleted the codex/fix-body-stream-rule-validation-error branch June 22, 2025 11:22
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.

1 participant