ThermalWall

class itasca.wall.thermal.ThermalWall

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

facets() → Thermal facet iterator object.

Get the thermal facets of this thermal wall.

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

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

id() → int.

Get the thermal wall id.

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

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

pos() → vec.

Get the thermal wall location (vector).

pos_x() → float.

Get the x-component of the thermal wall location.

pos_y() → float.

Get the y-component of the thermal wall location.

pos_z() → float.

Get the z-component of the thermal wall location.

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

Set the thermal wall extra data in the given slot.

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

Set the thermal wall group name in a given slot.

set_pos(value: vec) → None.

Set the thermal wall location (vector).

set_pos_x(value: float) → None.

Set the x-component of the thermal wall location.

set_pos_y(value: float) → None.

Set the y-component of the thermal wall location.

set_pos_z(value: float) → None.

Set the z-component of the thermal wall location.

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

Set a surface property of all thermal facets.

set_temp(value: float) → None.

Set the thermal wall facet temperatures of this wall.

valid() → bool.

Returns True if this thermal wall is live.

wall() → Wall object.

Get the wall corresponding to this thermal wall.