struct.link.model.gap.neg

Syntax

m := struct.link.model.gap.neg(p<,idof>) := m

Get/set the negative (compressive) gap component of each 1-D force-displacement model. The function returns a 6×1 (3×1 in 2D) matrix with the values in all six degrees-of-freedom, or, if the optional idof argument is provided, the value in one specific degree-of-freedom.

This value will only affect force calculations if the gap-use flag is on; see the struct.link.model.gap function. The relative displacement is defined as the displacement of the link target minus the displacement of the link host node in the node-local coordinate system. See the struct.link.model.disp function.

Returns:

m - a 6×1 (3×1 in 2D) matrix representing the negative gap component of each 1-D force-displacement model, or a single value in a specific degree-of-freedom

Accepts:

m - a 6×1 (3×1 in 2D) matrix representing the negative gap component of each 1-D force-displacement model, or a single value in a specific degree-of-freedom

Arguments:

p - a structural link pointer

idof - an optional degree-of-freedom, from 1 to 6 (1 to 3 in 2D)