Skip to content

Commit d8bc66d

Browse files
committed
Improve HowTo
* The HowTo documentation has been checked against the updated Examples documentation to ensure consistency. As a results, a few details were added. * The procedure is now described as a list of steps. * Links were added to the Generation Group examples.
1 parent 037f8ed commit d8bc66d

1 file changed

Lines changed: 26 additions & 20 deletions

File tree

OpenIPSL/Data/PowerPlant/HowTo.mo

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,35 @@ explains the process required to create a simple network model along with a
1515
Although it is not necessary to create a model only for the generation group,
1616
it is highly recommended as it promotes modularity and flexibility.
1717
It should be noted that the network model can grow in size and complexity,
18-
as the <strong>IEEE14</strong> and <strong>N44</strong> examples demonstrate.
18+
as the <a href=\"modelica://OpenIPSL.Examples.IEEE14.Generation_Groups\"><code>IEEE14</code></a> and
19+
<a href=\"modelica://OpenIPSL.Examples.N44.Base_Case.Generators\"><code>N44</code></a> examples demonstrate.
1920
For these last two cases, there is a generator group model for each generator connected to the network.
2021
</p>
2122
<p>
22-
To be able to make use of the parameterized records in this package,
23-
simply <em>drag and drop</em> an instance of the <code>GUDynamics</code> record
24-
onto the interest generation group model.
25-
</p>
26-
<p>
27-
Then, propagate the record to the upper level and double click on the generator component.
28-
Go to the dropdown list of the propagated <code>GUnitDynamics</code>
29-
and <em>choose the set of parameters that best suits your needs</em>.
30-
The available parameters can be inspected later by first clicking on the
31-
button to the right of the drop-down list, and then on the button of the
32-
corresponding generator set component (e.g., machine, excitation system).
33-
</p>
34-
<p>The last step is to double-click on each of the model components and
35-
insert references to match the parameters with their corresponding values from the
36-
<code>GUDynamics</code> record.
37-
For example, after double-clicking on the machine component, its inertia parameter H
38-
can be assigned by reference using the expression <code>gUDynamics.guDynamics.machine.H</code>.
39-
The reference can be typed, copied and pasted or can be explored using the
40-
<em>Insert Component Reference</em> functionality.
23+
To be able to make use of the parameterized records containing the dynamic response related
24+
parameters of machines and their controls from this package, you must:
25+
<ul>
26+
<li>Go to the <em>generation group model</em> where you intend to use the records.</li>
27+
<li>Drag and drop an instance of the <code>OpenIPSL.Data.PowerPlant.GUDynamics</code> record
28+
on the diagram layer of the model.</li>
29+
<li>Propagate the record to the upper-level model (i.e. to the <em>network model</em> where the
30+
<em>generation group model</em> is instantiated).</li>
31+
<li>Go to the <em>network model</em> (i.e. the upper-level model) and double click on the
32+
generator component.</li>
33+
<li>Expand the drop-down list of the propagated <code>GUnitDynamics</code> parameter and
34+
and <em>choose the set of parameters that best suits your needs</em>. Notice that the
35+
available parameters can be inspected later by first clicking on the button to the right
36+
of the drop-down list, and then on the button of the corresponding generator group
37+
component (e.g., machine, excitation system).</li>
38+
<li>Go back to the <em>generation group model</em> and double-click each machine and machine
39+
control component, one at the time. Make sure you insert all required references to
40+
match the parameters with their corresponding values from the
41+
<code>GUDynamics</code> record. For example, after double-clicking on the machine
42+
component, its inertia parameter H can be assigned by reference using the expression
43+
<code>gUDynamics.guDynamics.machine.H</code>. The reference can be (a) typed,
44+
(b) copied and pasted or, (c) explored using the
45+
<em>Insert Component Reference</em> functionality.</li>
46+
</ul>
4147
</p>
4248
<p>A couple of <strong>examples</strong> have been created to illustrate the entire procedure.</p>
4349
</html>"));

0 commit comments

Comments
 (0)