Skip to content

Commit eeb8d69

Browse files
committed
add some parameters to docstring
1 parent ffcdf91 commit eeb8d69

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

src/wheels.jl

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -359,11 +359,13 @@ To work properly, the gravity acceleration vector g of the world must point in t
359359
360360
# Arguments and parameters:
361361
- `iscut`: if more than one wheel set is connected to the same rigid body, `iscut` must be set to true for all but one set. This avoids overconstraining the system by replacing the planar joint giving the set coordinates by an unconstrained FreeMotion joint.
362+
- `radius`: Radius of one wheel
363+
- `track`: Distance between the two wheels (= axle track)
362364
363365
# Connectors:
364366
- `frame_middle`: Frame fixed in middle of axis connecting both wheels (z-axis: along wheel axis, y-axis: upwards)
365-
- `frame1`: Frame fixed in center point of left wheel (z-axis: along wheel axis, y-axis: upwards)
366-
- `frame2`: Frame fixed in center point of right wheel (z-axis: along wheel axis, y-axis: upwards)
367+
- `frame1`: Frame fixed in center point of left wheel, rotating with the wheel (z-axis: along wheel axis, y-axis: upwards when wheel angle is zero)
368+
- `frame2`: Frame fixed in center point of right wheel, rotating with the wheel (z-axis: along wheel axis, y-axis: upwards when wheel angle is zero)
367369
- `axis1`: 1-dim. Rotational flange that drives the joint
368370
- `axis2`: 1-dim. Rotational flange that drives the joint
369371
- `support`: Support of 1-dim axes
@@ -500,14 +502,21 @@ Two wheels are connected by an axis and can rotate around this axis. The wheels
500502
501503
# Arguments and parameters:
502504
- `iscut`: if more than one wheel set is connected to the same rigid body, `iscut` must be set to true for all but one set. This avoids overconstraining the system by replacing the planar joint giving the set coordinates by an unconstrained FreeMotion joint.
505+
- `radius`: Radius of one wheel
506+
- `m_wheel`: Mass of one wheel
507+
- `I_axis`: Moment of inertia of one wheel around its rotation axis
508+
- `I_long`: Moment of inertia of one wheel perpendicular to its rotation axis
509+
- `track`: Distance between the two wheels (= axle track)
503510
504511
# Connectors
505512
- `frame_middle`: Frame fixed in middle of axis connecting both wheels (z-axis: along wheel axis, y-axis: upwards)
506-
- `frame1`: Frame fixed in center point of left wheel (z-axis: along wheel axis, y-axis: upwards)
507-
- `frame2`: Frame fixed in center point of right wheel (z-axis: along wheel axis, y-axis: upwards)
513+
- `frame1`: Frame fixed in center point of left wheel, rotating with the wheel (z-axis: along wheel axis, y-axis: upwards when wheel angle is zero)
514+
- `frame2`: Frame fixed in center point of right wheel, rotating with the wheel (z-axis: along wheel axis, y-axis: upwards when wheel angle is zero)
508515
- `axis1`: 1-dim. Rotational flange that drives the left wheel
509516
- `axis2`: 1-dim. Rotational flange that drives the right wheel
510517
- `support`: Support of 1D axes
518+
519+
To connect driving torques or friction to rotation of the wheels, connect between `axis1` and `support`, and `axis2` and `support` respectively. To connect the wheel set to, e.g., a body, connect the `frame_middle` to the body frame.
511520
"""
512521
function RollingWheelSet(;
513522
name,

0 commit comments

Comments
 (0)