Constraints

An object of type CONSTRAINT represents a constraint and its associated data (e.g. constraint reaction). Both, user prescribed constraints (routines below) and contact constraints (detected automatically) are represented by an object of the same type. See also, the Joints section.

FIX_POINT

This routine creates a fixed point constraint.

obj = FIX_POINT (body, point | strength)

  • obj – created CONSTRAINT object

  • body – BODY object whose motion is constrained

  • point – (x, y, z) tuple with referential point coordinates

  • strength - optionally an ultimate magnitude of the reaction force, beyond which the constraint will be deleted (default: infinity)

FIX_DIRECTION

This routine fixes the motion of a referential point along a specified spatial direction. If body2 is given the motion of point2 along the direction convected with the first body is fixed. See also, formulation of the fixed direction constraint.

obj = FIX_DIRECTION (body, point, direction | body2, point2)

  • obj – created CONSTRAINT object

  • body – BODY object whose motion is constrained

  • point – (x, y, z) tuple with referential point coordinates

  • direction – (vx, vy, vz) tuple with spatial direction components

  • body2 – BODY object whose motion is constrained with respect to the motion of the first body (in this case body and body2 can only be either rigid or pseudo-rigid)

  • point2 – (x, y, z) tuple with referential point on body2

SET_DISPLACEMENT

This routine prescribes a displacement history of a referential point along a specified spacial direction. See also, formulation of the prescribed displacement constraint.

obj = SET_DISPLACEMENT (body, point, direction, tms)

  • obj – created CONSTRAINT object

  • body – BODY object whose motion is constrained

  • point – (x, y, z) tuple with referential point coordinates

  • direction – (vx, vy, vz) tuple with spatial direction components

  • tms – TIME_SERIES object with the displacement history

SET_DISPLACEMENT3

This routine prescribes a displacement history of a referential point along all directions at a local orthogonal base.

obj = SET_DISPLACEMENT3 (body, point, base, tms)

  • obj – created CONSTRAINT object

  • body – BODY object whose motion is constrained

  • point – (x, y, z) tuple with referential point coordinates

  • base – (ux, uy, yz, vx, vy, vz, wx, wy, wz) tuple with the local orthogonal base components

  • tms – (ts0, ts1, ts2) tuple of TIME_SERIES objects with the displacement histories

SET_VELOCITY

This routine prescribes a velocity history of a referential point along a specified spacial direction. See also, formulation of the prescribed velocity constraint.

obj = SET_VELOCITY (body, point, direction, value)

  • obj – created CONSTRAINT object

  • body – BODY object whose motion is constrained

  • point – (x, y, z) tuple with referential point coordinates

  • direction – (vx, vy, vz) tuple with spatial direction components

  • value – a constant value or a TIME_SERIES object with the velocity history

SET_VELOCITY3

This routine prescribes a velocity history of a referential point along all directions at a local orthogonal base.

obj = SET_VELOCITY3 (body, point, base, tms)

  • obj – created CONSTRAINT object

  • body – BODY object whose motion is constrained

  • point – (x, y, z) tuple with referential point coordinates

  • base – (ux, uy, yz, vx, vy, vz, wx, wy, wz) tuple with the local orthogonal base components

  • tms – (ts0, ts1, ts2) tuple of TIME_SERIES objects with the velocity histories

SET_ACCELERATION

This routine prescribes an acceleration history of a referential point along a specified spacial direction. See also, formulation of the prescribed acceleration constraint.

obj = SET_ACCELERATION (body, point, direction, tms)

  • obj – created CONSTRAINT object

  • body – BODY object whose motion is constrained

  • point – (x, y, z) tuple with referential point coordinates

  • direction – (vx, vy, vz) tuple with spatial direction components

  • tms – TIME_SERIES object with the acceleration history

SET_ACCELERATION3

This routine prescribes an acceleration history of a referential point along all directions at a local orthogonal base.

