Skip to content

Commit 383f609

Browse files
committed
Change documentation
1 parent bc4cf65 commit 383f609

File tree

1 file changed

+3
-28
lines changed

1 file changed

+3
-28
lines changed

Modelica/Mechanics/Translational/Components/IdealGear.mo

+3-28
Original file line numberDiff line numberDiff line change
@@ -16,37 +16,12 @@ equation
1616
annotation (
1717
Documentation(info="<html>
1818
<p>
19-
This element characterizes any type of lever which is fixed in the
19+
This element characterizes any type of gear which is fixed in the
2020
ground and which has one driving flange and one driven flange.
21-
The lever is <strong>ideal</strong>, i.e., it does not have mass, elasticity, damping
22-
or backlash. If these effects have to be considered, the lever has to be
21+
The gear is <strong>ideal</strong>, i.e., it does not have mass, elasticity, damping
22+
or backlash. If these effects have to be considered, the gear has to be
2323
connected to other elements in an appropriate way.
2424
</p>
25-
26-
<h4>Classification of lever</h4>
27-
<p>
28-
Generally, a&nbsp;lever is classified by its ratio&nbsp;<var>i</var> which is the ratio
29-
between the driving flange position and the driven flange position. The type of lever is,
30-
then, given by the magnitude of <var>i</var> as follows:
31-
</p>
32-
<ul>
33-
<li>
34-
<var>i</var>&nbsp;&lt;&nbsp;0: <em>1st class lever</em>; the lever&apos;s pivot is
35-
located between the driving and the driven flange.
36-
</li>
37-
<li>
38-
<var>i</var>&nbsp;&gt;&nbsp;1: <em>2nd class lever</em>; the driven
39-
flange is located between the driving flange and the lever&apos;s pivot.
40-
</li>
41-
<li>
42-
0&nbsp;&lt;&nbsp;<var>i</var>&nbsp;&lt;&nbsp;1: <em>3rd class lever</em>; the
43-
driving flange is located between the driven flange and the lever&apos;s pivot.
44-
</li>
45-
</ul>
46-
<p>
47-
Applying the abovementioned to this element, the parameter <code>ratio</code> can be considered equal
48-
to <var>i</var> only when <code>flange_a</code> is the driving flange.
49-
</p>
5025
</html>"),
5126
Icon(
5227
coordinateSystem(preserveAspectRatio=true,

0 commit comments

Comments
 (0)