Skip to content

Commit 5776f3c

Browse files
committed
GUI issue #66: Update documentation for the prismatic- and cylindric
joints, adding a button for switching between the two joint types. Remove two repeated sentences in the Free joint documentation.
1 parent 6bb0872 commit 5776f3c

File tree

7 files changed

+175
-140
lines changed

7 files changed

+175
-140
lines changed

src/ReferenceGuide/htm/properties/_cylindric_joint.htm

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,25 @@ <h5>
2020
</td></tr></table>
2121
</h5>
2222

23-
<h1><a name="_properties_cylindric-joint"></a>Cylindric Joint</h1>
24-
25-
<p>The Cylindric joint object is used to represent a Cylindric joint in a FEDEM model.
26-
A Cylindric joint has four unconstrained DOFs that allow both translational
27-
displacement along the local z-axis, and rotation about the local z-axis.
23+
<h1><a name="cylindric-joint"></a>Cylindric Joint</h1>
24+
25+
<p>The Cylindric joint object is used to represent a Cylindric joint in a FEDEM model.</p>
26+
27+
<p>A Cylindric joint consists of a slave triad sliding along a straight path
28+
defined by two or more master triads. The local coordinate system of the joint
29+
is defined with its Z-axis directed along the slide path. The X- and Y-axes
30+
are then defined from the coordinate systems of the master triads.</p>
31+
32+
<p>The Cylindric joint has four unconstrained DOFs that allow for translational
33+
displacement along the local Z-axis, and rotation about all three axes.
34+
It has two joint DOFs with property settings. They allow you to control the
35+
translational displacement of the slave triad relative to the first master triad
36+
along the local Z-axis (the slider variable), and the
37+
angle of rotation of the slave triad about the local Z-axis, respectively.
38+
The rotation angle is measured between the X-axis of the first master triad and
39+
the X-axis of the slave triad.
2840
It does not constrain motion in the other two rotational directions.</p>
2941

30-
<p>The Cylindric joint has two joint DOFs. They are the translational distance
31-
along the local z-axis from the first master to the slave (the slider variable)
32-
and the angle of rotation of the slave about the local z-axis.
33-
The rotation angle is measured between the x-axis of the first master triad and
34-
the x-axis of the slave triad.</p>
35-
3642
<p>See the section on "Joints" in the "Mechanism Elements" chapter in the
3743
FEDEM User's Guide, for more information on Cylindric joints.</p>
3844

src/ReferenceGuide/htm/properties/_cylindric_props.htm

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,9 @@
1212
determines how fast the slave rotates as it translates along the joint axis.
1313
See the FEDEM Theory Guide, Section 6.4.3 "Screw joint" for more information
1414
about the screw ratio.</td></tr>
15+
<tr><td>Convert to Prismatic joint</td><td>Click this button to replace the
16+
Cylindric joint with a <a href="#prismatic-joint">Prismatic joint</a> connected
17+
to the same set of triads. The properties assigned to the <i>Tz</i> DOF will
18+
then be transferred to the Prismatic joint, whereas the <i>Rz</i> properties
19+
(if any) will be lost.</td></tr>
1520
</table></p>

src/ReferenceGuide/htm/properties/_prismatic_joint.htm

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,26 @@ <h5>
2020
</td></tr></table>
2121
</h5>
2222

23-
<h1><a name="_properties_prismatic-joint"></a>Prismatic Joint</h1>
23+
<h1><a name="prismatic-joint"></a>Prismatic Joint</h1>
2424

2525
<p><img src="../../img/prp/prp-prismatic-joint-2.png"></p>
2626

27-
<p>The Prismatic joint object is used to represent a Prismatic joint in a FEDEM model.
27+
<p>The Prismatic joint object is used to represent a Prismatic joint in a FEDEM model.</p>
2828

2929
<p>A Prismatic joint consists of a slave triad sliding along a straight path
3030
defined by two or more master triads. The local coordinate system of the joint
31-
is defined with its z-axis directed along the slide path. The x- and y-axes
32-
are defined from the coordinate systems of the master triads.
33-
</p>
31+
is defined with its Z-axis directed along the slide path. The X- and Y-axes
32+
are then defined from the coordinate systems of the master triads.</p>
3433

3534
<p>The Prismatic joint has three unconstrained DOFs, but only a single DOF
3635
(the slider variable, i.e., the distance from the first master to the slave
37-
triad in the direction of the local z-axis) with property settings that allows
36+
triad in the direction of the local Z-axis) with property settings that allows
3837
you to control the translational displacement of the slave triad.
39-
Rotation is constrained about the z-axis, but not in the other two directions
40-
(the slave triad can rotate about the local x- and y-axes independently of the
41-
masters triads).Two prismatic joints can be combined to make a stiff
38+
Rotation is constrained about the Z-axis, but not in the other two directions
39+
(the slave triad can rotate about the local X- and Y-axes independently of the
40+
masters triads).</p>
41+
42+
<p>Two prismatic joints can be combined to make a stiff
4243
translating connection, by attaching the master triads for the two joints to
4344
the same FE nodes (in the same order) and attaching the two slave triads to
4445
the same FE part but on different nodes.</p>

src/ReferenceGuide/htm/properties/_prismatic_props.htm

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,11 @@
66
This file is part of FEDEM - https://openfedem.org
77
--->
88

9-
<tr><td>Friction</td><td>Specifies the friction in the Prismatic joint.</td></tr>
9+
<tr><td>Friction</td><td>Specifies the friction in the <i>Tz</i> DOF
10+
of the Prismatic joint.</td></tr>
11+
<tr><td>Convert to Cylindric joint</td><td>Click this button to replace the
12+
Prismatic joint with a <a href="#cylidric-joint">Cylindric joint</a> connected
13+
to the same set of triads. The properties assigned to the <i>Tz</i> DOF
14+
(if any) will then be transferred to the Cylindric joint.</td></tr>
15+
1016
</table></p>
20 KB
Loading
16.1 KB
Loading

0 commit comments

Comments
 (0)