Skip to content

Fixed documentation issues in PowerElectronics #590

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.

Sign up for GitHub

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

Merged
pelesh merged 3 commits into from
Sep 29, 2026
Merged

Fixed documentation issues in PowerElectronics #590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
925f7d4
Fixed documentation issues in PowerElectronics
abdourahmanbarry Sep 24, 2026
5cf5b7c
Update documentation
abdourahmanbarry Sep 29, 2026
30c02c8
Update RN to R_N
abdourahmanbarry Sep 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions GridKit/Model/PowerElectronics/DistributedGenerator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

The Distributed Generator Component found in references 1 and 2.
The Distributed Generator Component found in Pogaku et al.[^1] and Bidram et al.[^2].

Parameters:
+ $\omega_b$ - Reference Rotating Frame
Expand All @@ -11,7 +11,7 @@ Parameters:
+ $K_{pv}$ - PI Controller Parameter in 1 & 2
+ $K_{iv}$ - PI Controller Parameter in 1 & 2
+ $K_{pc}$ - PI Controller Parameter in 1 & 2
+ $C_f$ - Shunt??
+ $C_f$ - LC-filter capacitance
+ $r_{Lf}$ - Resistance of line f
+ $L_{f}$ - Inductance of line f
+ $r_{Lc}$ - Resistance of line c
Expand All @@ -38,12 +38,12 @@ Variables (Internal):
+ $i_{od}$ - Current of Line o (dq-space)
+ $i_{oq}$ - Current of Line o (dq-space)

Equations (External, Residuals):
Contributions to external equations:
+ $\omega_{com} - \omega$    (If this generator is considered the reference one, otherwise 0)
+ $\cos(\delta) i_{od} - \sin(\delta) i_{oq}$
+ $\sin(\delta) i_{od} + \cos(\delta) i_{oq}$
+ $\cos(\delta) i_{od} - \sin(\delta) i_{oq}$    (Bus residual terms)
+ $\sin(\delta) i_{od} + \cos(\delta) i_{oq}$    (Bus residual terms)

Equations (Internal):
Internal equations:
+ $\omega_{com} = \omega_{b} - m_{p} P$
+ $\frac{d\delta}{dt} = \omega_{com} - \omega$
+ $\frac{dP}{dt} = \omega_c ( v_{od} i_{od} + v_{oq} i_{oq} - P)$
Expand All @@ -70,5 +70,5 @@ Equations (Internal):
Note all internal direct equalities are simplified into the differential equations.


1. Pogaku, Nagaraju, Milan Prodanovic, and Timothy C. Green. "Modeling, analysis and testing of autonomous operation of an inverter-based microgrid." IEEE Transactions on power electronics 22.2 (2007): 613-625.
2. Bidram, Ali, Frank L. Lewis, and Ali Davoudi. "Distributed control systems for small-scale power networks: Using multiagent cooperative control theory." IEEE Control systems magazine 34.6 (2014): 56-77.
[^1]: Pogaku, Nagaraju, Milan Prodanovic, and Timothy C. Green. "Modeling, analysis and testing of autonomous operation of an inverter-based microgrid." IEEE Transactions on power electronics 22.2 (2007): 613-625.
[^2]: Bidram, Ali, Frank L. Lewis, and Ali Davoudi. "Distributed control systems for small-scale power networks: Using multiagent cooperative control theory." IEEE Control systems magazine 34.6 (2014): 56-77.
10 changes: 5 additions & 5 deletions GridKit/Model/PowerElectronics/MicrogridBusDQ/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
The bus model used for the microgrid found in Pogaku et al.[^1] and Bidram et al.[^2]

Parameters:
+ $RN$ - Virtual Resistance
+ $R_N$ - Virtual Resistance

Variables (External):
+ $v_{D}$ - Bus voltage along direct axis
+ $v_{Q}$ - Bus voltage along quadrature axis

Equations (External, Residuals):
+ $\frac{-v_D}{RN}$
+ $\frac{-v_Q}{RN}$
Contributions to external equations:
+ $\frac{-v_D}{R_N}$
+ $\frac{-v_Q}{R_N}$

There are no internal variables to this system. Only residuals to be added from existing externals. As $RN \rightarrow \infty$ then the bus represent Kirchhoff's current law.
There are no internal variables to this system. Only residuals to be added from existing externals. As $R_N \rightarrow \infty$ then the bus represent Kirchhoff's current law.


[^1]: Pogaku, Nagaraju, Milan Prodanovic, and Timothy C. Green. "Modeling, analysis and testing of autonomous operation of an inverter-based microgrid." IEEE Transactions on power electronics 22.2 (2007): 613-625.
Expand Down
18 changes: 9 additions & 9 deletions GridKit/Model/PowerElectronics/MicrogridLine/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

The Line used for the Microgrid found in references 1 and 2.
The Line used for the Microgrid found in Pogaku et al.[^1] and Bidram et al.[^2].

Parameters:
+ $R$ - Resistance
Expand All @@ -14,17 +14,17 @@ Variables (External):
+ $i_{D}$ - Line Current (D)
+ $i_{Q}$ - Line Current (Q)

Equations (External, Residuals):
Contributions to external equations:
+ $0$    (Reference Rotor Residual)
+ $-i_{D}$    (Bus 1 Residuals)
+ $-i_{Q}$
+ $i_{D}$    (Bus 2 Residuals)
+ $i_{Q}$
+ $-i_{D}$    (Bus 1 residual term)
+ $-i_{Q}$    (Bus 1 residual term)
+ $i_{D}$    (Bus 2 residual term)
+ $i_{Q}$    (Bus 2 residual term)

