Subcontact

class itasca.block.subcontact.Subcontact

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

apini() → float.

Get the initial mechanical aperture.

area() → float.

Get the subcontact area.

b1() → bptr.

Get block 1 of the subcontact.

b2() → bptr.

Get block 2 of the subcontact.

contact() → cptr.

Get the contact index to which this subcontact belongs.

disp_norm() → float.

Get the normal displacement of a subcontact.

disp_shear() → vec.

Get the subcontact contact shear displacement vector (vector).

disp_shear_x() → float.

Get the x-component of the subcontact contact shear displacement vector.

disp_shear_y() → float.

Get the y-component of the subcontact contact shear displacement vector.

disp_shear_z() → float.

Get the z-component of the subcontact contact shear displacement vector.

extra(slot: int) → any.

Get the subcontact extra data in the given slot.

face() → fptr.

Get the face of a vertex-face subcontact.

fid() → int.

Get the DFN fracture ID number at a subcontact.

force_norm() → float.

Get the normal force at a subcontact.

force_pp() → float.

Get the subcontact pore pressure force.

force_shear() → vec.

Get the subcontact contact shear force vector (vector).

force_shear_x() → float.

Get the x-component of the subcontact contact shear force vector.

force_shear_y() → float.

Get the y-component of the subcontact contact shear force vector.

force_shear_z() → float.

Get the z-component of the subcontact contact shear force vector.

fpZone() → float.

Get the flow zone associated with the subcontact.

gp() → gpptr.

Get the vertex for a vertex-face subcontact.

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

Get the subcontact 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 subcontact. 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 subcontact is part of. The keys of the dictionary are the slot names and the values are the group names.

id() → int.

Get the subcontact id.

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

Test if the subcontact 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 subcontact.

is_excavated() → bool.

Get the excavation status of the subcontact.

is_hidden() → bool.

Get the hidden indicator for the subcontact.

model() → str.

Get the assign joint constitutive model at a subcontact.

pos() → vec.

Get the subcontact subcontact position (vector).

pos_x() → float.

Get the x-component of the subcontact subcontact position.

pos_y() → float.

Get the y-component of the subcontact subcontact position.

pos_z() → float.

Get the z-component of the subcontact subcontact position.

pp() → float.

Get the subcontact pore pressure force.

prop(str) → float.

Get the assigned property values of subcontact models.

set_disp_norm() → float.

Set the normal displacement of a subcontact.

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

Set the subcontact extra data in the given slot.

set_force_norm() → float.

Set the normal force at a subcontact.

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

Set the subcontact group name in a given slot.

set_model(str) → None.

Set the assign joint constitutive model at a subcontact.

set_pp(float) → None.

Set the subcontact pore pressure force.

set_prop(str, float) → None.

Set the assigned property values of subcontact models.

set_shear_max() → float.

Set the maximum shear displacement magnitude at any point in the past.

set_state(int) → None.

Set the subcontact state indicator.

shear_max() → float.

Get the maximum shear displacement magnitude at any point in the past.

sratio() → float.

Get the ratio of shear force magnitude to normal force.

state() → int.

Get the subcontact state indicator.

stress_norm() → float.

Get the normal stress at the subcontact.

stress_shear() → float.

Get the shear stress magnitude.

type() → int.

Get the subcontact type.

valid() → bool.

Returns True if this subcontact is live.

vel_shear() → vec.

Get the subcontact contact shear velocity vector (vector).

vel_shear_x() → float.

Get the x-component of the subcontact contact shear velocity vector.

vel_shear_y() → float.

Get the y-component of the subcontact contact shear velocity vector.

vel_shear_z() → float.

Get the z-component of the subcontact contact shear velocity vector.