Zone

class itasca.flowplane.zone.Zone

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 area of the flow plane zone.

discharge() → vec.

Get the flowplane zone flowplane zone discharg (vector).

discharge_x() → float.

Get the x-component of the flowplane zone flowplane zone discharg.

discharge_y() → float.

Get the y-component of the flowplane zone flowplane zone discharg.

discharge_z() → float.

Get the z-component of the flowplane zone flowplane zone discharg.

extra(slot: int) → any.

Get the flowplane zone extra data in the given slot.

flowplane() → flowplane pointer.

Get the flow plane associated with a given flow plane zone.

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

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

id() → int.

Get the flowplane zone id.

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

Test if the flowplane zone 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 the index (offset) of a given flow plane zone.

pos() → vec.

Get the flowplane zone flowplane zone position (vector).

pos_x() → float.

Get the x-component of the flowplane zone flowplane zone position.

pos_y() → float.

Get the y-component of the flowplane zone flowplane zone position.

pos_z() → float.

Get the z-component of the flowplane zone flowplane zone position.

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

Set the flowplane zone extra data in the given slot.

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

Set the flowplane zone group name in a given slot.

valid() → bool.

Returns True if this flowplane zone is live.

velocity() → vec.

Get the flowplane zone flowplane zone veloclity (vector).

velocity_x() → float.

Get the x-component of the flowplane zone flowplane zone veloclity.

velocity_y() → float.

Get the y-component of the flowplane zone flowplane zone veloclity.

velocity_z() → float.

Get the z-component of the flowplane zone flowplane zone veloclity.

vertex(int) → vertex pointer.

Get a flow plane zone vertex.