Element
- class itasca.interface.element.Element
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 area of the interface element.
- length() -> float. (2D only)
Get the length of the interface element.
- 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.
- 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.
- join(i: int) Interface pointer.
Get the pointer to the adjacent interface element joined across edge i for 3D (i = 1,2,3) pr node i for 2D (i = 1,2).
- node(i: int) Node pointer.
Pointer to the node associated with the interface element where i=1,2,3 for 3D and i=1,2 for 2D.
- normal(i: int) normal vector or component.
Get the normal vector for the interface element. Returns a vector, unless an optional component argument i is supplied, in which case it returns the component value.
- 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.
- valid() bool.
Returns True if this element is live.
- vertex(i: int) Vertex pointer.
Pointer to the vertex associated with the interface element where i=1,2,3 for 3D and i=1,2 for 2D.
Was this helpful? ... | Itasca Software © 2024, Itasca | Updated: Aug 13, 2024 |