struct.link.model.force

Syntax

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

Get the current force in 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.

The force is calculated by the 1-D force-displacement model in an incremental fashion from the incremental relative displacement of the link target and the host node (target minus node). See the struct.link.model.disp function.

Returns:

m - a 6×1 (3×1 in 2D) matrix representing the current force seen by each 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)