MeshPoint

class itasca.mpoint.node.MeshPoint

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

extra(slot: int) → any.

Get the mesh point extra data in the given slot.

force_unbal() → vec.

Get the mesh point mesh point unbalance force (vector).

force_unbal_x() → float.

Get the x-component of the mesh point mesh point unbalance force.

force_unbal_y() → float.

Get the y-component of the mesh point mesh point unbalance force.

force_unbal_z() → float.

Get the z-component of the mesh point mesh point unbalance force.

grav_mass() → float.

Get the mesh point gravitational mass.

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

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

id() → int.

Get the mesh point id.

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

Test if the mesh point 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 mesh point index.

pos() → vec.

Get the mesh point mesh point position (vector).

pos_x() → float.

Get the x-component of the mesh point mesh point position.

pos_y() → float.

Get the y-component of the mesh point mesh point position.

pos_z() → float.

Get the z-component of the mesh point mesh point position.

radius() → float.

Get the mesh point radius.

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

Set the mesh point extra data in the given slot.

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

Set the mesh point group name in a given slot.

valid() → bool.

Returns True if this mesh point is live.

velocity() → vec.

Get the mesh point mesh point velocity (vector).

velocity_x() → float.

Get the x-component of the mesh point mesh point velocity.

velocity_y() → float.

Get the y-component of the mesh point mesh point velocity.

velocity_z() → float.

Get the z-component of the mesh point mesh point velocity.