Flowplane
-
class
itasca.flowplane.
Flowplane
- 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 a flow plane.
-
contact
() → contact pointer. Get the flow plane associated with a contact.
-
extra
(slot: int) → any. Get the flowplane extra data in the given slot.
-
group
([slot: str or int]) → str. Get the flowplane 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. 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 is part of. The keys of the dictionary are the slot names and the values are the group names.
-
id
() → int. Get the flowplane id.
-
in_group
(group_name: str or int[, slot: str or int]) → bool. Test if the flowplane 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 the given flow plane.
-
local1
() → vec. Get the flowplane local 1 flowplane position (vector).
-
local1_x
() → float. Get the x-component of the flowplane local 1 flowplane position.
-
local1_y
() → float. Get the y-component of the flowplane local 1 flowplane position.
-
local1_z
() → float. Get the z-component of the flowplane local 1 flowplane position.
-
local2
() → vec. Get the flowplane local 2 flowplane position (vector).
-
local2_x
() → float. Get the x-component of the flowplane local 2 flowplane position.
-
local2_y
() → float. Get the y-component of the flowplane local 2 flowplane position.
-
local2_z
() → float. Get the z-component of the flowplane local 2 flowplane position.
-
pos
() → vec. Get the flowplane flowplan position (vector).
-
pos_x
() → float. Get the x-component of the flowplane flowplan position.
-
pos_y
() → float. Get the y-component of the flowplane flowplan position.
-
pos_z
() → float. Get the z-component of the flowplane flowplan position.
-
prop
(str) → float. Get a flow plane property.
-
set_extra
(slot: int, value: any) → None. Set the flowplane extra data in the given slot.
-
set_group
(group_name: str or int[, slot: str or int]) → None. Set the flowplane group name in a given slot.
-
set_prop
(str, float) → None. Set a flow plane property.
-
valid
() → bool. Returns True if this flowplane is live.
-
vertexlist
() → gridpoint list. Get the flow plane vertex list for a given flow plane.
-
zonelist
() → zone list. Get the flowplane zone list for a given flow plane.
-
Was this helpful? ... | PFC © 2021, Itasca | Updated: Feb 25, 2024 |