Beam

class itasca.sel.beam.Beam

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 beam.

collection() → int.

Get the collection ID of a given beam.

dir() → vec.

Get the beam beam direction (vector).

dir_x() → float.

Get the x-component of the beam beam direction.

dir_y() → float.

Get the y-component of the beam beam direction.

dir_z() → float.

Get the z-component of the beam beam direction.

extra(slot: int) → any.

Get the beam extra data in the given slot.

force_axial() → float.

Get the axial force on the beam.

force_thermal() → float.

Get the themral force on a beam.

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

Get the beam 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 beam. 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 beam is part of. The keys of the dictionary are the slot names and the values are the group names.

id() → int.

Get the beam id.

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

Test if the beam 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 a beam index (offset).

length() → float.

Get the length of the beam element.

matnum() → int.

Get the material number for a beam element.

node(int) → node_ptr.

Get a node of a beam element.

normal_stiffness() → float.

Get the normal stiffness (force/displacement) of the interface between the beam element and the rock/soil.

normal_strength() → float.

Get the normal (tensile) strength of the interface between the beam element and the rock/soil. Units are force.

pos() → vec.

Get the beam beam position (vector).

pos_x() → float.

Get the x-component of the beam beam position.

pos_y() → float.

Get the y-component of the beam beam position.

pos_z() → float.

Get the z-component of the beam beam position.

set_area(float) → None.

Set the cross-section area of a beam.

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

Set the beam extra data in the given slot.

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

Set the beam group name in a given slot.

shear_cohesion() → float.

Get the cohesion at the interface of the beam element and the rock/soil.

shear_friction() → float.

Get the friction angle (in degrees) of the interface of the beam element and the soil/rock.

shear_stiffness() → float.

Get the shear stiffness (Force / displacement) at the interface between the beam element and the rock/soil.

state() → string.

Get the beam element state, by indicator.

strain_axial() → float.

Get the axial strain on the beam.

stress_axial() → float.

Get the axial stress on the beam.

thermalexp() → float.

Get the thermal expansion coefficient of a beam element.

valid() → bool.

Returns True if this beam is live.

young() → float.

Get the Young’s modulus of a beam element.