PebblePebbleThermalContact

class itasca.PebblePebbleThermalContact
Objects of this type should not be created (instantiated) directly in Python. Use the module functions that return instances of this type.
activate(flag: bool) → None.

Set the contact activated state. If a contact has been activated it is always active.

activated() → bool.

Get the contact activated state. If a contact has been activated it is always active.

active() → bool.

Get the contact activity state.

end1() → any.

Get the object at the first end of this contact.

end2() → any.

Get the object at the second end of this contact.

extra(slot: int) → any.

Get the contact extra data in the given slot.

gap() → float.

Get the contact gap.

group([slot: int]) → str.

Get the contact group name in a given slot.

group_remove(group_name: str) → int.

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

has_prop(property_name: str) → bool.

Query the existence of a contact model property. A single string argument is required.

id() → int.

Get the contact id.

in_group(group_name: str) → bool.

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

inhibit() → bool.

Get the contact inhibit flag.

method(method_name: str <, args: dict {str: any}>) → None.

Execute a contact model method. The first argument must be a string identifying a method that exists in the contact model assigned to the contact. The optional second argument should be a dictionary with string keys which give the contact model method arguments (the values associated with the string keys are the arguments).

model() → str.

Get the contact model name.

normal() → vec.

Get the contact unit normal (vector).

normal_x() → float.

Get the x-component of the contact unit normal.

normal_y() → float.

Get the y-component of the contact unit normal.

offset() → vec.

Get the contact offset (vector).

offset_x() → float.

Get the x-component of the contact offset.

offset_y() → float.

Get the y-component of the contact offset.

persist() → bool.

Get the contact persistence flag.

pos() → vec.

Get the contact position (vector).

pos_x() → float.

Get the x-component of the contact position.

pos_y() → float.

Get the y-component of the contact position.

power() → float.

Get the contact power.

prop(property_name: str) → any.

Get a contact model property.

props() → dict {str: any}.

Get the contact model properties as a dictionary.

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

Set the contact extra data in the given slot.

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

Set the contact group name in a given slot.

set_inhibit(flag: bool) → None.

Set the contact inhibit flag.

set_model([model_name: str]) → None.

Set the contact model for this contact.

set_persist(flag: bool) → None.

Set the contact persistence flag.

set_power(value: float) → None.

Set the contact power.

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

Set a contact model property.

shear() → vec.

Get the contact shear direction (vector).

shear_x() → float.

Get the x-component of the contact shear direction.

shear_y() → float.

Get the y-component of the contact shear direction.

valid() → bool.

Returns True if this contact is live.