Node
- class itasca.interface.node.Node
Objects of this type should not be created (instantiated) directly in Python. Use the module functions that return instances of this type.
- area() -> float. (3D only)
Get the effective area of the interface node.
- length() -> float. (2D only)
Get the effective length of the interface node.
- disp(i: int) vec or float.
Get the displacement vector for the interface node. Returns a vector, unless an optional component argument i is supplied, in which case it returns the component value.
- disp_shear() vec or float.
Get the shear displacement vector for the interface node. Returns a vector, unless an optional component argument i is supplied, in which case it returns the component value.
- disp_shear_set(v: vec) None.
Set the shear displacement vector for the interface node.
- disp_shear_x() float.
Get the x-component of the shear displacement vector for the interface node.
- disp_shear_x_set(f: float) None.
Set the shear displacement vector x-component for the interface node.
- disp_shear_y() float.
Get the y-component of the shear displacement vector for the interface node.
- disp_shear_y_set(f: float) None.
Set the shear displacement vector y-component for the interface node.
- disp_shear_z() -> float. (3D only)
Get the z-component of the shear displacement vector for the interface node.
- disp_shear_z_set(f: float) -> None. (3D only)
Set the shear displacement vector z-component for the interface node.
- extra(slot: int) any.
Get the element extra data in the given slot.
- group([slot: str or int]) str.
Get the element 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 element. 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 element is part of. The keys of the dictionary are the slot names and the values are the group names.
- has_prop(property_name: str) bool.
Returns True if the element has the given surface property.
- id() int.
Get the element id.
- in_group(group_name: str or int[, slot: str or int]) bool.
Test if the element is part of a given group. If the optional argument slot is given, only that slot is searched. Otherwise, all group slots are searched.
- normal() vec.
Get the normal vector for the interface node, which is an area (in 3D) or length (in 2D) weighted average of the interface elements it is connected to. Returns a vector.
- normal_x() float.
Get the x-component for the interface normal.
- normal_y() float.
Get the y-component for the interface normal.
- normal_z() -> float. (3D only)
Get the z-component for the interface normal.
- penetration(i: int) float.
Get interface node penetration with the contacting zone face (only valid after cycling). A value <= 0 is returned if there is no contact.
- pos() vec.
Get the position vector for the interface node.
- pos_set(v: vec) None.
Set the position vector for the interface node.
- pos_x() float.
Get the the x-component of the position vector for the interface node.
- pos_x_set(f: float) None.
Set the x-component of the position vector for the interface node.
- pos_y() float.
Get the the y-component of the position vector for the interface node.
- pos_y_set(f: float) None.
Set the y-component of the position vector for the interface node.
- pos_z() -> float. (3D only)
Get the the z-component of the position vector for the interface node.
- pos_z_set(f: float) -> None. (3D only)
Set the z-component of the position vector for the interface node.
- pp() float.
Get the pore pressure of the node (only valid after cycling).
- prop(string name) value v.
Get property name of this interface node.
- prop_set(string name, value v) None.
Set property name of this interface node to value v.
- props() dict {str: any}.
Get a dictionary of all the surface properties of this element.
- set_extra(slot: int, value: any) None.
Set the element extra data in the given slot.
- set_group(group_name: str or int[, slot: str or int]) None.
Set the element group name in a given slot.
- set_prop(property_name: str, value: any) None.
Set a surface property of this element.
- slip() int.
Get the slip status (0-2) of the interface node: 0 is for shear-now; 1 is for shear-past; and 2 is for no shear failure now or in the past.
- slip_set(i: int) None.
Set the slip status (0-2) of the interface node: 0 is for shear-now; 1 is for shear-past; and 2 is for no shear failure now or in the past.
- stress_normal() float.
Get normal stress at the node.
- stress_shear() vec.
Get the shear stress vector for the interface node.
- stress_shear_set(v: vec) None.
Get the shear stress vector for the interface node.
- stress_shear_x() float.
Get the x-component of the shear stress vector for the interface node.
- stress_shear_x_set(f: float) None.
Set the x-component of the shear stress vector for the interface node.
- stress_shear_y() float.
Get the y-component of the shear stress vector for the interface node.
- stress_shear_y_set(f: float) None.
Set the y-component of the shear stress vector for the interface node.
- stress_shear_z() -> float. (3D only)
Get the z-component of the shear stress vector for the interface node.
- stress_shear_z_set(f: float) -> None. (3D only)
Set the z-component of the shear stress vector for the interface node.
- tol() float.
Get the interface node contact tolerance, a dimensionless measure of how close a face has to be to register a contact.
- tol_set(f: float) None.
Set the interface node contact tolerance, a dimensionless measure of how close a face has to be to register a contact.
- valid() bool.
Returns True if this element is live.
- vel() vec.
Get the velocity vector for the interface node.
- vel_set(vec) None.
Set the velocity vector for the interface node.
- vel_x() float.
Get x-component of the velocity vector for the interface node.
- vel_x_set(float) None.
Set x-component of the velocity vector for the interface node.
- vel_y() float.
Get y-component of the velocity vector for the interface node.
- vel_y_set(float) None.
Set y-component of the velocity vector for the interface node.
- vel_z() -> float. (3D only)
Get z-component of the velocity vector for the interface node.
- vel_z_set(float) -> None. (3D only)
Set z-component of the velocity vector for the interface node.
Was this helpful? ... | Itasca Software © 2024, Itasca | Updated: Aug 13, 2024 |