CFDPebble

class itasca.clump.cfd.pebble.CFDPebble

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

clump() → CFD clump object.

Get the CFD clump corresponding to this CFD pebble.

extra(slot: int) → any.

Get the CFD pebble extra data in the given slot.

group([slot: int]) → str.

Get the CFD pebble group name in a given slot.

group_remove(group_name: str) → int.

Remove from the given group from the CFD pebble. One argument of type string, giving the group name, is required. The return value is an integer which is the first slot in which the group name was found or -1 if not found.

groups() → tuple of strings.

Get a tuple of group names assigned to this CFD pebble.

id() → int.

Get the CFD pebble id.

in_group(group_name: str) → bool.

Test if the CFD pebble is part of a given group. All group slots are searched.

pebble() → Pebble object.

Get the pebble corresponding to this CFD pebble.

pos() → vec.

Get the CFD pebble location (vector).

pos_x() → float.

Get the x-component of the CFD pebble location.

pos_y() → float.

Get the y-component of the CFD pebble location.

pos_z() → float.

Get the z-component of the CFD pebble location.

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

Set the CFD pebble extra data in the given slot.

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

Set the CFD pebble group name in a given slot.

set_pos(value: vec) → None.

Set the CFD pebble location (vector).

set_pos_x(value: float) → None.

Set the x-component of the CFD pebble location.

set_pos_y(value: float) → None.

Set the y-component of the CFD pebble location.

set_pos_z(value: float) → None.

Set the z-component of the CFD pebble location.

valid() → bool.

Returns True if this CFD pebble is live.