ThermalFacet

class itasca.wall.thermal.facet.ThermalFacet

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

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 facet extra data in the given slot.

facet() → Pebble object.

Get the pebble corresponding to this thermal pebble.

group([slot: int]) → str.

Get the thermal facet group name in a given slot.

group_remove(group_name: str) → int.

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

has_prop(property_name: str) → bool.

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

id() → int.

Get the thermal facet id.

in_group(group_name: str) → bool.

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

pos() → vec.

Get the thermal facet location (vector).

pos_x() → float.

Get the x-component of the thermal facet location.

pos_y() → float.

Get the y-component of the thermal facet location.

pos_z() → float.

Get the z-component of the thermal facet location.

prop(property_name: str) → any.

Get a surface property value of this thermal facet.

props() → dict {str: any}.

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

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

Set the thermal facet extra data in the given slot.

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

Set the thermal facet group name in a given slot.

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

Set a surface property of this thermal facet.

set_temp(value: float) → None.

Set the thermal facet temperature.

temp() → float.

Get the thermal facet temperature.

valid() → bool.

Returns True if this thermal facet is live.

wall() → Thermal clump object.

Get the thermal clump corresponding to this pebble.