Node

class itasca.structure.node.Node

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

acc_global() → (translational: vec3, rotational: vec3).

Get the acceleration of structure node expressed in a global coordinate system.

acc_local() → (translational: vec3, rotational: vec3).

Get the acceleration of structure node expressed in a local coordinate system.

apply() → (translational: vec3, rotational: vec3).

Get the translational and rotational applied force of the structure node expressed in the global coordinate system.

apply_local() → bool.

Get whether the coordinate system in which generalized applied forces are expressed is a local system.

component_id() → int.

Get the Node component id.

convergence() → float.

Returns the gridpoint convergence value, defined as the ratio of the currenct local force ratio (given by the \(ratio\) method), to the target force ratio (\(ratio.target\)). A value of 1 or less is therefore considered “converged”.

damp_local() → float.

Get the local damping factor of the structure .

disp_global() → (translational: vec3, rotational: vec3).

Get the displacement of structure node expressed in a global system.

disp_local() → (translational: vec3, rotational: vec3).

Get the displacement of structure node expressed in a local system.

extra(slot: int) → any.

Get the Node extra data in the given slot.

fix() → tuple of int.

Get velocity-fixity flag expressed in the node-local system. Return values {1, 2, 3} denotes free, fixed, or slaved to target velocity, respectively. Slaved conditions arise from rigid attachment conditions; degrees-of-freedom that are slaved cannot be fixed.

fix_local() → bool.

Get the boolean flag for the local coordinate system fixity. True for fixed node-local system, False for free node-local system.

force_unbal_global() → (translational: vec3, rotational: vec3).

Get the unbalanced force of structure node expressed in a global system.

force_unbal_local() → (translational: vec3, rotational: vec3).

Get the unbalanced force of structure node expressed in a local system.

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

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

id() → int.

Get the Node structural element id.

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

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

links() → tuple of Link objects.

Get the link objects associated with this node. One link is returned for each side. Returns None if no link is found.

local_system() → tens3.

Get the local coordinate system of the structure node.

mark() → bool.

Get the mark flag. Note that the SEL logic may modify this flag during command processing, cycling, and plotting.

mass_added() → (translational: vec3, rotational: vec3).

Get the extra mass in addition to the inertial mass at each degree-of-freedom in the node-local system.

mass_local() → (translational: vec3, rotational: vec3).

Get the mass at each degree-of-freedom in the node-local system.

pos() → vec3.

Get the current position of this structural element node.

pos_reference() → vec3.

Get the reference position of this structural element node.

ratio() → float.

Get the local gridpoint mechanical convergence ratio. This is the ratio of unbalanced force to force applied to the node.

ratio_target() → float.

Get the target mechanical force ratio in the node. The default value is 1e-4. A local force ratio (see the \(ratio\) method) below this value is considered converged. See also the \(convergence\) method.

resultant() → tuple of floats (Mx, My, Mxy, Nx, Ny, Nxy).

Get stress resultants last calculated for the elements connected to this node. Note that the \(Q_x\) and \(Q_{y1}\) terms are not valid at nodes because they are constant over an element. Stress resultants are expressed in the node surface system; see the structure shell recover surface, structure geogrid recover surface, and structure liner recover surface commands.

set_apply(comp: int, force: float) → None.

Set a component of the translational and rotational applied force of the structure node expressed in the global coordinate system. Components 0, 1, and 2 are translational and 3,4 and 5 are rotational.

set_damp_local(float) → None.

Set the local damping factor of the structure .

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

Set the Node extra data in the given slot.

set_fix_local(bool) → None.

Set the boolean flag for the local coordinate system fixity. True for fixed node-local system, False for free node-local system.

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

Set the Node group name in a given slot.

set_mark(bool) → None.

Set the mark flag. Note that the SEL logic may modify this flag during command processing, cycling, and plotting.

set_mass_added(comp: int, mass: float) → (translational: vec3, rotational: vec3).

Get the extra mass in addition to the inertial mass at each degree-of-freedom in the node-local system.

set_ratio_target(ratio: float) → None.

Set the target mechanical force ratio in the node. The default value is 1e-4. A local force ratio (see the \(ratio\) method) below this value is considered converged. See also the \(convergence\) method.

set_surface_xdir(orientation: vec3) → bool.

Set the orientation of the surface system. surface system of the node such that the x-direction is aligned with the projection of the surface vector v onto the normal plane, which is defined by the z-direction. This operation can only be performed upon nodes that have a valid surface system (to ensure that the z-direction always corresponds with the average normal direction of at least one of the shell-type SELs using the node). A return value of \(True\) indicates success and \(False\) indicates failure.

set_temp_increment(dtemp: float) → None.

Set the the temperature increment that will be applied to the structural node in the next timestep, causing elements connected to it to see changes in stress due to thermal expansion. This value is cleared to zero after every step when thermal expansion stresses are applied.

stiff_local() → tuple of float.

Get the stiffness of structure node expressed in a local system. A length 6 tuple is returned. The translational stiffnesses are first followed by the rotational stiffnesses.

surface_system() → tens3.

Get the surface coordinate system of the structure node.

surface_valid() → bool.

Get a boolean flag for surface system validity; \(True\) if the surface system is valid, \(False\) if not. The surface system can be made valid by issuing a structure recovery command.

temp_increment() → float.

Get the the temperature increment that will be applied to the structural node in the next timestep, causing elements connected to it to see changes in stress due to thermal expansion. This value is cleared to zero after every step when thermal expansion stresses are applied.

valid() → bool.

Returns True if this Node is live.

vel_global() → (translational: vec3, rotational: vec3).

Get the velocity of a structure node expressed in a global system.

vel_local() → (translational: vec3, rotational: vec3).

Get the velocity of a structure node expressed in a local system.