Lukel/phasor docs #88
Merged
Conversation
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
abirchfield
requested changes
Apr 28, 2025
Co-authored-by: pelesh <peless@ornl.gov>
|
Branch is up to date with requested edits. Thank you for the feedback! We can extend explanations further, just please identify what could benefit from enrichment. |
|
Move 4 differential variables back to differential as discussed |
Correction is needed for both, GENROU and GENSAL docs. |
|
Okay, ready for approval. I will create new branch for exciter & governor models moving forward and use these models as reference for formatting. |
abdourahmanbarry
approved these changes
May 2, 2025
pelesh
requested changes
May 2, 2025
Co-authored-by: pelesh <peless@ornl.gov>
Co-authored-by: pelesh <peless@ornl.gov>
|
Changes applied, thank you. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
The documentation for the GENROU and GENSAL (Synchronous Machine models) has been reviewed and modified to be consistent with the implementation.
This closes issue #79
Proposed changes
The README equations and nomenclature notation is derived directly from the C++ implementation. Information from the general Synchronous Machine README has been removed and put into the relevant sub-models. Since we will be implementing other classes of synch. generator models, so the GENROU and GENSAL equations should not be inn the folders general README.
Further comments
Let me know if there was any notation violations, the guidelines don't seem to have much in regards to math notation.