DFN

class itasca.dfn.DFN

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

center_density(lower=domain lower bound, upper=domain upper bound) → float.

Get the fracture center density. The fracture center density is defined as the {P20 value in 2D; P30 value in 3D} as measured in the specified region. {P20 in 2D; P30 in 3D} is the number of fracture centers in the specified region per unit area (volume).

clone_fracture(Fracture object) → Fracture object.

Clone the fracture, creating a new one in the dfn. The fracturecan come from any dfn.

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

Get a tuple of contacts associated with the fractures in this dfn. 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.

create_fracture(pos=origin, size=0, dip=0, dipdir=0 (3D ONLY), id=0, vertices=array) → Fracture object.

Create a fracture and addit to this dfn. In 3D a disk shaped fracture can be created where size is the fracture diameter, pos is the center of the fracture and dip/dipdir and the dip and dip direction in degrees, respectively.In 2D, a line segement fracture can be created where size is the fracture length, pos is the center and dip is the fracture dip in degrees. Otherwise one may specify a number of verticesfor {2 in 2D; 3 or more in 3D} that delineate the fracture vertices.

delete() → None.

Delete this DFN.

density(lower=domain lower bound, upper=domain upper bound) → float.

Get the fracture mass density. The fracture mass density is defined as the {P21 value in 2D; P32 value in 3D} as measured in the specified region. {P21 in 2D; P32 in 3D} is the cumulated fracture length (surface) in the specified region per unit area (volume).

dominance() → int.

Get the dfn dominance.

fracture_count() → int.

Get the number of fractures in this dfn.

fracture_near(point: vec, radius=0.0) → Fracture object.

Find the closest fracture to a point. If the optional keyword argument radius is non-zero, only search within this radius.

fractures() → Fracture iterator object.

Get a fracture iterator object.

fractures_inbox(lower_bound: vec, upper_bound: vec, intersect=True) → Tuple of fracture objects.

Get a tuple of fractures with extents intersecting a box. The extent is the axis-aligned bounding box of the fracture. The if the optional keyword argument intersect is False only fractures entirely falling within the box are returned. Only fractures belonging to this dfn are are searched.

id() → int.

Get the dfn id.

name() → string.

Get the dfn name.

p10(pt1=origin, pt2=origin) → float.

Get the P10, or the fracture density per unit length, along the line from pt1 to pt2.

percolation(lower=domain lower bound, upper=domain upper bound) → float.

Get the fracture percolation. The fracture percolation is measured in the region and is defined as {the sum of the squared fracture lengths per unit area in 2D; the sum of pi^2 (area/pi)^(1.5) per unit volume, where area is the fracture area in 3D}.

set_dominance(value: int) → None.

Set the dfn dominance.

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

Set a surface property of all fractures of this dfn.

template() → DFN Template object.

Get the template used to create this dfn.

valid() → bool.

Returns True if this dfn is live.