obj = SET_ACCELERATION3 (body, point, base, tms)

  • obj – created CONSTRAINT object

  • body – BODY object whose motion is constrained

  • point – (x, y, z) tuple with referential point coordinates

  • base – (ux, uy, yz, vx, vy, vz, wx, wy, wz) tuple with the local orthogonal base components

  • tms – (ts0, ts1, ts2) tuple of TIME_SERIES objects with the acceleration histories

PUT_SPRING

This routine creates an arbitrary spring between two referential points of two distinct bodies. See also, formulation of the spring constraint.

obj = PUT_SPRING (body1, point1, body2, point2, function, limits | direction, update) (Experimental)

  • obj – created CONSTRAINT object

  • body1 – BODY object one whose motion is constrained

  • point1 – (x1, y1, z1) tuple with the first referential point coordinates

  • body2 – BODY object two whose motion is constrained

  • point2 – (x2, y2, z2) tuple with the second referential point coordinates

  • function – Python function callback returning the value of force as the function of stroke:

    force = function (stroke, velocity)

    where \(\text{stroke=}\mathbf{n}\cdot\text{current}\left(\text{point2}-\text{point1}\right)-\text{initial}\left(\left|\text{point2}-\text{point1}\right|\right)\) and velocity is the current relative velocity along the spring direction \(\mathbf{n}\) (positive if stroke increases). See also: REGISTER_CALLBACK.

  • limits – (smin, smax) tuple defining stroke limits (smin \(\le\) 0 and smax \(\ge\) 0)

  • direction – (nx, ny, nz) tuple storing spring direction \(\mathbf{n}\). Default: \(\mathbf{n}=\text{normalized}\left(\text{current}\left(\text{point2}-\text{point1}\right)\right)\) resulting in a follower type spring. When specified, \(\mathbf{n}\) will be updated according to the value of update.

  • update – direction update kind (default: ‘FIXED’); one of: ‘FIXED’ where \(\mathbf{n}\) is kept fixed, or ‘CONV1’ where \(\mathbf{n}\) is convected with body1, or ‘CONV2’ where \(\mathbf{n}\) is convected with body2.

Some parameters can also be accessed as members of a CONSTRAINT object, cf. Table 18.

Table 18 CONSTRAINT object parameters.

Read only members:

obj.kind – kind of constraint: ‘CONTACT’, ‘FIXPNT’ (fixed point), ‘FIXDIR’ (fixed direction), ‘VELODIR’ (prescribed velocity; note that prescribed displacement and acceleration are converted into this case), ‘RIGLNK’ (rigid link)

obj.R – current average (over time step \(\left[t,t+h\right]\)) constraint reaction in a form of a tuple: (RT1, RT2, RN) given with respect to a local base stored at obj.base

obj.U – constraint output relative velocity tuple: (UT1, UT2, UN) given with respect to a local base stored at obj.base

obj.V – contact input relative velocity tuple: (VT1, VT2, VN) given with respect to a local base stored at obj.base

obj.base – current spatial coordinate system in a form of a tuple: (eT1x, eT2x, eNx, eT1y, eT2y, eNy, eT1z, eT2z, eNz) where x, y, z components are global

obj.point – current spatial point where the constraint force acts. This is a (x, y, z) tuple for all constraint types, but ‘RIGLNK’ for which this is a (x1, y1, z1, x2, y2, z2) tuple.

obj.area – current area for contact constraints or zero otherwise

obj.gap – current gap for contact constraints or zero otherwise

obj.merit – current value of the per–constraint merit function

obj.adjbod – adjacent bodies. This is a tuple (body1, body2) of BODY objects for ‘CONTACT’ and ‘RIGLNK’ or a single BODY object otherwise.

obj.matlab - surface material label for constraints of kind ‘CONTACT’, or a None object otherwise.

obj.spair - pairing of surfaces (surf1, surf2) for contact constraints or None object otherwise. The tuple (surf1, surf2) corresponds to the surface identifiers for the (body1, body2) body pairing returned by obj.adjbod