Cable

class itasca.sel.cable.Cable

Objects of this type should not be created (instantiated) directly in Python. Use the module functions that return instances of this type.

area() → float.

Get the cross-section area of a hybrid bolt.

collection() → float.

Get the collection ID for this hybrid bolt element.

dir() → vec.

Get the cable hybrid bolt direction (vector).

dir_x() → float.

Get the x-component of the cable hybrid bolt direction.

dir_y() → float.

Get the y-component of the cable hybrid bolt direction.

dir_z() → float.

Get the z-component of the cable hybrid bolt direction.

extra(slot: int) → any.

Get the cable extra data in the given slot.

force_axial() → float.

Get the axial force in the hybrid bolt element (tension negative).

force_thermal() → float.

Get the axial thermal force in the hybrid bolt element (tension negative).

group([slot: str or int]) → str.

Get the cable group name in a given slot.

group_remove(group_name: str or int[, slot: str or int]) → bool.

Remove from the given group from all group slots of the cable. One argument of type string, giving the group name, is required. The return value is a bool which is True if the group was removed from any slot, otherwise False.

groups() → {slot: group_name}.

Get a dictionary describing which groups this cable is part of. The keys of the dictionary are the slot names and the values are the group names.

grout_cohesion() → float.

Get the grout cohesion.

grout_friction() → float.

Get the grout internal friction angle in degrees.

grout_perimeter() → float.

Get the grout exposed perimeter.

grout_stiffness() → float.

Get the grout stiffness (units of force / displacement).

id() → int.

Get the cable id.

in_group(group_name: str or int[, slot: str or int]) → bool.

Test if the cable is part of a given group. If the optional argument slot is given, only that slot is searched. Otherwise, all group slots are searched.

index() → int.

Get the index (offset) on the hybrid bolt element.

length() → float.

Get the length of the hybrid bolt element.

matnum() → int.

Get the hybrid bolt material property number for this hybrid bolt element.

node(int) → nodeptr.

Get a node from a hybrid bolt, given a node number (1 first node; 2 = second node).

pos() → vec.

Get the cable hybrid bolt position (vector).

pos_x() → float.

Get the x-component of the cable hybrid bolt position.

pos_y() → float.

Get the y-component of the cable hybrid bolt position.

pos_z() → float.

Get the z-component of the cable hybrid bolt position.

rupture_tension() → float.

Get the limit axial strain for rupture in tension.

set_extra(slot: int, value: any) → None.

Set the cable extra data in the given slot.

set_group(group_name: str or int[, slot: str or int]) → None.

Set the cable group name in a given slot.

state() → string.

Get the failure state indicator for a hybrid bolt element (0 = elastic, 1 = tensile yield, 2 = compressive yield, 3 = axial rupture).

strain_axial() → float.

Get the axial strain of the hybrid bolt element (positive: tension; negative: compression).

stress_axial() → float.

Get the axial stress of the hybrid bolt element (positive: tension; negative: compression).

valid() → bool.

Returns True if this cable is live.

yield_compression() → float.

Get the compression yield strength of the hybrid bolt element.

yield_tension() → float.

et the tension yield strength of the hybrid bolt (units of force).

young() → float.

Get the Young’s modulus of the hybrid bolt.