Contact

class itasca.block.contact.Contact

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

area() → float.

Get surface area of a contact.

b1() → blockptr.

Get block 1 at a contact.

b2() → blockptr.

Get block 2 at a contact.

energy_fric() → float.

Get the frictional energy dissipated at a contact.

energy_strain_comp() → float.

Get the compressive strain energy for the contact.

energy_strain_shear() → float.

Get the shear strain energy at a contact.

energy_strain_tensile() → float.

Get the tensile strain energy at a contact.

energy_strain_total() → float.

Get the total strain energy at a contact.

extra(slot: int) → any.

Get the contact extra data in the given slot.

fb1() → blockptr.

Get face block 1 associated with the contact.

fb2() → blockptr.

Get face block 2 associated with the contact.

fid() → int.

Get the DFN fracture ID number at a contact.

flowplane() → flowplaneptr.

Get the flow plane associated with a contact.

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

Get the contact group name in a given slot.

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

Remove from the given group from all group slots of the contact. One argument of type string, giving the group name, is required. The return value is a bool which is True if the group was removed from any slot, otherwise False.

groups() → {slot: group_name}.

Get a dictionary describing which groups this contact is part of. The keys of the dictionary are the slot names and the values are the group names.

id() → int.

Get the contact id.

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

Test if the contact is part of a given group. If the optional argument slot is given, only that slot is searched. Otherwise, all group slots are searched.

index() → int.

Get the index (offset) for the block contact.

is_excavated() → bool.

Get excavated flag of the contact.

is_hidden() → bool.

Get hidden flag of the contact.

jset() → int.

Get the joint set ID for the contact.

normal() → vec.

Get the contact contact normal vector (vector).

normal_x() → float.

Get the x-component of the contact contact normal vector.

normal_y() → float.

Get the y-component of the contact contact normal vector.

normal_z() → float.

Get the z-component of the contact contact normal vector.

pos() → vec.

Get the contact contact position (vector).

pos_x() → float.

Get the x-component of the contact contact position.

pos_y() → float.

Get the y-component of the contact contact position.

pos_z() → float.

Get the z-component of the contact contact position.

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

Set the contact extra data in the given slot.

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

Set the contact group name in a given slot.

subcontacts() → tuple of subcontacts.

Get subcontact list of a block.

type() → int.

Get contact type.

valid() → bool.

Returns True if this contact is live.