itasca.structure.Beam Class Methods

class itasca.structure.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 the element.

component_id() → int.

Get the Beam 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 Beam extra data in the given slot.

force() → (vec3, vec3).

Get the force at each end of the beam in the element local system.

force_nodal() → (vec3, vec3, vec3, vec3).

Get the generalized nodal force acting at each end in the global system. The end 1 translational and rotational components are given first.

group([slot: str]) → str.

Get the Beam group name in a given slot.

group_remove(group_name: str) → 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 structural element id.

in_group(group_name: str[, slot: str]) → 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.

length() → float.

Get the length of the beam element.

load() → vec3.

Get the uniform applied distributed load acting on the beam element in the local y- and z-directions. The x-component of the return value will always be 0.0.

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.

moi() → vec3.

Get the moment of inertia of the beam. This is defined as the second moment of inertia with respect to the x-, y-, and z-axes.

moment() → (vec3, vec3).

Get the moment at each end of the beam in the element local system.

moment_plastic() → float.

Get the plastic moment capacity in the beam.

nodes() → tuple of Structural element node objects.

Get a tuple containing the structural element nodes attached to this elemment.

poisson() → float.

Get the Poisson’s ratio of the beam element.

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

set_density(float) → None.

Set the density of this structural element.

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

Set the Beam extra data in the given slot.

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

Set the Beam group name in a given slot.

set_load(vec3) → None.

Set the uniform applied distributed load acting on the beam element in the local y- and z-directions. The x-component is ignored on assignment.

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_moi(vec3) → None.

Set the moment of inertia of the beam. This is defined as the second moment of inertia with respect to the x-, y-, and z-axes.

set_moment_plastic(float) → None.

Set the plastic moment capacity in the beam.

set_poisson(float) → None.

Set the Poisson’s ratio of the beam element.

set_thermal_expansion(float) → None.

Set the thermal expansion coefficient for the structural element.

set_young(float) → None.

Set the Young’s modulus of the beam element.

thermal_expansion() → float.

Get the thermal expansion coefficient for the structural element.

valid() → bool.

Returns True if this Beam is live.

volume() → None.

Get the beam element volume, equal to the cross-sectional area times the length.

ydir() → vec3.

Get the y-axis of the beam element local system.

young() → float.

Get the Young’s modulus of the beam element.