itasca.structure.cablearray

Array interface for cable elements.

Functions

itasca.structure.cablearray.area() → array float{cable}.

Get a Numpy array of the cross-section area of the cable element.

itasca.structure.cablearray.component_id() → array int{cable}.

Get a NumPy array of the ID of cable component id.

itasca.structure.cablearray.density() → array double{cable}.

Get a NumPy array of the density of cable elements.

itasca.structure.cablearray.extra(slot: int) → array float{cable} or float{cable,3}.

Get the cable extra data in the given slot as an array. Extra variables accessed by array must be of type float or vec.

itasca.structure.cablearray.force_axial() → array float{cable}.

Get a Numpy array of the average axial force of the element (positive: tension; negative: compression).

itasca.structure.cablearray.force_nodal() → array float{cable,4,3}.

Get the generalized nodal force acting at each end. The translational and rotational components of node 1 are given first.

itasca.structure.cablearray.grout_cohesion() → array float{cable}.

Get a Numpy array of the grout cohesion.

itasca.structure.cablearray.grout_confining() → array float{cable,2}.

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.

itasca.structure.cablearray.grout_dir() → array float{cable,2,3}.

Get the direction vector in which cable is being loaded by the coupling spring for each end.

itasca.structure.cablearray.grout_disp() → array float{cable,2,3}.

Get displacement in grout (shear coupling spring) at each end ; positive/negative with respect to the average axial direction of cable.

itasca.structure.cablearray.grout_friction() → array float{cable}.

Get a Numpy array of the grout internal friction angle.

itasca.structure.cablearray.grout_perimeter() → array float{cable}.

Get a Numpy array of the grout exposed perimeter.

itasca.structure.cablearray.grout_slip() → array int{cable,2}.

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.

itasca.structure.cablearray.grout_stiffness() → array float{cable}.

Get a Numpy array of the grout stiffness.

itasca.structure.cablearray.grout_stress() → array float{cable,2}.

Get stress in grout (shear coupling spring) at each end; positive/negative with respect to average axial direction of cable.

itasca.structure.cablearray.id() → array int{cable}.

Get a NumPy array of the ID of cable element id.

itasca.structure.cablearray.in_group(group_name: str, slot=1) → array bool{cable}.

Return cable group membership as a Boolean array.

itasca.structure.cablearray.length() → array float{cable}.

Get a Numpy array of the length of the cable element.

itasca.structure.cablearray.local_system() → array double{cable,3,3}.

Get a NumPy array of the local coordinate system of cable elements.

itasca.structure.cablearray.mark() → array bool{cable}.

Get a NumPy array of the mark flag of cable elements.

itasca.structure.cablearray.pos() → array vec3{cable}.

Get a NumPy array of the current position of cable elements.

itasca.structure.cablearray.set_area(array float{cable}) → None.

Set the cross-section area of the cable element.

itasca.structure.cablearray.set_density(array double{cable}) → None.

Set the density of cable elements.

itasca.structure.cablearray.set_extra(slot: int, data: array float{cable} or float{cable, 3}) → None.

Set the cable extra data in the given slot with an array. Extra variables set by array must be of type float or vec.

itasca.structure.cablearray.set_group(membership: array bool{cable}, group_name: str, slot=1) → None.

Set cable group from an array. Where membership True set the corresponding cable to be a member of group group_name in the given slot.

itasca.structure.cablearray.set_grout_cohesion(array float{cable}) → None.

Set the grout cohesion.

itasca.structure.cablearray.set_grout_friction(array float{cable}) → None.

Set the grout internal friction angle.

itasca.structure.cablearray.set_grout_perimeter(array float{cable}) → None.

Set the grout exposed perimeter.

itasca.structure.cablearray.set_grout_stiffness(array float{cable}) → None.

Set the grout stiffness.

itasca.structure.cablearray.set_mark(array bool{cable}) → None.

Set the mark flag of cable elements.

itasca.structure.cablearray.set_slide(array bool{cable}) → None.

Set the boolean flag of the large-strain sliding. If True, slide is on; if False, slide is off.

itasca.structure.cablearray.set_slide_tol(array bool{cable}) → None.

Set the large-strain sliding tolerance of the cable element.

itasca.structure.cablearray.set_thermal_expansion(array double{cable}) → None.

Set the thermal expansion coefficient of cable elements.

itasca.structure.cablearray.set_yield_compression(array float{cable}) → None.

Set the compression yield strength of the cable element.

itasca.structure.cablearray.set_yield_tension(array float{cable}) → None.

Set the tension yield strength of the cable element.

itasca.structure.cablearray.set_young(array float{cable}) → None.

Set the Youngs modulus of the cable element.

itasca.structure.cablearray.slide() → bool.

Get the boolean flag of the large-strain sliding. If True, slide is on; if False, slide is off.

itasca.structure.cablearray.slide_tol() → array float{cable}.

Get a Numpy array of the large-strain sliding tolerance of the cable element.

itasca.structure.cablearray.state_compression() → array int{cable}.

Get a Numpy array of 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.

itasca.structure.cablearray.state_tension() → array int{cable}.

Get a Numpy array of the tension yield state of cable element. The return value {0, 1, 2} denotes never yielded, now yielding, or yielded in the past, respectively.

itasca.structure.cablearray.stress_axial() → array float{cable}.

Get a Numpy array of the average axial stress of the cable element (positive: tension; negative: compression.

itasca.structure.cablearray.thermal_expansion() → array double{cable}.

Get a NumPy array of the thermal expansion coefficient of cable elements.

itasca.structure.cablearray.type() → array string{cable}.

Get a NumPy array of the type name of cable elements.

itasca.structure.cablearray.volume() → array float{cable}.

Get a Numpy array of the cable element volume, or the cross-sectional area times the length.

itasca.structure.cablearray.yield_compression() → array float{cable}.

Get a Numpy array of the compression yield strength of the cable element.

itasca.structure.cablearray.yield_tension() → array float{cable}.

Get a Numpy array of the tension yield strength of the cable element.

itasca.structure.cablearray.young() → array float{cable}.

Get a Numpy array of the Youngs modulus of the cable element.