FISH Functions

The type specifiers used in the FISH function signatures are given in the “FISH Type Index” section.

DFN Utilities

dfn.contactmap(D_PNT<,INT>) Get active contacts associated with a DFN.
dfn.contactmap.all(D_PNT<,INT>) Get all contacts associated with a DFN.
dfn.create(<INT><,STR>) Create a DFN.
dfn.delete(D_PNT) Delete a DFN.
dfn.dominance(D_PNT) Get/set the DFN dominance.
dfn.extra(D_PNT<,INT>) Get/set a DFN extra variable.
dfn.find(INT/STR) Find a DFN.
dfn.fracturelist(D_PNT) Get the fracture list of the DFN.
dfn.fracturenum(D_PNT) Get the number of fractures.
dfn.group(D_PNT<,STR>) Get/set DFN groups.
dfn.group.remove(D_PNT,STR) Remove DFN groups.
dfn.id(D_PNT) Get the DFN ID.
dfn.isgroup(D_PNT,STR<,STR>) Indicate DFN group status.
dfn.list Get the global DFN list.
dfn.maxid Get the maximum DFN ID.
dfn.name(D_PNT) Get the DFN name.
dfn.num Get the number of DFNs.
dfn.prop(D_PNT,STR) Set a property of all fractures in a DFN.
dfn.template(D_PNT) Get the fracture template.
dfn.typeid Get the DFN type number.

Fracture Template Utilities

fracture.template.ddirmax(DT_PNT)(3D only) Get/set the maximum dip direction.
fracture.template.ddirmin(DT_PNT)(3D only) Get/set the minimum dip direction.
fracture.template.dipmax(DT_PNT) Get/set the maximum dip.
fracture.template.dipmin(DT_PNT) Get/set the minimum dip.
fracture.template.find(INT/STR) Find a DFN template.
fracture.template.id(DT_PNT) Get the DFN template ID.
fracture.template.list Get the DFN template list.
fracture.template.maxid Get the maximum DFN template ID.
fracture.template.name(DT_PNT) Get the DFN template name.
fracture.template.norientparam(DT_PNT) Get the number of orientation parameters.
fracture.template.nposparam(DT_PNT) Get the number of position parameters.
fracture.template.nsizeparam(DT_PNT) Get the number of size parameters.
fracture.template.num Get the number of DFN templates.
fracture.template.orientparam(DT_PNT,INT) Get/set an orientation parameter.
fracture.template.orienttype(DT_PNT) Get/set the DFN template orientation type name.
fracture.template.posparam(DT_PNT,INT) Get/set a position parameter.
fracture.template.postype(DT_PNT) Get/set the DFN template position type name.
fracture.template.sizemax(DT_PNT) Get/set the maximum size.
fracture.template.sizemin(DT_PNT) Get/set the minimum size.
fracture.template.sizeparam(DT_PNT,INT) Get/set a size parameter.
fracture.template.sizetype(DT_PNT) Get/set the DFN template size type name.
fracture.template.typeid Get the DFN template type number.

Fracture Utilities