Equations (Internal):
Internal equations:
+ $\frac{di_{D}}{dt} = -(\frac{R}{L}) i_{D} + \omega_{ref} i_{Q} + \frac{v_{D1} - v_{D2}}{L}$
+ $\frac{di_{Q}}{dt} = -(\frac{R}{L}) i_{Q} + \omega_{ref} i_{D} + \frac{v_{Q1} - v_{Q2}}{L}$


1. Pogaku, Nagaraju, Milan Prodanovic, and Timothy C. Green. "Modeling, analysis and testing of autonomous operation of an inverter-based microgrid." IEEE Transactions on power electronics 22.2 (2007): 613-625.
2. Bidram, Ali, Frank L. Lewis, and Ali Davoudi. "Distributed control systems for small-scale power networks: Using multiagent cooperative control theory." IEEE Control systems magazine 34.6 (2014): 56-77.
[^1]: Pogaku, Nagaraju, Milan Prodanovic, and Timothy C. Green. "Modeling, analysis and testing of autonomous operation of an inverter-based microgrid." IEEE Transactions on power electronics 22.2 (2007): 613-625.
[^2]: Bidram, Ali, Frank L. Lewis, and Ali Davoudi. "Distributed control systems for small-scale power networks: Using multiagent cooperative control theory." IEEE Control systems magazine 34.6 (2014): 56-77.
14 changes: 7 additions & 7 deletions GridKit/Model/PowerElectronics/MicrogridLoad/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

The Load used for the Microgrid found in references 1 and 2.
The Load used for the Microgrid found in Pogaku et al.[^1] and Bidram et al.[^2].

Parameters:
+ $R$ - Resistance
Expand All @@ -12,16 +12,16 @@ Variables (External):
+ $i_{D}$ - Line Current (D)
+ $i_{Q}$ - Line Current (Q)

Equations (External, Residuals):
Contributions to external equations:
+ $0$    (Reference Rotor Residual)
+ $-i_{D}$    (Bus Residuals)
+ $-i_{Q}$
+ $-i_{D}$    (Bus residual term)
+ $-i_{Q}$    (Bus residual term)

Equations (Internal):
Internal equations:
+ $\frac{di_{D}}{dt} = -(\frac{R}{L}) i_{D} + \omega_{ref} i_{Q} + \frac{v_{D1} - v_{D2}}{L}$
+ $\frac{di_{Q}}{dt} = -(\frac{R}{L}) i_{Q} + \omega_{ref} i_{D} + \frac{v_{Q1} - v_{Q2}}{L}$



1. Pogaku, Nagaraju, Milan Prodanovic, and Timothy C. Green. "Modeling, analysis and testing of autonomous operation of an inverter-based microgrid." IEEE Transactions on power electronics 22.2 (2007): 613-625.
2. Bidram, Ali, Frank L. Lewis, and Ali Davoudi. "Distributed control systems for small-scale power networks: Using multiagent cooperative control theory." IEEE Control systems magazine 34.6 (2014): 56-77.
[^1]: Pogaku, Nagaraju, Milan Prodanovic, and Timothy C. Green. "Modeling, analysis and testing of autonomous operation of an inverter-based microgrid." IEEE Transactions on power electronics 22.2 (2007): 613-625.
[^2]: Bidram, Ali, Frank L. Lewis, and Ali Davoudi. "Distributed control systems for small-scale power networks: Using multiagent cooperative control theory." IEEE Control systems magazine 34.6 (2014): 56-77.
49 changes: 30 additions & 19 deletions GridKit/Model/PowerElectronics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,38 @@ The composer suppose Jacobian constructions as well.
Example with two components is as follows.

Component 1:
```math
\begin{align}
0 = f_1\left(\frac{dy_{1}}{dt}, y_1 , w \right) & \qquad \text{(Internal Equations Residual)}\\
c_1(y_1, w) & \qquad \text{(External Coupling Term)}\\
\end{align}
```

$$
\begin{aligned}
0 &= f_1\left(\frac{dy_1}{dt}, y_1, w\right)
&\qquad& \text{(Internal Equations Residual)} \\
&c_1(y_1,w)
&\qquad& \text{(External Coupling Term)}
\end{aligned}
$$

Component 2:
```math
\begin{align}
0 = f_2\left(\frac{dy_{2}}{dt}, y_2 ,w\right) & \qquad \text{(Internal Equations Residual)}\\
c_2(y_2,w) & \qquad \text{(External Coupling Term)}\\
\end{align}
```

$$
\begin{aligned}
0 &= f_2\left(\frac{dy_2}{dt}, y_2, w\right)
&\qquad& \text{(Internal Equations Residual)} \\
&c_2(y_2,w)
&\qquad& \text{(External Coupling Term)}
\end{aligned}
$$

The composition of components 1 and 2:
```math
\begin{align}
0 = f_1\left(\frac{dy_{1}}{dt}, y_1 ,w\right) & \qquad \text{(Internal Equations Residuals)}\\
0 = f_2\left(\frac{dy_{2}}{dt}, y_2 ,w\right) &\\
0 = c_1(y_1, w) + c_2(y_2,w) & \qquad \text{(External Coupling Residuals)}\\
\end{align}
```

$$
\begin{aligned}
0 &= f_1\left(\frac{dy_1}{dt}, y_1,w\right)
&\qquad& \text{(Internal Equations Residuals)} \\
0 &= f_2\left(\frac{dy_2}{dt}, y_2,w\right)
& & \\
0 &= c_1(y_1,w) + c_2(y_2,w)
&\qquad& \text{(External Coupling Residuals)}
\end{aligned}
$$

Note the dimensions of $y$ can be $0$ if there are no internal equations (an example seen in Resistors and MicrogridBus).
Loading