MechanicalContact

class MechanicalContact

set_persist(flag: bool) → None.

Set the contact persistence flag.

activated() → bool.

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

is_energy(energy_name: str) → bool.

Query the existence of a contact model energy.

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.

has_prop(property_name: str) → bool.

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

group([slot: int]) → str.

Get the contact group name in a given slot.

energies() → dict {str: float}.

Get the energy partitions as a dictionary.

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.

persist() → bool.

Get the contact persistence flag.

shear() → vec.

Get the contact shear direction (vector).

offset_y() → float.

Get the y-component of the contact offset.

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.

pos_y() → float.

Get the y-component of the contact position.

moment1_local() → vec.

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

pos_z() → float.

Get the z-component of the contact position.

pos_x() → float.

Get the x-component of the contact position.

moment2_global_z() → float.

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

force_global_z() → float.

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

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.

end1() → any.

Get the object at the first end of this contact.

end2() → any.

Get the object at the second end of this contact.

energy(energy_name: str) → float.

Get the current value of an energy partition.

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

Set the contact extra data in the given slot.

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

Set the property inheritance.

prop(property_name: str) → any.

Get a contact model property.

props() → dict {str: any}.

Get the contact model properties as a dictionary.

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

groups() → tuple of strings.

Get a tuple of group names assigned to this contact.

offset() → vec.

Get the contact offset (vector).

active() → bool.

Get the contact activity state.

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.

set_model([model_name: str]) → None.

Set the contact model for this contact.

force_normal() → float.

Get the contact signed magnitude of the normal force.

force_global() → vec.

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

extra(slot: int) → any.

Get the contact extra data in the given slot.

pos() → vec.

Get the contact position (vector).

activate(flag: bool) → None.

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

force_local_y() → float.

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

force_local_x() → float.

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

moment1_local_z() → float.

Get the z-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_x() → float.

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

fid() → int.

Get the contact fracture ID.

moment2_local() → vec.

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

gap() → float.

Get the contact gap.

moment1_global() → vec.

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

inhibit() → bool.

Get the contact inhibit flag.

shear_y() → float.

Get the y-component of the contact shear direction.

shear_x() → float.

Get the x-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).

id() → int.

Get the contact id.

moment2_global() → vec.

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

force_local() → vec.

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

valid() → bool.

Returns True if this contact is live.

offset_x() → float.

Get the x-component of the contact offset.

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

Set the contact group name in a given slot.

offset_z() → float.

Get the z-component of the contact offset.

moment2_global_y() → float.

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

moment2_global_x() → float.

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

to_local(value: vec) → vec.

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

normal() → vec.

Get the contact unit normal (vector).

in_group(group_name: str) → bool.

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

set_inhibit(flag: bool) → None.

Set the contact inhibit flag.

force_shear() → float.

Get the contact magnitude of the shear force.

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

Set a contact model property.

inherit(property_name: str) → bool.

Get the property inheritance.

model() → str.

Get the contact model name.