Cable
- class itasca.structure.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 the cable element.
- component_id() int.
Get the Cable component id.
- connectivity(component: int) bool.
Get the index of the node with component-ID id in the element. A ValueError exception is raised if no node in that element matches.
- delete() None.
Delete this structural element.
- density() float.
Get the density of this structural element.
- extra(slot: int) any.
Get the Cable extra data in the given slot.
- force_axial() float.
Get the average axial force of the element (positive: tension; negative: compression).
- force_nodal() (vec3, vec3, vec3, vec3).
Get the generalized nodal force acting at each end. The translational and rotational components of node 1 are given first.
- 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_confining() (float, float).
Get the confining stress acting on the grout at each end. Negative value indicates compression. The stress acts in a plane perpendicular to the cable axis; effective confining stress is the average of the principal values in this plane.
- grout_dir() (vec3, vec3).
Get the direction vector in which cable is being loaded by the coupling spring for each end.
- grout_disp() (vec3, vec3).
Get displacement in grout (shear coupling spring) at each end ; positive/negative with respect to the average axial direction of cable.
- grout_friction() float.
Get the grout internal friction angle.
- grout_perimeter() float.
Get the grout exposed perimeter.
- grout_slip() (int, int).
Get the slip state of grout (shear coupling spring) at each end. Return value {0, 1, 2} denotes never slipped, now slipping, or slipped in the past, respectively.
- grout_stiffness() float.
Get the grout stiffness.
- grout_stress() (float, float).
Get stress in grout (shear coupling spring) at each end; positive/negative with respect to average axial direction of cable.
- id() int.
Get the Cable structural element 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.
- length() float.
Get the length of the cable element.
- local_system() Tens3.
Get local coordinate system of this element as a 3x3 tensor.
- mark() bool.
Get the mark flag on the structural element. The structural element logic may modify this flag during command processing and cycling.
- nodes() tuple of Structural element node objects.
Get a tuple containing the structural element nodes attached to this elemment.
- pos() vec3.
Get the position vector of the element, defined as the element centroid.
- set_area(float) None.
Set the cross-section area of the cable element.
- set_density(float) None.
Set the density of this structural element.
- 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.
- set_grout_cohesion(float) None.
Set the grout cohesion.
- set_grout_friction(float) None.
Set the grout internal friction angle.
- set_grout_perimeter(perimeter: float) None.
Set the grout exposed perimeter.
- set_grout_stiffness(float) None.
Set the grout stiffness.
- set_mark(bool) None.
Set the mark flag on the structural element. The structural element logic may modify this flag during command processing and cycling.
- set_slide(bool) None.
Set the boolean flag of the large-strain sliding. If True, slide is on; if False, slide is off.
- set_slide_tol(bool) None.
Set the large-strain sliding tolerance of the cable element.
- set_thermal_expansion(float) None.
Set the thermal-expansion coefficient for the structural element.
- set_yield_compression(float) float.
Set the compression yield strength of the cable element.
- set_yield_tension(float) None.
Set the tension yield strength of the cable element.
- set_young(float) None.
Set the Youngs modulus of the cable element.
- slide() bool.
Get the boolean flag of the large-strain sliding. If True, slide is on; if False, slide is off.
- slide_tol() float.
Get the large-strain sliding tolerance of the cable element.
- state_compression() int.
Get the compression yield state of the cable element. The return value {0, 1, 2} denotes never yielded, now yielding, or yielded in the past, respectively.
- state_tension() int.
Get the tension yield state of cable element. The return value {0, 1, 2} denotes never yielded, now yielding, or yielded in the past, respectively.
- stress_axial() float.
Get the average axial stress of the cable element (positive: tension; negative: compression.
- thermal_expansion() float.
Get the thermal-expansion coefficient for the structural element.
- valid() bool.
Returns True if this Cable is live.
- volume() float.
Get the cable element volume, or the cross-sectional area times the length.
- yield_compression() float.
Get the compression yield strength of the cable element.
- yield_tension() float.
Get the tension yield strength of the cable element.
- young() float.
Get the Youngs modulus of the cable element.
Was this helpful? ... | Itasca Software © 2024, Itasca | Updated: Aug 13, 2024 |