[lukelowry]

Description

Specifications for a branch with breakers and two relay models. Follow-up to #610. Docs only, implementation follows in separate PRs.

Proposed changes

• BranchBreakers: π branch with a breaker at each terminal. Each breaker is a smooth closed-state latch driven by trip and close inputs, and the terminal currents are outputs for relays to measure. Separate component, so Branch and existing cases are unchanged.
• DefiniteTimeRelay: one model for the 27, 50, 59, 81O, and 81U elements. Mpickup above or below Mref sets over vs. under operation.
• InverseTimeRelay: inverse-time overcurrent (51) using the IEEE C37.112 curves.
• Both relays have optional lockout.
• Add latch (smooth set-reset) to CommonMath.md.
• Relay docs category and BranchBreakers block diagram.

Checklist

• N/A All tests pass.
• N/A Code compiles cleanly with flags -Wall -Wpedantic -Wconversion -Wextra.
• N/A The new code follows GridKit™ style guidelines.
• N/A There are unit tests for the new code.
• The new code is documented.
• The feature branch is rebased with respect to the target branch.
• N/A The CHANGELOG.md has been updated to reflect the changes.

Further comments

High value and highly requested by others at TAMU.

[read-the-docs-community]

Documentation build overview

📚 GridKit | 🛠️ Build #35601719 | 📁 Comparing 96b899e against latest (4315301)

  🔍 Preview build  

216 files changed · + 112 added · ± 88 modified · - 16 deleted

+ Added

• api/reference/classAnalysisManager_1_1SteadyState_1_1IpoptInterface.html
• api/reference/classGridKit_1_1Model_1_1ConfigurationChecks.html
• api/reference/classGridKit_1_1Model_1_1OptimizationEvaluator.html
• api/reference/classGridKit_1_1Model_1_1ParameterReader.html
• api/reference/classGridKit_1_1OptimalPowerFlow_1_1Branch.html
• api/reference/classGridKit_1_1OptimalPowerFlow_1_1Bus.html
• api/reference/classGridKit_1_1OptimalPowerFlow_1_1Component.html
• api/reference/classGridKit_1_1OptimalPowerFlow_1_1Generator.html
• api/reference/classGridKit_1_1OptimalPowerFlow_1_1Load.html
• api/reference/classGridKit_1_1OptimalPowerFlow_1_1SystemModel.html
• and 102 more...

± Modified

• genindex.html
• GridKit/CommonMath.html
• cases/README.html
• development/CHANGELOG.html
• development/CONTRIBUTING.html
• examples/README.html
• api/reference/classGridKit_1_1Model_1_1VariableMonitorBase.html
• api/reference/classGridKit_1_1Model_1_1VariableMonitorController.html
• api/reference/classGridKit_1_1PhasorDynamics_1_1Branch.html
• api/reference/classGridKit_1_1PhasorDynamics_1_1BusBase.html
• and 78 more...

- Deleted

• api/reference/classGridKit_1_1PhasorDynamics_1_1BusFault.html
• api/reference/dir_GridKit_Model_PhasorDynamics_BusFault.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1a688a138fbd3d7f6a08b3e474496f2771.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1ac462ff3ce4dd5e49f8ea341c58c383c2.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1ad07447f57a589d38b98504a9ada9ccac.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1adbd99bf52e0ba1864a89a33c66065fc8.html
• api/reference/enum_namespaceGridKit_1_1PhasorDynamics_1af5e4141351261054f3d5aa62eb231e7d.html
• api/reference/file_GridKit_Model_PhasorDynamics_BusFault_BusFault.hpp.html
• api/reference/file_GridKit_Model_PhasorDynamics_BusFault_BusFaultData.hpp.html
• api/reference/function_namespaceGridKit_1_1Model_1_1VariableMonitorDetail_1a3739d7ddea33e27e0a5c6a24cb5a6e25.html
• and 6 more...

[abirchfield]

Looks great!

[lukelowry]

@pelesh I will open implementation for BranchBreaker first, after this is approved and merged