fracture.aperture(FR_PNT) Get/set the fracture aperture.
fracture.area(FR_PNT)(3D only) Get/set the fracture area.
fracture.centerdensity(<VEC><,VEC><,D_PNT>) Get the fracture center density.
fracture.contactmap(FR_PNT<,INT>) Get active contacts associated with a fracture.
fracture.contactmap.all(FR_PNT<,INT>) Get all contacts associated with a fracture.
fracture.copy(FR_PNT<,D_PNT,INT>) Copy a fracture.
fracture.create(D_PNT,ARR_PNT<,INT>) Create a fracture.
fracture.ddir(FR_PNT)(3D only) Get/set the fracture dip direction.
fracture.delete(FR_PNT) Delete a fracture.
fracture.density(<VEC><,VEC><,D_PNT>) Get the fracture mass density.
fracture.dfn(FR_PNT) Get the fracture’s DFN.
fracture.diameter(FR_PNT)(3D only) Get/set the fracture diameter.
fracture.dip(FR_PNT) Get/set the fracture dip.
fracture.extra(FR_PNT<,INT>) Get/set a fracture extra variable.
fracture.find(INT) Find a fracture.
fracture.genpos(FR_PNT<,INT>) Get the fracture generation position.
fracture.gensize(FR_PNT) Get the fracture generation {length in 2D; diameter in 3D}.
fracture.geomp10(GSET_PNT<,D_PNT>) Get the P10 of edges.
fracture.geomp20(GSET_PNT<,D_PNT>)(3D only) Get the P20 of polygons.
fracture.geomp21(GSET_PNT<,D_PNT>)(3D only) Get the P21 of polygons.
fracture.geomtrace(GSET_PNT<,D_PNT>)(3D only) Get polygon average trace length.
fracture.gintersect(FR_PNT,GSET_PNT) Get the fracture/geometry intersection status.
fracture.group(FR_PNT<,STR>) Get/set fracture groups.
fracture.group.remove(FR_PNT,STR) Remove fracture groups.
fracture.id(FR_PNT) Get the fracture ID.
fracture.inbox(VEC,VEC<,D_PNT>) Get fractures intersecting or contained within a box.
fracture.interarray(FR_PNT<,D_PNT>) Get an array of fracture intersections.
fracture.intersect(FR_PNT,FR_PNT) Get the fracture/fracture intersection status.
fracture.isdisk(FR_PNT)(3D only) Get the fracture disk status.
fracture.isgroup(FR_PNT,STR<,INT>) Indicate fracture group status.
fracture.isprop(FR_PNT,STR) Query the existence of a property.
fracture.len(FR_PNT)(2D only) Get/set the fracture length.
fracture.list Get the global fracture list.
fracture.maxid Get the maximum fracture ID.
fracture.near(VEC<,FLT><,D_PNT>) Find the closest fracture to a point.
fracture.normal(FR_PNT<,INT>) Get/set the fracture normal.
fracture.num Get the total number of fractures.
fracture.p10(VEC,VEC<,D_PNT>) Get the P10 along a transect.
fracture.percolation(<VEC><,VEC><,D_PNT>) Get the fracture percolation.
fracture.pointnear(FR_PNT,VEC) Get the closest point on a fracture.
fracture.pos(FR_PNT<,INT>) Get/set the fracture position.
fracture.prop(FR_PNT,STR) Get/set a fracture property.
fracture.typeid Get the fracture type number.
fracture.vertexarray(FR_PNT) Get an array of fracture vertices.

Fracture Vertex Utilities

fracture.vertex.find(INT) Find a fracture vertex.
fracture.vertex.list Get the fracture vertex list.
fracture.vertex.maxid Get the maximum fracture vertex ID.
fracture.vertex.num Get the number of fracture vertices.
fracture.vertex.pos(FV_PNT<,INT>) Get the fracture vertex position.
fracture.vertex.typeid Get the fracture vertex type number.

Fracture Intersection Set Utilities

fracture.intersect.set.delete(FIS_PNT) Delete a fracture intersection set.
fracture.intersect.set.find(INT/STR) Find a fracture intersection set.
fracture.intersect.set.id(FIS_PNT) Get the fracture intersection set ID.
fracture.intersect.set.interlist(FIS_PNT) Get the fracture intersection list.
fracture.intersect.set.internum(FIS_PNT) Get the number of intersections in the set.
fracture.intersect.set.list Get the fracture intersection set list.
fracture.intersect.set.maxid Get the maximum fracture intersection set ID.
fracture.intersect.set.name(FIS_PNT) Get the fracture intersection set name.
fracture.intersect.set.num Get the number of fracture intersection sets.
fracture.intersect.set.path(FIS_PNT,FR_PNT,FR_PNT) Get the path between fractures.
fracture.intersect.set.typeid Get the fracture intersection set type number.

Fracture Intersection Utilities

fracture.intersect.end1(FI_PNT) Get the first fracture in an intersection.
fracture.intersect.end2(FI_PNT) Get the second intersecting object.
fracture.intersect.find(INT) Find a fracture intersection.
fracture.intersect.len(FI_PNT)(3D only) Get the intersection length.
fracture.intersect.list Get the fracture intersection list.
fracture.intersect.maxid Get the maximum fracture intersection ID.
fracture.intersect.npolylinept(FI_PNT)(3D only) Get the number of polyline points in an intersection.
fracture.intersect.num Get the number of fracture intersections.
fracture.intersect.polylinept(FI_PNT)(3D only) Get a polyline point position in an intersection.
fracture.intersect.pos1(FI_PNT<,INT>) Get the first fracture intersection end position.
fracture.intersect.pos2(FI_PNT<,INT>)(3D only) Get the second fracture intersection end position.
fracture.intersect.set(FI_PNT) Get the intersection set.
fracture.intersect.typeid Get the fracture intersection type number.