BallFacetContact

class itasca.BallFacetContact

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.

bonded() bool.

Get the contact bonded flag.

branch() vec.

Get the contact branch vector in the global coordinate system (vector).

branch_x() float.

Get the x-component of the contact branch vector in the global coordinate system.

branch_y() float.

Get the y-component of the contact branch vector in the global coordinate system.

branch_z() float.

Get the z-component of the contact branch vector in the global coordinate system.

end1() any.

Get the object at the first end of this contact.

end2() any.

Get the object at the second end of this contact.

energies() dict {str: float}.

Get the energy partitions as a dictionary.

energy(energy_name: str) float.

Get the current value of an energy partition.

extra(slot: int) any.

Get the contact extra data in the given slot.

fid() int.

Get the contact fracture ID.

force_global() vec.

Get the contact force in the global coordinate system (vector).

force_global_x() float.

Get the x-component of the contact force in the global coordinate system.

force_global_y() float.

Get the y-component of the contact force in the global coordinate system.

force_global_z() float.

Get the z-component of the contact force in the global coordinate system.

force_local() vec.

Get the contact force in the local coordinate system (vector).

force_local_x() float.

Get the x-component of the contact force in the local coordinate system.

force_local_y() float.

Get the y-component of the contact force in the local coordinate system.

force_local_z() float.

Get the z-component of the contact force in the local coordinate system.

force_normal() float.

Get the contact signed magnitude of the normal force.

force_shear() float.

Get the contact magnitude of the shear force.

gap() float.

Get the contact gap.

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.

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 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.

inherit(property_name: str) bool.

Get the property inheritance.

inhibit() bool.

Get the contact inhibit flag.

is_energy(energy_name: str) bool.

Query the existence of a contact model energy.

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.

moment1_global() vec.

Get the contact moment acting on end1 in the global coordinate system (vector).

moment1_global_x() float.

Get the x-component of the contact moment acting on end1 in the global coordinate system.

moment1_global_y() float.

Get the y-component of the contact moment acting on end1 in the global coordinate system.

moment1_global_z() float.

Get the z-component of the contact moment acting on end1 in the global coordinate system.

moment1_local() vec.

Get the contact moment acting on end1 in the local coordinate system (vector).

moment1_local_x() float.

Get the x-component of the contact moment acting on end1 in the local coordinate system.

moment1_local_y() float.

Get the y-component of the contact moment acting on end1 in the local coordinate system.

moment1_local_z() float.

Get the z-component of the contact moment acting on end1 in the local coordinate system.

moment2_global() vec.

Get the contact moment acting on end2 in the global coordinate system (vector).

moment2_global_x() float.

Get the x-component of the contact moment acting on end2 in the global coordinate system.

moment2_global_y() float.

Get the y-component of the contact moment acting on end2 in the global coordinate system.

moment2_global_z() float.

Get the z-component of the contact moment acting on end2 in the global coordinate system.

moment2_local() vec.

Get the contact moment acting on end2 in the local coordinate system (vector).

moment2_local_x() float.

Get the x-component of the contact moment acting on end2 in the local coordinate system.

moment2_local_y() float.

Get the y-component of the contact moment acting on end2 in the local coordinate system.

moment2_local_z() float.

Get the z-component of the contact moment acting on end2 in the local coordinate system.

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.

normal_z() float.

Get the z-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.

offset_z() float.

Get the z-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.

pos_z() float.

Get the z-component of the contact position.

prop(property_name or index: str or int) any.

Get a contact model property.

prop_index(property_name: str) int.

Get a contact model property index.

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_force(value: vec) None.

Set the contact model force.

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

Set the contact group name in a given slot.

set_inherit(property_name: str, inherit_flag: bool) None.

Set the property inheritance.

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_prop(property_name or index: str or int, 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.

shear_z() float.

Get the z-component of the contact shear direction.

to_global(value: vec) vec.

Transform a vector from the local to the global coordinate system. (vector).

to_local(value: vec) vec.

Transform a vector from the global to the local coordinate system. (vector).

valid() bool.

Returns True if this contact is live.