CFDClump

class itasca.clump.cfd.CFDClump

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

clump() → Clump object.

Get the clump corresponding to this CFD clump.

elements() → tuple of CFD element objects.

Get a tuple of CFD elements associated with a CFD clump.

extra(slot: int) → any.

Get the CFD clump extra data in the given slot.

force() → vec.

Get the CFD clump fluid force (vector).

force_x() → float.

Get the x-component of the CFD clump fluid force.

force_y() → float.

Get the y-component of the CFD clump fluid force.

force_z() → float.

Get the z-component of the CFD clump fluid force.

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

Get the CFD clump group name in a given slot.

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

Remove from the given group from the CFD clump. 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 clump.

id() → int.

Get the CFD clump id.

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

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

pebbles() → CFD pebble iterator object.

Get the CFD pebbles of this CCFD clump.

pos() → vec.

Get the CFD clump location (vector).

pos_x() → float.

Get the x-component of the CFD clump location.

pos_y() → float.

Get the y-component of the CFD clump location.

pos_z() → float.

Get the z-component of the CFD clump location.

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

Set the CFD clump extra data in the given slot.

set_force(value: vec) → None.

Set the CFD clump fluid force (vector).

set_force_x(value: float) → None.

Set the x-component of the CFD clump fluid force.

set_force_y(value: float) → None.

Set the y-component of the CFD clump fluid force.

set_force_z(value: float) → None.

Set the z-component of the CFD clump fluid force.

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

Set the CFD clump group name in a given slot.

set_pos(value: vec) → None.

Set the CFD clump location (vector).

set_pos_x(value: float) → None.

Set the x-component of the CFD clump location.

set_pos_y(value: float) → None.

Set the y-component of the CFD clump location.

set_pos_z(value: float) → None.

Set the z-component of the CFD clump location.

valid() → bool.

Returns True if this CFD clump is live.