Skip to content

feat(PhyslibAlpha/EM): Kirchhoff Current Law - #1706

Merged
jstoobysmith merged 4 commits into
leanprover-community:masterfrom
jstoobysmith:KLV
Oct 2, 2026
Merged

jstoobysmith merged 4 commits into
leanprover-community:masterfrom
jstoobysmith:KLV

Conversation

@jstoobysmith

Copy link
Copy Markdown
Member

Kirchhoff's current law for the functional and distributional cases. Made with Claude Code Opus 5.5.

@jstoobysmith jstoobysmith added the PhyslibAlpha Pull requests which are for modifications to PhyslibAlpha. label Oct 1, 2026
@github-actions github-actions Bot added the large label Oct 1, 2026
@jstoobysmith
jstoobysmith requested a review from zhikaip October 1, 2026 07:22
@github-actions

github-actions Bot commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

Thank you for this pull-request (PR). If this is your first PR, welcome to the community!

Below is what will happen next. Please read carefully if you are not familiar with the process. You may open other PRs while this one is being reviewed, and can stack PRs on top of each other, so don't let these steps slow you down.

  1. Some automated checks will be run on your PR. You can see the results of these checks at the buttom of your PR page. If any of these checks fail, you will need to fix the issues before your PR can be merged. You can learn more about these here, including how to run them locally, which is sometimes quicker than relying on the GitHub Actions. If you have never had a PR merged before, you may have to wait for a reviewer to manually start these checks (this is for security).

  2. A reviewer will look at your PR and may ask you to make changes. This may happen a couple of days after you submit your PR, so you may need to be patient. But it should not be longer than that - if it is please bring it to the attention of the community on the Zulip. The level of review will depend on where your PR is submitted. If it is submitted to ./Physlib or ./QuantumInfo, the review will be more thorough than if it is submitted to ./PhyslibAlpha. You can find out more about what the review process is looking for in our review guidelines. If a reviewer adds an awaiting-author label to your PR, address the review comments, then please remove that label by adding a comment with -awaiting-author. This helps us keep track of reviews.

  3. The reviewer will either approve your PR, or request more changes (in which case we return to step 2). Once your PR is approved, it will be merged by a maintainer, this should happen shortly after approval, though you may get more comments at this stage.

Tip: The easiest way to get have a fast review is to submit a PR that is small and self-contained, and has clear documentation explaining why things are the way they are in your chages.

If you have any problems or questions, please reach out to the community on the Zulip.

@github-actions github-actions Bot added the t-electromagnetism Electromagnetism label Oct 1, 2026

@morrison-daniel morrison-daniel left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good

@morrison-daniel morrison-daniel added the ready-to-merge This PR is approved and will be merged shortly label Oct 1, 2026
@zhikaip

zhikaip commented Oct 1, 2026

Copy link
Copy Markdown
Collaborator

I have reservations about calling these results Kirchhoff's current law. To me KCL is a statement about branch currents at the nodes of a lumped-element circuit, while the box result is just integral charge conservation. The wire-junction result is closer, but covers a single node with steady currents, so it is a special case rather than KCL itself.

For PhyslibAlpha I'm fine with the implementation as a toy example, but I'd recommend renaming so the names don't suggest more than is proved, e.g. boxOutwardCurrent_eq_zero_of_steady and IsWireJunction.sum_currents_eq_zero, with the file names and module docstrings adjusted to match. The docstrings could mention KCL as motivation.

@jstoobysmith

Copy link
Copy Markdown
Member Author

@zhikaip will make this change before merging

@jstoobysmith

Copy link
Copy Markdown
Member Author

@zhikaip Made the change

@zhikaip

zhikaip commented Oct 2, 2026

Copy link
Copy Markdown
Collaborator

Lgtm

@jstoobysmith
jstoobysmith added this pull request to the merge queue Oct 2, 2026
Merged via the queue into leanprover-community:master with commit c230f81 Oct 2, 2026
4 checks passed
@jstoobysmith
jstoobysmith deleted the KLV branch October 2, 2026 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

large PhyslibAlpha Pull requests which are for modifications to PhyslibAlpha. ready-to-merge This PR is approved and will be merged shortly t-electromagnetism Electromagnetism

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants