Skip to content

Commit 5a7f68b

Browse files
lvanfrettidietmarw
lvanfretti
and
dietmarw
authored
Document RampTrackingFilter, PSS2A and PSS2B model implementation details (OpenIPSL#374)
* docs: Add Laera et al. (2022) reference * docs: Document RampTrackingFilter model implementation details * docs: Link PSS2A and PSS2B to RampTrackingFilter and relevant literature * Attempting to fix URI issue * Yet another attempt at fixing the uri * Add links to references. * Fix double tag. * Replace math icon with graphical icon Made icon to represent the intended functionality. Should scale better when resizing than existing one. * Fix the icon size and position of curve. --------- Co-authored-by: Dietmar Winkler <[email protected]>
1 parent 7b8e3b7 commit 5a7f68b

File tree

4 files changed

+69
-33
lines changed

4 files changed

+69
-33
lines changed

‎OpenIPSL/Electrical/Controls/PSSE/PSS/PSS2A.mo‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,5 +118,10 @@ equation
118118
<td><p>see <a href=\"modelica://OpenIPSL.UsersGuide.Contact\">UsersGuide.Contact</a></p></td>
119119
</tr>
120120
</table>
121+
</html>", info="<html>
122+
123+
<p>This model uses an implementation of the ramp tracking filter as described in <a href=\"modelica://OpenIPSL.UsersGuide.References\">[Laera2022]</a>, which can be found under <code>OpenIPSL.NonElectrical.Continuous.RampTrackingFilter</code>.</p>
124+
<p>See <a href=\"modelica://OpenIPSL.UsersGuide.References\">[Laera2022]</a> for the expected behavior of this model.</p>
125+
121126
</html>"));
122127
end PSS2A;

‎OpenIPSL/Electrical/Controls/PSSE/PSS/PSS2B.mo‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,11 @@ equation
113113
extent={{-40,80},{40,40}},
114114
lineColor={28,108,200},
115115
textString="PSS2B")}),
116-
Documentation(info="<html>IEEE Dual-Input Stabilizer Model.</html>",
116+
Documentation(info="<html>
117+
<p>IEEE Dual-Input Stabilizer Model.</p>
118+
<p>This model uses an implementation of the ramp tracking filter as described in <a href=\"modelica://OpenIPSL.UsersGuide.References\">[Laera2022]</a>, which can be found under <code>OpenIPSL.NonElectrical.Continuous.RampTrackingFilter</code>.</p>
119+
<p>See <a href=\"modelica://OpenIPSL.UsersGuide.References\">[Laera2022]</a> for the expected behavior of this model.</p>
120+
</html>",
117121
revisions="<html><table cellspacing=\"1\" cellpadding=\"1\" border=\"1\">
118122
<tr>
119123
<td><p>Reference</p></td>

‎OpenIPSL/NonElectrical/Continuous/RampTrackingFilter.mo‎

Lines changed: 49 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -47,38 +47,47 @@ equation
4747
connect(TF1[M].y, y);
4848
end if;
4949
annotation (
50-
Icon(coordinateSystem(
51-
preserveAspectRatio=true,
52-
extent={{-100,-100},{100,100}},
53-
initialScale=0.05), graphics={Rectangle(extent={{-100,100},{100,-100}},
54-
lineColor={0,0,0}),Text(
55-
extent={{-58,40},{40,-4}},
56-
lineColor={0,0,255},
57-
textString="1+sT"),Text(
58-
extent={{-64,20},{56,-58}},
59-
lineColor={0,0,255},
60-
textString="(1+sT )"),Text(
61-
extent={{22,28},{44,-4}},
62-
lineColor={0,0,255},
63-
textString="1"),Text(
64-
extent={{24,-10},{46,-42}},
65-
lineColor={0,0,255},
66-
textString="2"),Text(
67-
extent={{54,2},{66,-16}},
68-
lineColor={0,0,255},
69-
textString="M"),Line(
70-
points={{-60,40},{-74,40},{-74,-40},{-60,-40}},
71-
color={0,0,255},
72-
thickness=1),Line(
73-
points={{60,40},{76,40},{76,-40},{60,-40}},
74-
color={0,0,255},
75-
thickness=1),Text(
76-
extent={{76,48},{94,28}},
77-
lineColor={0,0,255},
78-
textString="N"),Line(
79-
points={{-68,0},{70,0}},
80-
color={0,0,255},
81-
thickness=1)}),
50+
Icon( graphics={Rectangle(extent={{-100,100},{100,-100}},
51+
lineColor={0,0,0}),
52+
Line(points={{-82,62},{-82,-86}}, color={192,192,192}),
53+
Polygon(
54+
points={{-82,84},{-90,62},{-74,62},{-82,84}},
55+
lineColor={192,192,192},
56+
fillColor={192,192,192},
57+
fillPattern=FillPattern.Solid),
58+
Line(points={{-92,-76},{80,-76}}, color={192,192,192}),
59+
Polygon(
60+
points={{88,-76},{66,-68},{66,-84},{88,-76}},
61+
lineColor={192,192,192},
62+
fillColor={192,192,192},
63+
fillPattern=FillPattern.Solid),
64+
Line(points={{-82,-76},{-38,-76},{16,4}},
65+
thickness=1,
66+
color={238,46,47},
67+
smooth=Smooth.Bezier),
68+
Line(points={{100,72},{62,72},{16,4}},
69+
thickness=1,
70+
color={238,46,47},
71+
smooth=Smooth.Bezier),
72+
Line(
73+
points={{-82,-76},{-42,-76}},
74+
color={28,108,200},
75+
thickness=1,
76+
pattern=LinePattern.Dash),
77+
Line(
78+
points={{-42,-76},{58,72}},
79+
color={28,108,200},
80+
thickness=1,
81+
pattern=LinePattern.Dash),
82+
Line(
83+
points={{58,72},{98,72}},
84+
color={28,108,200},
85+
thickness=1,
86+
pattern=LinePattern.Dash),
87+
Text(
88+
extent={{-74,28},{78,-28}},
89+
textColor={0,0,248},
90+
textString="RTF")}),
8291
Documentation(revisions="<html>
8392
<table cellspacing=\"1\" cellpadding=\"1\" border=\"1\"><tr>
8493
<td><p>Reference</p></td>
@@ -97,5 +106,13 @@ equation
97106
<td><p>see <a href=\"modelica://OpenIPSL.UsersGuide.Contact\">UsersGuide.Contact</a></p></td>
98107
</tr>
99108
</table>
109+
</html>", info="<html>
110+
111+
<p>This block is used by the <code>PSS2A</code> and <code>PSS2B</code> models under <code>OpenIPSL.Electrical.Controls.PSSE.PSS</code>. This implementation has been done starting from the block diagram descriptions from [PSSE-MODELS]. </p>
112+
113+
<p>However, as noted in <a href=\"modelica://OpenIPSL.UsersGuide.References\">[Laera2022]</a>, in order to validate the implementation against PSS/E v.33&apos;s simulation output, further analysis of the actual model response in PSS/E revealed necessary changes that deviate from the block diagrams in [PSS-MODELS]. Consequently, the implementation herein should not be expected to comply with any other &quot;generic&quot; implementation or block diagram description, but to that implemented in PSS/E v.33.</p>
114+
115+
<p>For more information please refer to <a href=\"modelica://OpenIPSL.UsersGuide.References\">[Laera2022]</a>.</p>
116+
100117
</html>"));
101118
end RampTrackingFilter;

‎OpenIPSL/UsersGuide/References.mo‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,16 @@ model References "References"
9191
<a href=\"https://doi.org/10.1109/IEEESTD.2016.7553421\">DOI: 10.1109/IEEESTD.2016.7553421</a>
9292
</td>
9393
</tr>
94+
95+
<tr>
96+
<td>[Laera2022]</td>
97+
<td>
98+
G. Laera, L. Vanfretti, M. de Castro Fernandes, S.A. Dorado-Rojas, F. Fachini, C. Mishra, K.D. Jones and R.M. Gardner,
99+
&quot;Guidelines and Use Cases for Power System Dynamics Modeling and Model Verification using Modelica&quot;,
100+
American Modelica Conference 2022, October 26-28, 2022, Dallas, Texas, US. <a href=\"https://doi.org/10.3384/ECP21186146\">DOI: 10.3384/ECP21186146</a>
101+
</td>
102+
</tr>
103+
94104
<tr>
95105
<td>[Milano2010]</td>
96106
<td>Federico Milano:

0 commit comments

Comments
 (0)