struct.link.model.compression

Syntax

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

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

Get/set the compressive yield force associated with the force-displacement model. Returns or assigns a 6×1 (3×1 in 2D) matrix representing the values in all degrees-of-freedom, or if the optional idof argument is specified, a single value in that degree-of-freedom.

The compressive yield force is a limit to how negative the force in the link can be (entered as a positive value). Note that compression is defined relative to the node-local coordinate system, and, thus, depending on the coordinate systems involved, the definition of compression and tension may not match those used by the element connected to the host node. See the struct.link.model.force function.

Returns:

m - a 6×1 (3×1 in 2D) matrix representing the values in all degrees-of-freedom, or a single value for a specific degree-of-freedom

Accepts:

m - a 6×1 (3×1 in 2D) matrix representing the values in all degrees-of-freedom, or a single value for a specific degree-of-freedom

Arguments:

p - a structural link pointer

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