ThermalClump

class itasca.clump.thermal.ThermalClump

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 thermal clump.

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

Get the number of contacts associated with this thermal clump. 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 clump. 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.

del_temp() → float.

Get the thermal clump temperature increment.

expansion() → float.

Get the thermal clump expansion coefficient.

extra(slot: int) → any.

Get the thermal clump extra data in the given slot.

fix() → bool.

Get the thermal clump fixity.

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

Get the thermal 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 thermal 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 thermal clump.

id() → int.

Get the thermal clump id.

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

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

pebbles() → Thermal pebble iterator object.

Get the thermal pebbles of this thermal clump.

pos() → vec.

Get the thermal clump location (vector).

pos_x() → float.

Get the x-component of the thermal clump location.

pos_y() → float.

Get the y-component of the thermal clump location.

pos_z() → float.

Get the z-component of the thermal clump location.

power_app() → float.

Get the thermal clump applied power.

power_unbal() → float.

Get the thermal clump unbalanced power.

set_del_temp(value: float) → None.

Set the thermal clump temperature increment.

set_expansion(value: float) → None.

Set the thermal clump expansion coefficient.

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

Set the thermal clump extra data in the given slot.

set_fix(value: bool) → None.

Set the thermal clump fixity.

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

Set the thermal clump group name in a given slot.

set_pos(value: vec) → None.

Set the thermal clump location (vector).

set_pos_x(value: float) → None.

Set the x-component of the thermal clump location.

set_pos_y(value: float) → None.

Set the y-component of the thermal clump location.

set_pos_z(value: float) → None.

Set the z-component of the thermal clump location.

set_power_app(value: float) → None.

Set the thermal clump applied power.

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

Set a surface property of all thermal pebbles.

set_specific_heat(value: float) → None.

Set the thermal clump specific heat.

set_temp(value: float) → None.

Set the thermal clump temperature.

specific_heat() → float.

Get the thermal clump specific heat.

temp() → float.

Get the thermal clump temperature.

valid() → bool.

Returns True if this thermal clump is live.