docs: explain phase-shifting transformers with GenericBranch#1485
Open
nightcityblade wants to merge 1 commit into
Open
docs: explain phase-shifting transformers with GenericBranch#1485nightcityblade wants to merge 1 commit into
nightcityblade wants to merge 1 commit into
Conversation
Signed-off-by: nightcityblade <nightcityblade@gmail.com>
nightcityblade
force-pushed
the
fix/issue-1484
branch
from
July 22, 2026 15:35
149bf0b to
6542ae2
Compare
mgovers
requested changes
Jul 23, 2026
mgovers
left a comment
mgovers
left a comment
Member
There was a problem hiding this comment.
Hi @nightcityblade,
Thank you for your contribution! I only have one minor comment. After you've resolved that, I will kick off CI.
Comment on lines
+274
to
+291
| #### Phase-shifting transformer | ||
|
|
||
| A `generic_branch` can represent a static phase-shifting transformer with finite series impedance. For the tap position | ||
| being calculated, use: | ||
|
|
||
| * `k` for the transformer magnitude ratio; | ||
| * `theta` for the fixed and tap-dependent phase shift, in radians; | ||
| * `r1` and `x1` for the transformer series resistance and reactance; and | ||
| * `g1` and `b1` for the magnetizing conductance and susceptance. | ||
|
|
||
| For example, a lossless phase-shifting transformer that still has finite series reactance can use `r1 = 0`, `x1 > 0`, | ||
| `g1 = 0`, `b1 = 0`, `k = 1`, and `theta` equal to the desired phase shift. | ||
|
|
||
| ```{warning} | ||
| An impedance-free ideal phase link cannot be represented by setting both `r1` and `x1` to zero. The branch model uses | ||
| `1 / (r1 + j x1)` for its series admittance, so zero series impedance would make the model singular. | ||
| ``` | ||
|
|
Member
There was a problem hiding this comment.
It explains it quite well, but please move it to docs/user_manual/non-pgm-components.md and instead make a reference here to that location.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1484
Summary
generic_branchparameters map to a static phase-shifting transformerTesting
PATH=/Users/shensheng/.nvm/versions/node/v24.18.0/bin:$PATH uv run --frozen --group lint pre-commit run markdownlint --files docs/user_manual/components.mdgit diff --checkThe full Sphinx build could not reach the changed page locally because the generated Doxygen XML (
docs/doxygen/build/xml/index.xml) is absent and Doxygen is not installed in this environment.