Index: Common FISH

Below is a listing (by group) of FISH functions associated with common commands/model objects as used by all Itasca codes.

Table 1: FISH Functions by Group
brick functions	global functions
data functions	measure functions
dfn & fracture functions	mech functions
domain functions	range functions
fragment functions	table functions
geometry functions

There are, in addition, a number of functions built into the FISH language. See the topic FISH Functions in the FISH Scripting Reference section for those.

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

brick functions

data functions

data.label.arrow(UDL_PNT)

data.label.create(VEC<,INT/STR>)

data.label.delete(UDL_PNT)

data.label.end(UDL_PNT)

data.label.find(INT/STR)

data.label.group(UDL_PNT<,STR/IND>)

data.label.group.remove(UDL_PNT,STR/IND<,STR/IND>)

data.label.head

data.label.isgroup(UDL_PNT,STR/IND<,STR/IND>)

data.label.list

data.label.maxid

data.label.name(UDL_PNT)

data.label.next(UDL_PNT)

data.label.pos(UDL_PNT)

data.label.text(UDL_PNT)

data.label.typeid

data.scalar.create(VEC)

data.scalar.delete(UDS_PNT)

data.scalar.extra(UDS_PNT<,INT>)

data.scalar.find(INT)

data.scalar.group(UDS_PNT<,STR/IND>)

data.scalar.group.remove(UDS_PNT,STR/IND<,STR/IND>)

data.scalar.head

data.scalar.id(UDS_PNT)

data.scalar.isgroup(UDS_PNT,STR/IND<,STR/IND>)

data.scalar.list

data.scalar.maxid

data.scalar.near(VEC<,FLT>)

data.scalar.next(UDS_PNT)

data.scalar.num

data.scalar.pos(UDS_PNT)

data.scalar.typeid

data.scalar.value(UDS_PNT)

data.tensor.create(VEC)

data.tensor.delete(UDT_PNT)

data.tensor.extra(UDT_PNT<,INT>)

data.tensor.find(INT)

data.tensor.group(UDT_PNT<,STR/IND>)

data.tensor.group.remove(UDT_PNT,STR/IND<,STR/IND>)

data.tensor.head

data.tensor.id(UDT_PNT)

data.tensor.isgroup(UDT_PNT,STR/IND<,STR/IND>)

data.tensor.list

data.tensor.maxid

data.tensor.near(VEC<,FLT>)

data.tensor.next(UDT_PNT)

data.tensor.num

data.tensor.pos(UDT_PNT)

data.tensor.typeid

data.tensor.value(UDT_PNT)

data.vector.create(VEC)

data.vector.ddir(UDV_PNT)(3D only)

data.vector.delete(UDV_PNT)

data.vector.dip(UDV_PNT)

data.vector.extra(UDV_PNT<,INT>)

data.vector.find(INT)

data.vector.group(UDV_PNT<,STR/IND>)

data.vector.group.remove(UDV_PNT,STR/IND<,STR/IND>)

data.vector.head

data.vector.id(UDV_PNT)

data.vector.isgroup(UDV_PNT,STR/IND<,STR/IND>)

data.vector.list

data.vector.maxid

data.vector.near(VEC<,FLT>)

data.vector.next(UDV_PNT)

data.vector.num

data.vector.pos(UDV_PNT)

data.vector.typeid

data.vector.value(UDV_PNT)

dfn & fracture functions

dfn.contact.list(D_PNT<,INT>)

dfn.contact.list.all(D_PNT<,INT>)

dfn.contactmap(D_PNT<,INT>)

dfn.contactmap.all(D_PNT<,INT>)

dfn.create(<INT><,STR>)

dfn.delete(D_PNT)

dfn.dominance(D_PNT)

dfn.extra(D_PNT<,INT>)

dfn.find(INT/STR)

dfn.fracturelist(D_PNT)

dfn.fracturenum(D_PNT)

dfn.group(D_PNT<,STR/IND>)

dfn.group.remove(D_PNT,STR/IND<,STR/IND>)

dfn.isgroup(D_PNT,STR/IND<,STR/IND>)

dfn.name(D_PNT)

dfn.prop(D_PNT,STR)

dfn.template(D_PNT)

fracture.aperture(FR_PNT)

fracture.area(FR_PNT)(3D only)

fracture.centerdensity(<VEC><,VEC><,D_PNT>)

fracture.contact.list(FR_PNT<,INT>)

fracture.contact.list.all(FR_PNT<,INT>)

fracture.contactmap(FR_PNT<,INT>)

fracture.contactmap.all(FR_PNT<,INT>)

fracture.copy(FR_PNT<,D_PNT,INT>)

fracture.create(D_PNT,ARR_PNT<,INT>)

fracture.ddir(FR_PNT)(3D only)

fracture.decimate(FR_PNT<,INT>)

fracture.delete(FR_PNT)

fracture.density(<VEC><,VEC><,D_PNT>)

fracture.dfn(FR_PNT)

fracture.diameter(FR_PNT)(3D only)

fracture.dip(FR_PNT)

fracture.extra(FR_PNT<,INT>)

