FRICTION

The FRICTION function returns force and other friction data from the FRICTION statement. You can use this function in only REQUEST and SENSOR function expressions.

Format

FRICTION (id, index)

Arguments

 
id
An integer variable specifying the identification of a FRICTION statement from which output data is requested.
INDEX
An integer variable specifying the output component index to be returned. See the table below for a list of component indices.
Friction Index
 
Index:
Name:
Description:
1
FFX
Friction force along the x-axis of the JOINT’s J marker
2
FFY
Friction force along the y-axis of the JOINT’s J marker
3
FFZ
Friction force along the z-axis of the JOINT’s J marker
4
FTX
Friction torque about the x-axis of the JOINT’s J marker
5
FTY
Friction torque about the y-axis of the JOINT’s J marker
6
FTZ
Friction torque about the z-axis of the JOINT’s J marker
7
x
Friction coefficient along the x-axis of the JOINT’s J marker
8
y
Friction coefficient along the y-axis of the JOINT’s J marker
9
z
Friction coefficient along the z-axis of the JOINT’s J marker
10
rx
Friction coefficient about the x-axis of the JOINT’s J marker
11
ry
Friction coefficient about the y-axis of the JOINT’s J marker
12
rz
Friction coefficient about the z-axis of the JOINT’s J marker
13
1
Effective friction coefficient at static friction (returns zero if sliding)
14
Vx
Joint velocity at sliding surfaces along the x-axis of the JOINT’s J marker
15
Vy
Joint velocity at sliding surfaces along the y-axis of the JOINT’s J marker
16
Vz
Joint velocity at sliding surfaces along z-axis of the JOINT’s J marker
17
Wx
Joint angular velocity about the x-axis of the JOINT’s J marker
18
Wy
Joint angular velocity about the y-axis of the JOINT’s J marker
19
Wz
Joint angular velocity about the z-axis of the JOINT’s J marker
20
CREEP_X
Static friction creep along the x-axis of the JOINT’s J marker
21
CREEP_Y
Static friction creep along the y-axis of the JOINT’s J marker
22
CREEP_Z
Static friction creep along the z-axis of the JOINT’s J marker
23
CREEP_RX
Static friction creep about the x-axis of the JOINT’s J marker
24
CREEP_RY
Static friction creep about the y-axis of the JOINT’s J marker
25
CREEP_RZ
Static friction creep about the z-axis of the JOINT’s J marker
26
BETA
Stiction transition factor

Examples

Request/101

,F2=FRICTION (2,1)/, F3=FRICTION (2,2)/, F4=FRICTION (2,3)/
,F6=FRICTION (2,4)/, F7=FRICTION (2,5)/, F8=FRICTION (2,6)/
This REQUEST statement defines a user REQUEST that returns the friction forces associated with the statement FRICTION/2. The second component of the user request contains the X component of the friction-force vector resolved in the associated J marker coordinate system of the JOINT.
 
Caution:  
The FRICTION function is accessible only through the REQUEST and SENSOR function expressions.
The FRICTION function evaluates to zero if the index corresponds to a force or velocity which is not used by the corresponding friction model. For example, if FRICTION/2 from above is applied on a translational joint, then FRICTION (2,1) would be zero because the friction force is applied along the z axes of the joint.
See other Element-specific applied force available.