Fracture

class itasca.dfn.fracture.Fracture

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

aperture() → float.

Get the fracture aperture.

area() → float.

Get the fracture area.

contact_count(all=False, type=None) → int.

Get the number of contacts associated with this fracture. If the optional keyword argument type is given, the count is limited to the contact types specified. The optional type keyword argument should be a Python type object (one of: itasca.BallBallContact, itasca.BallPebbleContact, itasca.PebblePebbleContact, itasca.BallFacetContact or itasca.PebbleFacetContact). If the optional keyword argument all is True the count includes virtual contacts.

contacts(all=False, type=None) → tuple of Contact objects.

Get a tuple of contacts associated with this fracture. If the optional keyword argument type is given, the returned list is limited to the contact types specified. The type keyword argument should be a Python type object (one of: itasca.BallBallContact, itasca.BallPebbleContact, itasca.PebblePebbleContact, itasca.BallFacetContact or itasca.PebbleFacetContact). If the (optional) keyword argument all is True the returned list includes virtual contacts.

decimate(int) → tuple of vec.

Get a list of fracture vertex positions. If a disk shaped fracture then the last argument (default 20) is used to decimate the disk shape.

delete() → None.

Delete this fracture.

dfn() → DFN object.

Get the dfn to which this fracture belongs.

diameter() → float.

Get the fracture diameter.

dip() → float.

Get the fracture dip.

dipdir() → float.

Get the fracture dip direction.

extra(slot: int) → any.

Get the fracture extra data in the given slot.

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

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

Returns True if the fracture has the given surface property.

id() → int.

Get the fracture id.

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

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

intersections(DFN object) → tuple of Intersection objects.

Get the intersections with this fracture. An optional DFN object can be specified to limit the intersections to fractures belonging to that dfn.

intersects(Fracture object) → bool.

Get a boolean indicating the intersection status of the given fracture with this fracture.

isdisk() → bool.

Get the fracture disk status.

normal() → vec.

Get the fracture normal (vector).

normal_x() → float.

Get the x-component of the fracture normal.

normal_y() → float.

Get the y-component of the fracture normal.

normal_z() → float.

Get the z-component of the fracture normal.

point_near(value: vec) → vec.

Get the point on the fracture closest to the given point (vector).

pos() → vec.

Get the fracture location (vector).

pos_x() → float.

Get the x-component of the fracture location.

pos_y() → float.

Get the y-component of the fracture location.

pos_z() → float.

Get the z-component of the fracture location.

prop(property_name: str) → any.

Get a surface property value of this fracture.

props() → dict {str: any}.

Get a dictionary of all the surface properties of this fracture.

set_aperture(value: float) → None.

Set the fracture aperture.

set_area(value: float) → None.

Set the fracture area.

set_diameter(value: float) → None.

Set the fracture diameter.

set_dip(value: float) → None.

Set the fracture dip.

set_dipdir(value: float) → None.

Set the fracture dip direction.

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

Set the fracture extra data in the given slot.

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

Set the fracture group name in a given slot.

set_normal(value: vec) → None.

Set the fracture normal (vector).

set_normal_x(value: float) → None.

Set the x-component of the fracture normal.

set_normal_y(value: float) → None.

Set the y-component of the fracture normal.

set_normal_z(value: float) → None.

Set the z-component of the fracture normal.

set_pos(value: vec) → None.

Set the fracture location (vector).

set_pos_x(value: float) → None.

Set the x-component of the fracture location.

set_pos_y(value: float) → None.

Set the y-component of the fracture location.

set_pos_z(value: float) → None.

Set the z-component of the fracture location.

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

Set a surface property of this fracture.

valid() → bool.

Returns True if this fracture is live.

vertices() → tuple of Vertex objects.

Get the vertices of this fracture.