ThermalBall

class itasca.ball.thermal.ThermalBall

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

ball() → Ball object.

Get the ball corresponding to this thermal ball.

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

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

expansion() → float.

Get the thermal ball expansion coefficient.

extra(slot: int) → any.

Get the thermal ball extra data in the given slot.

fix() → bool.

Get the thermal ball fixity.

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

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

has_prop(property_name: str) → bool.

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

id() → int.

Get the thermal ball id.

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

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

pos() → vec.

Get the thermal ball location (vector).

pos_x() → float.

Get the x-component of the thermal ball location.

pos_y() → float.

Get the y-component of the thermal ball location.

pos_z() → float.

Get the z-component of the thermal ball location.

power_app() → float.

Get the thermal ball applied power.

power_unbal() → float.

Get the thermal ball unbalanced power.

prop(property_name: str) → any.

Get a surface property value of this thermal ball.

props() → dict {str: any}.

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

set_del_temp(value: float) → None.

Set the thermal ball temperature increment.

set_expansion(value: float) → None.

Set the thermal ball expansion coefficient.

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

Set the thermal ball extra data in the given slot.

set_fix(value: bool) → None.

Set the thermal ball fixity.

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

Set the thermal ball group name in a given slot.

set_pos(value: vec) → None.

Set the thermal ball location (vector).

set_pos_x(value: float) → None.

Set the x-component of the thermal ball location.

set_pos_y(value: float) → None.

Set the y-component of the thermal ball location.

set_pos_z(value: float) → None.

Set the z-component of the thermal ball location.

set_power_app(value: float) → None.

Set the thermal ball applied power.

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

Set a surface property of this thermal ball.

set_specific_heat(value: float) → None.

Set the thermal ball specific heat.

set_temp(value: float) → None.

Set the thermal ball temperature.

specific_heat() → float.

Get the thermal ball specific heat.

temp() → float.

Get the thermal ball temperature.

valid() → bool.

Returns True if this thermal ball is live.