Common FISH Index

Below is a listing of the FISH functions that are general to all Itasca codes.

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

Mechanical process FISH functions

mech.active	Get the status of mechanical calculations in the current cycle.
mech.cycle	Get the current step/cycle number.
mech.energy(STR)	Get a mechanical process energy.
mech.safety.factor	Get the factor of safety.
mech.solve(STR)	Get the current value of a solve limit.
mech.step	Get the current step/cycle number.
mech.time.total	Get the accumulated age.
mech.timestep	Get the mechanical timestep.
mech.timestep.given	Get the given timestep.
mech.timestep.max	Get the maximum allowed timestep.

Brick FISH functions

brick.assemble(BR_PNT,VEC<,INT><,INT><,INT>)	Replicate a brick.
brick.delete(BR_PNT)	Delete a brick.
brick.find(INT)	Find a brick.
brick.id(BR_PNT)	Get the brick ID.
brick.list	Get the global brick list.
brick.maxid	Get the maximum brick ID.
brick.num	Get the number of bricks.
brick.typeid	Get the brick type number.

Data FISH functions

Discrete Fracture Network FISH functions

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.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.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.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.intersect.typeid	Get the fracture intersection type number.
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.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.typeid	Get the fracture type number.
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.vertexarray(FR_PNT)	Get an array of fracture vertices.

Domain FISH functions

domain.condition(STR)	Get/set the domain conditions.
domain.max(<INT>)	Get/set the upper domain corner.
domain.min(<INT>)	Get/set the lower domain corner.
domain.strain.rate(<INT,INT>)	Get/set the domain strain rate.
domain.tolerance	Get/set the domain remapping tolerance.

Fragment FISH functions

fragment.bodymap(FG_PNT<,INT>)	Get the bodies of a fragment.
fragment.bodynum(FG_PNT<,INT>)	Get the fragment body count.
fragment.catalog	Get the fragment catalog.
fragment.catalog.num(<flt>)	Get the fragment catalog number.
fragment.childmap(FG_PNT)	Get the children fragment IDs.
fragment.find(INT)	Find a fragment.
fragment.history(BODY_PNT)	Get the body fragment history.
fragment.id(FG_PNT)	Get the fragment ID.
fragment.index(BODY_PNT<,INT>)	Get the body fragment ID.
fragment.map(<INT>)	Get a map of fragments.
fragment.num(INT)	Get the fragment count.
fragment.parent(FG_PNT)	Get the parent fragment ID.
fragment.pos(FG_PNT<,INT>)	Get the fragment position.
fragment.pos.catalog(FG_PNT,INT<,INT>)	Get the fragment position at a state.
fragment.vol(FG_PNT<,int>)	Get the fragment volume.

Geometry FISH functions

