Skip to content

Commit

Permalink
Improve and unify documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
christiankral authored and dietmarw committed Jun 7, 2021
1 parent c92023e commit 68198d4
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions Modelica/Electrical/Analog/Lines/M_OLine.mo
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ public
extent={{-150,90},{150,50}},
textString="%name",
textColor={0,0,255})}), Documentation(info="<html>
<p>The segment model is part of the multiple line model. It describes one line segment as outlined in the M_OLine description. Using the loop possibilities of Modelica it is formulated by connecting components the number of which depends on the number of lines.</p>
<p>The segment model is part of the multiple line model. It describes one line segment as outlined in the <code>M_OLine</code> description. Using the loop possibilities of Modelica it is formulated by connecting components the number of which depends on the number of lines.</p>
</html>"));
end segment;

Expand Down Expand Up @@ -217,7 +217,7 @@ public
extent={{-150,90},{150,50}},
textString="%name",
textColor={0,0,255})}), Documentation(info="<html>
<p>The segment_last model is part of the multiple line model. It describes the special line segment which is used to get the line symmetrical as outlined in the M_OLine description. Using the loop possibilities of Modelica it is formulated by connecting components the number of which depends on the number of lines.</p>
<p>The segment_last model is part of the multiple line model. It describes the special line segment which is used to get the line symmetrical as outlined in the <code>M_OLine</code> description. Using the loop possibilities of Modelica it is formulated by connecting components the number of which depends on the number of lines.</p>
</html>"));
end segment_last;

Expand Down Expand Up @@ -336,9 +336,9 @@ its current can be accessed for plotting.</p>
<p>In the picture of the segment can be seen, that a single segment is asymmetric.
Connecting such asymmetric segments in a series forces also an asymmetric multi line.
To get a symmetric model which is useful for coupling and which guaranties the same pin properties,
in the <code>segment_1</code> only half valued resistors and inductors are used.
in <code>segment_1</code> only half valued resistors and inductors are used.
The remaining resistors and inductors are at the other end of the line within
the auxiliary segment_last. For the example with 4 lines the schematic of
the auxiliary <code>segment_last</code>. For the example with 4 lines the schematic of
<code>segment_last</code> is like this:</p>
<blockquote>
Expand All @@ -347,7 +347,7 @@ the auxiliary segment_last. For the example with 4 lines the schematic of
</blockquote>
<p>The number of the capacitors and conductors depends on the number of single lines that are used,
because each line is connected to every other line by both a capacitor and a conductor.
because each line is coupled to every other line by both a capacitor and a conductor.
One line consists of <strong>at least two segments</strong>.
Inside the model <code>M_OLine</code> the model <code>segment</code> is used.
This model represents one segment which is build as described above.
Expand All @@ -369,7 +369,7 @@ The vector length <code>dim_vector_lgc</code> is calculated by:</p>
<p>Inside the model a symmetric inductance matrix, a symmetric capacitance matrix and
a symmetric conductance matrix are built out of the entries of the vectors given by the user.
The way of building is the same for each matrix, so the approach for filling one of the matrices
will be shown in the the examplebelow.</p>
will be shown in the the example below.</p>
<h5>Example</h5>
Expand Down Expand Up @@ -407,7 +407,7 @@ for the <code>M_OLine</code> model, a sensible conductance-matrix would be:</p>
</blockquote>
<p>The user has the possibility to enable a conditional heatport. If so, the <code>M_OLine</code>
can be connected to a thermal network. When the parameter <code>alpha</code> is set to a value greater than zero,
can be connected to a thermal network. When the parameter <code>alpha</code> is set to a value different than zero,
the <code>M_OLine</code> becomes temperature sensitive due to their resistors which resistances
are calculated by</p>
Expand Down

0 comments on commit 68198d4

Please sign in to comment.