Skip to content

Governor Documentation and Model #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 19 commits into
base: develop
Choose a base branch
from
Open

Conversation

lukelowry
Copy link
Collaborator

@lukelowry lukelowry commented May 7, 2025

Description

Documentation for the phasor dynamics governor (TGOV1) that will be implemented following this PR.

Proposed changes

Restructured folder to allow for many gov. types and added documentation for TGOV1

Further comments

There are piece-wise differential equations in this system. I wrote a short proposal on how to implement this to cooperate with the general solver. Please let me know if a bump function is sufficient or if the general solver can handle piece-wise definition (not to my knowledge).

Also there was a small latex issue in GENROU that I included in this PR.

Checklist

  • Governor Implementation
  • Proper CMake build configuration.
  • Documentation in a form of README file with model equations.
  • Example of usage.
  • All tests pass.
  • The new code follows GridKit™ style guidelines.
  • There are unit tests for the new code.
  • The feature branch is rebased with respect to the target branch.

@lukelowry lukelowry requested a review from abirchfield May 7, 2025 19:17
@pelesh pelesh added the documentation Improvements or additions to documentation label May 7, 2025
Copy link
Collaborator

@pelesh pelesh left a comment

Choose a reason for hiding this comment

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

Great work! It would be good to make some additional clarification and make sure equations match the signal flow diagram.

@lukelowry
Copy link
Collaborator Author

Comments addressed. Awaiting @abirchfield comments, especially in regards to clarifying units.

@lukelowry lukelowry changed the title Governor Documentation Governor Documentation and Model May 11, 2025
@lukelowry
Copy link
Collaborator Author

Untested implementation in recent commit, aligned with documentation.

Copy link
Collaborator

@abirchfield abirchfield left a comment

Choose a reason for hiding this comment

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

Documentation needs to be updated to reflect structure in #127 and #128 .

I suggest documenting both piecewise and an initial smoothed approximation for the limits.

@abirchfield
Copy link
Collaborator

Also, name of model should be TGOV1 or Governor_TGOV1. TurbineGov could apply to other future governors and we want each to be unique.

@pelesh
Copy link
Collaborator

pelesh commented Jun 5, 2025

Also, name of model should be TGOV1 or Governor_TGOV1. TurbineGov could apply to other future governors and we want each to be unique.

Per developer guidelines class names should be upper camel case format, something like this: GovernorTgov1. Would that be acceptable to domain specialists?

We could also use just Tgov1 and put it in a Governor namespace. In that case one would reference the class as Governor::Tgov1.

CC @superwhiskers @nkoukpaizan @alexander-novo

@abirchfield
Copy link
Collaborator

GovernorTgov1 is ok.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation new model
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants