ThermalPebble

class itasca.clump.thermal.pebble.ThermalPebble

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

clump() → Thermal clump object.

Get the thermal clump corresponding to this pebble.

contact_count(all=False, type=None) → int.

Get the number of contacts associated with this thermal pebble. If the optional keyword argument type is given, the count is limited to the contact types specified. The optional type keyword argument should be a Python type object (one of: itasca.BallBallThermalContact, itasca.BallPebbleThermalContact, itasca.PebblePebbleThermalContact, itasca.BallFacetThermalContact or itasca.PebbleFacetThermalContact). If the optional keyword argument all is True the count includes virtual contacts.

contacts([piece, ]all=False, type=None) → tuple of Contact objects.

Get a tuple of contacts associated with this thermal pebble. An optional argument can be included which is a piece object (a thermal ball, a thermal pebble or a thermal facet). If the optional keyword argument type is given, the returned list is limited to the contact types specified. The type keyword argument should be a Python type object (one of: itasca.BallBallThermalContact, itasca.BallPebbleThermalContact, itasca.PebblePebbleThermalContact, itasca.BallFacetThermalContact or itasca.PebbleFacetThermalContact). If the (optional) keyword argument all is True the returned list includes virtual contacts.

extra(slot: int) → any.

Get the thermal pebble extra data in the given slot.

group([slot: int]) → str.

Get the thermal pebble group name in a given slot.

group_remove(group_name: str) → int.

Remove from the given group from the thermal 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 thermal pebble.

has_prop(property_name: str) → bool.

Returns True if the thermal pebble has the given surface property.

id() → int.

Get the thermal pebble id.

in_group(group_name: str) → bool.

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

pebble() → Pebble object.

Get the pebble corresponding to this thermal pebble.

pos() → vec.

Get the thermal pebble location (vector).

pos_x() → float.

Get the x-component of the thermal pebble location.

pos_y() → float.

Get the y-component of the thermal pebble location.

prop(property_name: str) → any.

Get a surface property value of this thermal pebble.

props() → dict {str: any}.

Get a dictionary of all the surface properties of this thermal pebble.

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

Set the thermal pebble extra data in the given slot.

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

Set the thermal pebble group name in a given slot.

set_pos(value: vec) → None.

Set the thermal pebble location (vector).

set_pos_x(value: float) → None.

Set the x-component of the thermal pebble location.

set_pos_y(value: float) → None.

Set the y-component of the thermal pebble location.

set_prop(property_name: str, value: any) → None.

Set a surface property of this thermal pebble.

valid() → bool.

Returns True if this thermal pebble is live.