fracture.find(INT)

fracture.from.contact(D_PNT,C_PNT)

fracture.genpos(FR_PNT)

fracture.gensize(FR_PNT)

fracture.geomp10(GSET_PNT<,D_PNT>)

fracture.geomp20(GSET_PNT<,D_PNT>)(3D only)

fracture.geomp21(GSET_PNT<,D_PNT>)(3D only)

fracture.geomtrace(GSET_PNT<,D_PNT>)(3D only)

fracture.gintersect(FR_PNT,GSET_PNT)

fracture.id(FR_PNT)

fracture.inbox(VEC,VEC<,D_PNT>)

fracture.interarray(FR_PNT<,D_PNT>)

fracture.intersect(FR_PNT,FR_PNT)

fracture.intersect.end1(FI_PNT)

fracture.intersect.end2(FI_PNT)

fracture.intersect.find(INT)

fracture.intersect.len(FI_PNT)(3D only)

fracture.intersect.list

fracture.intersect.maxid

fracture.intersect.npolylinept(FI_PNT)(3D only)

fracture.intersect.num

fracture.intersect.polylinept(FI_PNT,INT)(3D only)

fracture.intersect.pos1(FR_PNT)

fracture.intersect.pos2(FR_PNT)(3D only)

fracture.intersect.set(FI_PNT)

fracture.intersect.set.delete(FIS_PNT)

fracture.intersect.set.find(INT/STR)

fracture.intersect.set.id(FIS_PNT)

fracture.intersect.set.interlist(FIS_PNT)

fracture.intersect.set.internum(FIS_PNT)

fracture.intersect.set.list

fracture.intersect.set.maxid

fracture.intersect.set.name(FIS_PNT)

fracture.intersect.set.num

fracture.intersect.set.path(FIS_PNT,FR_PNT,FR_PNT)

fracture.intersect.set.typeid

fracture.intersect.typeid

fracture.isdisk(FR_PNT)(3D only)

fracture.isprop(FR_PNT,STR)

fracture.len(FR_PNT)(2D only)

fracture.near(VEC<,FLT><,D_PNT>)

fracture.normal(FR_PNT)

fracture.p10(VEC,VEC<,D_PNT>)

fracture.percolation(<VEC><,VEC><,INT><,D_PNT>)

fracture.pointnear(FR_PNT,VEC)

fracture.pos(FR_PNT)

fracture.prop(FR_PNT,STR)

fracture.template.ddirmax(DT_PNT)(3D only)

fracture.template.ddirmin(DT_PNT)(3D only)

fracture.template.dipmax(DT_PNT)

fracture.template.dipmin(DT_PNT)

fracture.template.find(INT/STR)

fracture.template.id(DT_PNT)

fracture.template.list

fracture.template.maxid

fracture.template.name(DT_PNT)

fracture.template.norientparam(DT_PNT)

fracture.template.nposparam(DT_PNT)

fracture.template.nsizeparam(DT_PNT)

fracture.template.num

fracture.template.orientparam(DT_PNT,INT)

fracture.template.orienttype(DT_PNT)

fracture.template.posparam(DT_PNT,INT)

fracture.template.postype(DT_PNT)

fracture.template.sizemax(DT_PNT)

fracture.template.sizemin(DT_PNT)

fracture.template.sizeparam(DT_PNT,INT)

fracture.template.sizetype(DT_PNT)

fracture.template.typeid

fracture.typeid

fracture.vertex.find(INT)

fracture.vertex.list

fracture.vertex.maxid

fracture.vertex.num

fracture.vertex.pos(FV_PNT)

fracture.vertex.typeid

fracture.vertexarray(FR_PNT)

fracture.vertexlist(FR_PNT)

domain functions

domain.condition(STR)

domain.strain.rate

fragment functions

fragment.bodylist(FG_PNT<,INT>)

fragment.bodymap(FG_PNT<,INT>)

fragment.bodynum(FG_PNT<,INT>)

fragment.catalog

fragment.catalog.num(<flt>)

fragment.childlist(FG_PNT)

fragment.childmap(FG_PNT)

fragment.find(INT)

fragment.history(BODY_PNT)

fragment.id(FG_PNT)

fragment.index(BODY_PNT<,INT>)

fragment.list(<INT>)

fragment.map(<INT>)

fragment.num(INT)

fragment.parent(FG_PNT)

fragment.pos(FG_PNT)

fragment.pos.catalog(FG_PNT,INT)

fragment.vol(FG_PNT<,int>)

geometry functions

geom.edge.create(GSET_PNT,INT/GN_PNT,INT/GN_PNT)

geom.edge.delete(GSET_PNT,GE_PNT)

geom.edge.dir(GE_PNT)

geom.edge.extra(GE_PNT,INT)

geom.edge.find(GSET_PNT,INT)

geom.edge.id(GE_PNT)

geom.edge.list(GSET_PNT)

geom.edge.near(GSET_PNT,VEC<,FLT>)

geom.edge.next.edge(GE_PNT,INT)

geom.edge.next.index(GE_PNT,INT)

geom.edge.node(GE_PNT,INT)