geom.edge.create(GSET_PNT,INT/GN_PNT,INT/GN_PNT)	Create an edge.
geom.edge.delete(GSET_PNT,GE_PNT)	Delete an edge.
geom.edge.dir(GE_PNT<,INT>)	Get the edge direction.
geom.edge.extra(GE_PNT,INT)	Get/set edge extra variable.
geom.edge.find(GSET_PNT,INT)	Find an edge.
geom.edge.group(GE_PNT<,STR>)	Get/set edge groups.
geom.edge.group.remove(GE_PNT,STR)	Remove edge groups.
geom.edge.id(GE_PNT)	Get the edge ID.
geom.edge.isgroup(GE_PNT,STR<,STR>)	Query the existence of a group.
geom.edge.list(GSET_PNT)	Get the edge list of a geometry set.
geom.edge.near(GSET_PNT,VEC<,FLT>)	Find the closest edge to a point.
geom.edge.next.edge(GE_PNT,INT)	Get the edge connected to a node.
geom.edge.next.index(GE_PNT,INT)	Get the edge index connected to a node.
geom.edge.node(GE_PNT,INT)	Get an edge node.
geom.edge.node.pos(GE_PNT,INT<,INT>)	Get/set the node position.
geom.edge.pos(GE_PNT<,INT>)	Get the edge position.
geom.edge.remove(GSET_PNT,GE_PNT)	Delete an edge.
geom.edge.start.index(GE_PNT)	Index of the first polygon attached to an edge.
geom.edge.start.poly(GE_PNT)	Get the first polygon attached to an edge.
geom.edge.typeid	Get the edge type number.
geom.node.create(GSET_PNT,VEC)	Create a node.
geom.node.delete(GSET_PNT,GN_PNT)	Delete a node.
geom.node.extra(GN_PNT,INT)	Get/set node extra variable.
geom.node.find(GSET_PNT,INT)	Find a node.
geom.node.group(GN_PNT<,STR>)	Get/set node groups.
geom.node.group.remove(GN_PNT,STR)	Remove node groups.
geom.node.id(GN_PNT)	Get the node ID.
geom.node.isgroup(GN_PNT,STR<,STR>)	Query the existence of a group.
geom.node.list(GSET_PNT)	Get the node list of a geometry set.
geom.node.near(GSET_PNT,VEC<,FLT>)	Find the closest node to a point.
geom.node.pos(GN_PNT<,INT>)	Get/set the node position.
geom.node.remove(GSET_PNT,GN_PNT)	Delete a node.
geom.node.start.edge(GN_PNT)	Get the first edge connected to a node.
geom.node.start.index(GN_PNT)	Index of the first edge connected to a node.
geom.node.typeid	Get the node type number.
geom.poly.add.edge(GPOL_PNT,GE_PNT)	Add an edge to a polygon.
geom.poly.add.node(GSET_PNT,GPOL_PNT<,GN_PNT><,VEC><,INT>)	Add an edge via a node addition.
geom.poly.area(GPOL_PNT)	Get the polygon area.
geom.poly.check(GPOL_PNT)	Get the validity status.
geom.poly.close(GSET_PNT,GPOL_PNT)	Close a polygon.
geom.poly.create(GSET_PNT)	Create a polygon.
geom.poly.delete(GSET_PNT,GPOL_PNT)	Delete a polygon.
geom.poly.edge(GPOL_PNT,INT)	Get a polygon edge.
geom.poly.extra(GPOL_PNT,INT)	Get/set polygon extra variable.
geom.poly.find(GSET_PNT,INT)	Find a polygon.
geom.poly.group(GPOL_PNT<,STR>)	Get/set polygon groups.
geom.poly.group.remove(GPOL_PNT,STR)	Remove polygon groups.
geom.poly.id(GPOL_PNT)	Get the polygon ID.
geom.poly.isgroup(GPOL_PNT,STR<,STR>)	Query the existence of a group.
geom.poly.list(GSET_PNT)	Get the polygon list of a geometry set.
geom.poly.near(GSET_PNT,VEC<,FLT>)	Find the closest polygon to a point.
geom.poly.next.index(GPOL_PNT,INT)	Get the index of the next edge of a polygon.
geom.poly.next.poly(GPOL_PNT,INT)	Get the next polygon connected to an edge.
geom.poly.node(GPOL_PNT,INT)	Get a node.
geom.poly.normal(GPOL_PNT<,INT>)	Get the polygon normal.
geom.poly.pos(GPOL_PNT<,INT>)	Get the polygon position.
geom.poly.remove(GSET_PNT,GPOL_PNT)	Delete a polygon.
geom.poly.size(GPOL_PNT)	Get the number of edges.
geom.poly.typeid	Get the polygon type number.
geom.set.closest(GSET_PNT,VEC<,FLT>)	Get closest node coordinate vector from the position supplied .
geom.set.create(STR)	Creates a new geometry set with the provided name.
geom.set.delete(GSET_PNT)	Delete a geometry set.
geom.set.edge.maxid(GSET_PNT)	Get the maximum edge ID.
geom.set.edge.num(GSET_PNT)	Get the number of edges.
geom.set.find(INT/STR)	Find a geometry set.
geom.set.id(GSET_PNT)	Get the geometry set ID.
geom.set.list	Get the global geometry set list.
geom.set.maxid	Get the maximum geometry set ID.
geom.set.name(GSET_PNT)	Get the geometry set name.
geom.set.node.maxid(GSET_PNT)	Get the maximum node ID.
geom.set.node.num(GSET_PNT)	Get/set the number of nodes.
geom.set.num	Get the number of geometry sets.
geom.set.poly.maxid(GSET_PNT)	Get the maximum polygon ID.
geom.set.poly.num(GSET_PNT)	Get the number of polygons.
geom.set.remove(GSET_PNT)	Delete a geometry set.
geom.set.typeid	Get the geometry set type number.

Globals FISH functions

global.cycle	Get the cycle/step number.
global.deterministic	Get/set deterministic mode.
global.dim	Get the program dimensionality.
global.fos	Get the global factor of safety.
global.gravity(<INT>)	Get/set the gravity.
global.step	Get the cycle/step number.
global.threads	Get/set the number of threads used during calculations.
global.timestep	Get the global timestep.
global.title	Get/set the job title of the model.

Measure FISH functions

measure.coordination(MEAS_PNT)	Get the measurement coordination number.
measure.delete(MEAS_PNT)	Delete a measurement object.
measure.find(INT)	Find a measurement object.
measure.id(MEAS_PNT)	Get the measurement ID.
measure.list	Get the list of measurement objects.
measure.maxid	Get the maximum measurement ID.
measure.num	Get the number of measurement objects.
measure.porosity(MEAS_PNT)	Get the porosity.
measure.pos(MEAS_PNT<,INT>)	Get/set the position.
measure.radius(MEAS_PNT)	Get/set the radius of the measurement object.
measure.size(MEAS_PNT)	Get the cumulative size distribution.
measure.strain.rate(MEAS_PNT<,INT<,INT>>)	Get the strain rate tensor.
measure.stress(MEAS_PNT<,INT,INT>)	Get the stress tensor.
measure.typeid	Get the measurement type ID.

Range FISH functions

range.find(STR)	Find a named range.
range.isin(RAN_PNT,IND/PNT/VEC)	Determine range inclusion status.

Table FISH functions

table(INT/STR/TAB_PNT,FLT)	Get/set a table entry.
table.clear(INT/STR/TAB_PNT)	Clear a table.
table.create(INT/STR)	Create an empty table.
table.delete(INT/STR/TAB_PNT)	Delete a table.
table.find(INT/STR)	Find a table.
table.get(INT/STR)	Get a table.
table.id(INT/STR/TAB_PNT)	Get the table ID.
table.label(INT/STR/TAB_PNT)	Get/set the table label.
table.name(INT/STR/TAB_PNT)	Get the table name.
table.size(INT/STR/TAB_PNT)	Get the table size.
table.value(INT/STR/TAB_PNT,INT)	Get/set a table entry.
table.x(INT/STR/TAB_PNT,INT)	Get/set the x -value of a table entry.
table.y(INT/STR/TAB_PNT,INT)	Get/set the y -value of a table entry.