COUPLER

 

The COUPLER function returns the reaction force of a coupler entity.

 

Format

 

Arguments definition

Coupler entity

The name or argument number of the coupler entity to be measured

Flag

A value that specifies the body to which the output load is applied

     If the flag value is 0, then the force applied to the action marker (body) is returned.

     If the flag value is 1, then the force applied to the base marker (body) is returned.

Component

The components subject to the returned force

     One component can be inserted in line with 6 numbered powers and sizes (1: FM,  2:FX,  3:FY,  4:FZ,  5:TM,  6:TX,  7:TY,  8:TZ).

RMarker

The name or argument number of the standard marker for the direction in which the force is measured

 

Example

COUPLER (COUPLER1, 0, 1, Ground.InertiaMarker)

COUPLER (1, 0, 1, 2) <Argument: (1) COUPLER1, (2) Ground.InertiaMarker >