geom.edge.node.pos(GE_PNT,INT)

geom.edge.pos(GE_PNT)

geom.edge.remove(GSET_PNT,GE_PNT)

geom.edge.start.index(GE_PNT)

geom.edge.start.poly(GE_PNT)

geom.edge.typeid

geom.node.create(GSET_PNT,VEC)

geom.node.delete(GSET_PNT,GN_PNT)

geom.node.extra(GN_PNT,INT)

geom.node.find(GSET_PNT,INT)

geom.node.group(GN_PNT<,STR/IND>)

geom.node.group.remove(GN_PNT,STR/IND<,STR/IND>)

geom.node.id(GN_PNT)

geom.node.isgroup(GN_PNT,STR/IND<,STR/IND>)

geom.node.list(GSET_PNT)

geom.node.near(GSET_PNT,VEC<,FLT>)

geom.node.pos(GN_PNT)

geom.node.remove(GSET_PNT,GN_PNT)

geom.node.start.edge(GN_PNT)

geom.node.start.index(GN_PNT)

geom.node.typeid

geom.poly.add.edge(GPOL_PNT,GE_PNT)

geom.poly.add.node(GSET_PNT,GPOL_PNT<,GN_PNT><,VEC><,INT>)

geom.poly.area(GPOL_PNT)

geom.poly.check(GPOL_PNT)

geom.poly.close(GSET_PNT,GPOL_PNT)

geom.poly.create(GSET_PNT)

geom.poly.delete(GSET_PNT,GPOL_PNT)

geom.poly.edge(GPOL_PNT,INT)

geom.poly.extra(GPOL_PNT,INT)

geom.poly.find(GSET_PNT,INT)

geom.poly.group(GPOL_PNT<,STR/IND>)

geom.poly.group.remove(GPOL_PNT,STR/IND<,STR/IND>)

geom.poly.id(GPOL_PNT)

geom.poly.isgroup(GPOL_PNT,STR/IND<,STR/IND>)

geom.poly.list(GSET_PNT)

geom.poly.near(GSET_PNT,VEC<,FLT>)

geom.poly.near.map(GSET_PNT,VEC+,FLT)

geom.poly.next.index(GPOL_PNT,INT)

geom.poly.next.poly(GPOL_PNT,INT)

geom.poly.node(GPOL_PNT,INT)

geom.poly.normal(GPOL_PNT)

geom.poly.pos(GPOL_PNT)

geom.poly.remove(GSET_PNT,GPOL_PNT)

geom.poly.size(GPOL_PNT)

geom.poly.typeid

geom.set.closest(GSET_PNT,VEC<,FLT>)

geom.set.create(STR)

geom.set.delete(GSET_PNT)

geom.set.edge.maxid(GSET_PNT)

geom.set.edge.num(GSET_PNT)

geom.set.find(INT/STR)

geom.set.id(GSET_PNT)

geom.set.name(GSET_PNT)

geom.set.node.maxid(GSET_PNT)

geom.set.node.num(GSET_PNT)

geom.set.poly.closest(GSET_PNT,VEC<,FLT>)

geom.set.poly.maxid(GSET_PNT)

geom.set.poly.num(GSET_PNT)

geom.set.raydist(GSET_PNT,VEC,VEC)

geom.set.remove(GSET_PNT)

geom.set.typeid

global functions

global.deterministic

global.timestep

measure functions

measure.coordination(MEAS_PNT)

measure.delete(MEAS_PNT)

measure.find(INT)

measure.id(MEAS_PNT)

measure.porosity(MEAS_PNT)

measure.pos(MEAS_PNT)

measure.radius(MEAS_PNT)

measure.size(MEAS_PNT)

measure.strain.rate(MEAS_PNT)

measure.stress(MEAS_PNT)

mech (mechanical process) functions

mech.safety.factor

mech.solve(STR)

mech.time.total

mech.timestep.given

mech.timestep.max

range functions

range.find(STR)

range.isin(RAN_PNT,IND/PNT/VEC)

table functions

table(INT/STR/TAB_PNT,FLT)

table.as.list(INT/STR/TAB_PNT)

table.clear(INT/STR/TAB_PNT)

table.create(INT/STR)

table.delete(INT/STR/TAB_PNT)

table.derivative(INT/STR/TAB_PNT)

table.fft(INT/STR/TAB_PNT)

table.find(INT/STR)

table.get(INT/STR)

table.id(INT/STR/TAB_PNT)

table.integrate(INT/STR/TAB_PNT)

table.label(INT/STR/TAB_PNT)

table.name(INT/STR/TAB_PNT)

table.size(INT/STR/TAB_PNT)

table.spectrum(INT/STR/TAB_PNT,FLT,FLT,FLT,INT)

table.value(INT/STR/TAB_PNT,INT)

table.x(INT/STR/TAB_PNT,INT)

table.y(INT/STR/TAB_PNT,INT)

⇄

⇐ Index: Common Commands | FLAC (FLAC2D/FLAC3D) ⇒

Was this helpful? ...

Itasca Software © 2024, Itasca

Updated: Apr 02, 2024

9.0.168