FISH Functions

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

Table 1: Zone Functions by Group

attach functions	interface.elem functions (zone interface elements)
zone.face functions	interface.node functions (zone interface nodes)
zone.field functions (zone field data)	zone.tet functions (zone tetra)
gp functions (zone gridpoints)	zone functions
interface functions (zone interfaces)

attach functions

• attach.create
• attach.delete
• attach.extra
• attach.find
• attach.group
• attach.group.remove
• attach.id
• attach.isgroup
• attach.list
• attach.master
• attach.master.face
• attach.master.zone
• attach.maxid
• attach.num
• attach.pos
• attach.slave
• attach.snap
• attach.type
• attach.typeid
• attach.weight.edge
• attach.weight.face

attach.create(GP_PNT,GP_PNT/ZONE_PNT<,GP_PNT/INT>)

attach.delete(ATTACH_PNT)

attach.extra(ATTACH_PNT<,INT>)

attach.find(INT)

attach.group(ATTACH_PNT<,STR/IND>)

attach.group.remove(ATTACH_PNT,STR/IND<,STR/IND>)

attach.id(ATTACH_PNT)

attach.isgroup(ATTACH_PNT,STR/IND<,STR/IND>)

attach.list

attach.master(ATTACH_PNT<,INT>)

attach.master.face(ATTACH_PNT)

attach.master.zone(ATTACH_PNT)

attach.maxid

attach.num

attach.pos(ATTACH_PNT)

attach.slave(ATTACH_PNT)

attach.snap(ATTACH_PNT)

attach.type(ATTACH_PNT)

attach.typeid

attach.weight.edge(ATTACH_PNT)

attach.weight.face(ATTACH_PNT)

zone.face functions

Note that zone faces do not have their own objects, and are therefore not referenced by pointer. They are specified most often by a zone pointer and a side index, which is therefore not necessarily unique for internal faces.

• zone.face.area
• zone.face.extra
• zone.face.find
• zone.face.find.normal
• zone.face.gp
• zone.face.group
• zone.face.group.remove
• zone.face.isgroup
• zone.face.normal
• zone.face.pos
• zone.face.size

zone.face.area(ZONE_PNT,INT)

zone.face.extra(ZONE_PNT,INT,INT)

zone.face.find(ZONE_PNT,INT/GP_PNT,INT/GP_PNT,INT/GP_PNT)

zone.face.find.normal(ZONE_PNT,VEC)

zone.face.gp(ZONE_PNT,INT<,INT>)

zone.face.group(ZONE_PNT,INT<,STR/IND>)

zone.face.group.remove(ZONE_PNT,INT,STR/IND)

zone.face.isgroup(ZONE_PNT,INT,STR/IND<,STR/IND>)

zone.face.normal(ZONE_PNT,INT)

zone.face.pos(ZONE_PNT,INT)

zone.face.size(ZONE_PNT,INT)

zone.field functions (zone field data)

Zone field data functions offer a way to efficiently request a scalar value from any position in the model covered by a zone. See Zone Field Data for further information and examples.

• zone.field.component
• zone.field.extra
• zone.field.get
• zone.field.get.gp
• zone.field.gravity
• zone.field.hide.fluidnull
• zone.field.hide.mechnull
• zone.field.hide.thermnull
• zone.field.index
• zone.field.init
• zone.field.log
• zone.field.method.index
• zone.field.method.name
• zone.field.name
• zone.field.power
• zone.field.prop
• zone.field.quantity
• zone.field.radius.ratio
• zone.field.reset
• zone.field.source
• zone.field.tol
• zone.field.type
• zone.field.velocity.limit

zone.field.component

zone.field.extra

zone.field.get(VEC+<,FLT>)

zone.field.get.gp(GP_PNT,ZONE_PNT)

zone.field.gravity

zone.field.hide.fluidnull

zone.field.hide.mechnull

zone.field.hide.thermnull

zone.field.index

zone.field.init

zone.field.log

zone.field.method.index

zone.field.method.name

zone.field.name

zone.field.power

zone.field.prop

zone.field.quantity

zone.field.radius.ratio

zone.field.reset

zone.field.source

zone.field.tol

zone.field.type

zone.field.velocity.limit

gp functions (zone gridpoints)

• gp.accel
• gp.biot.modulus
• gp.convergence
• gp.copy
• gp.create
• gp.delete
• gp.disp
• gp.disp.small
• gp.dynamic.mul
• gp.dynamic.timestep
• gp.extra
• gp.find
• gp.find.name
• gp.fix
• gp.flow
• gp.fluid.app
• gp.fluid.load
• gp.fluid.modulus
• gp.fluid.modulus.confined
• gp.fluid.tension
• gp.fluid.unbal
• gp.fluid.vol.inv
• gp.flux
• gp.force.app
• gp.force.load
• gp.force.unbal
• gp.force.unbal.add
• gp.force.unbal.current
• gp.group
• gp.group.remove
• gp.head
• gp.id
• gp.isgroup
• gp.list
• gp.mass.add
• gp.mass.gravity
• gp.mass.inertial
• gp.maxid
• gp.multiplier
• gp.name
• gp.near
• gp.near.all
• gp.near.live
• gp.next
• gp.num
• gp.pos
• gp.pp
• gp.pp.fix
• gp.ratio
• gp.ratio.target
• gp.sat
• gp.state.restore
• gp.state.save
• gp.stiff
• gp.temp
• gp.temp.app
• gp.temp.change
• gp.temp.fix
• gp.temp.source
• gp.typeid
• gp.vel
• gp.zones
• interface.node.head
• interface.node.list

gp.accel(GP_PNT)

gp.biot.modulus(GP_PNT)

gp.convergence(GP_PNT)

gp.copy(GP_PNT,GP_PNT)

gp.create(VEC+)

gp.delete(GP_PNT)

gp.disp(GP_PNT)

gp.disp.small(GP_PNT)

gp.dynamic.mul(GP_PNT)

gp.dynamic.timestep(GP_PNT)

gp.extra(GP_PNT<,INT>)

gp.find(STR)

gp.fix(GP_PNT)

gp.flow(GP_PNT)

gp.fluid.app(GP_PNT)

gp.fluid.load(GP_PNT)

gp.fluid.modulus(GP_PNT)

gp.fluid.modulus.confined(GP_PNT)

gp.fluid.tension(GP_PNT)

gp.fluid.unbal(GP_PNT)

gp.fluid.vol.inv(GP_PNT)

gp.flux(GP_PNT)

gp.force.app(GP_PNT)

gp.force.load(GP_PNT)

gp.force.unbal(GP_PNT)

gp.force.unbal.add(GP_PNT)

gp.force.unbal.current(GP_PNT)

gp.head

gp.id(GP_PNT)

gp.list

gp.mass.add(GP_PNT)

gp.mass.gravity(GP_PNT)

gp.mass.inertial(GP_PNT)

gp.maxid

gp.name(GP_PNT)

gp.near(VEC+<,STR>)

gp.near.all(VEC+)

gp.near.live(VEC+,BOOL,BOOL,BOOL,STR)

gp.next(GP_PNT)

gp.num

gp.pos(GP_PNT)

gp.pp(GP_PNT<,INT>)

gp.pp.fix(GP_PNT)

gp.ratio(GP_PNT)

gp.ratio.target(GP_PNT)

gp.sat(GP_PNT)

gp.state.restore(GP_PNT)

gp.state.save(GP_PNT)

gp.stiff(GP_PNT)

gp.temp(GP_PNT)

gp.temp.app(GP_PNT)

gp.temp.change(GP_PNT)

gp.temp.fix(GP_PNT)

gp.temp.source(GP_PNT)

gp.typeid

gp.vel(GP_PNT)

gp.zones(GP_PNT)

interface functions (zone interfaces)

• interface.find
• interface.group
• interface.group.remove
• interface.head
• interface.id
• interface.isgroup
• interface.list
• interface.name
• interface.next

interface.find(STR)

interface.group(INTERFACE_PNT<,STR>)

interface.group.remove(INTERFACE_PNT,STR/IND<,STR/IND>)

interface.head

interface.id(INTERFACE_PNT)

interface.isgroup(INTERFACE_PNT,STR/IND<,STR/IND>)

interface.list

interface.name(INTERFACE_PNT)

interface.next(INTERFACE_PNT)

interface.elem functions (zone interface elements)

Unlike zones and gridpoints, there is no global list of all interface elements. Instead, each interface keeps its own list of elements.

• interface.elem.area
• interface.elem.extra
• interface.elem.group
• interface.elem.group.remove
• interface.elem.head
• interface.elem.host.face
• interface.elem.host.zone
• interface.elem.id
• interface.elem.isgroup
• interface.elem.join
• interface.elem.list
• interface.elem.next
• interface.elem.normal
• interface.elem.vertex

interface.elem.area(INTERFACE_ELEM_PNT)

interface.elem.extra(INTERFACE_ELEM_PNT<,INT>)

interface.elem.group(INTERFACE_ELEM_PNT<,STR>)

interface.elem.group.remove(INTERFACE_ELEM_PNT,STR/IND<,STR/IND>)

interface.elem.head(INTERFACE_PNT)

interface.elem.host.face(INTERFACE_ELEM_PNT)

interface.elem.host.zone(INTERFACE_ELEM_PNT)

interface.elem.id(INTERFACE_ELEM_PNT)

interface.elem.isgroup(INTERFACE_ELEM_PNT,STR/IND<,STR/IND>)

interface.elem.join(INTERFACE_ELEM_PNT,INT)

interface.elem.list(INTERFACE_PNT)

interface.elem.next(INTERFACE_ELEM_PNT)

interface.elem.normal(INTERFACE_ELEM_PNT)

interface.elem.vertex(INTERFACE_ELEM_PNT,INT)

interface.node functions (zone interface nodes)

Unlike zones and gridpoints, there is no global list of all interface nodes. Instead, each interface keeps its own list of nodes.

• interface.node.area
• interface.node.disp
• interface.node.disp.shear
• interface.node.extra
• interface.node.find
• interface.node.group
• interface.node.group.remove
• interface.node.head
• interface.node.host.face
• interface.node.host.weight
• interface.node.host.zone
• interface.node.id
• interface.node.isgroup
• interface.node.list
• interface.node.near
• interface.node.next
• interface.node.normal
• interface.node.penetration
• interface.node.position
• interface.node.pp
• interface.node.prop
• interface.node.slip
• interface.node.state
• interface.node.stress.normal
• interface.node.stress.normal.add
• interface.node.stress.shear
• interface.node.target.face
• interface.node.target.weight
• interface.node.target.zone
• interface.node.tol
• interface.node.vel

interface.node.area(INTERFACE_NODE_PNT)

interface.node.disp(INTERFACE_NODE_PNT)

interface.node.disp.shear(INTERFACE_NODE_PNT)

interface.node.extra(INTERFACE_NODE_PNT<,INT>)

interface.node.find(INTERFACE_PNT,INT)

interface.node.group(INTERFACE_NODE_PNT<,STR/IND>)

interface.node.group.remove(INTERFACE_NODE_PNT,STR/IND<,STR/IND>)

interface.node.head(INTERFACE_PNT)

interface.node.host.face(INTERFACE_NODE_PNT)

interface.node.host.weight(INTERFACE_NODE_PNT,INT)

interface.node.host.zone(INTERFACE_NODE_PNT)

interface.node.id(INTERFACE_NODE_PNT)

interface.node.isgroup(INTERFACE_NODE_PNT,STR/IND<,STR/IND>)

interface.node.list(INTERFACE_PNT)

interface.node.near(INTERFACE_PNT,VEC+)

interface.node.next(INTERFACE_NODE_PNT)

interface.node.normal(INTERFACE_NODE_PNT)

interface.node.penetration(INTERFACE_NODE_PNT)

interface.node.pos(INTERFACE_NODE_PNT)

interface.node.pp(INTERFACE_NODE_PNT)

interface.node.prop(INTERFACE_NODE_PNT,STR)

interface.node.slip(INTERFACE_NODE_PNT)

interface.node.state(INTERFACE_NODE_PNT)

interface.node.stress.normal(INTERFACE_NODE_PNT)

interface.node.stress.normal.add(INTERFACE_NODE_PNT)

interface.node.stress.shear(INTERFACE_NODE_PNT)

interface.node.target.face(INTERFACE_NODE_PNT)

interface.node.target.weight(INTERFACE_NODE_PNT,INT)

interface.node.target.zone(INTERFACE_NODE_PNT)

interface.node.tol(INTERFACE_NODE_PNT)

interface.node.vel(INTERFACE_NODE_PNT)

zone.tet functions (zone tetra)

Note that internal zone tetra are not available to FISH as their own objects, and are therefore not referenced by pointer. They are specified most often by a zone pointer, an overlay index, and a position index.

zone.tet.gp(ZONE_PNT<,INT><,INT>)

zone.tet.num(ZONE_PNT)

zone.tet.smallest.vol(ZONE_PNT)

zone.tet.strain.inc(ZONE_PNT<,INT><,INT>)

zone.tet.strain.rate(ZONE_PNT<,INT><,INT>)

zone.tet.stress(ZONE_PNT<,INT><,INT>)

• zone.tetra.gp
• zone.tetra.num
• zone.tetra.smallest.vol
• zone.tetra.strain.increment
• zone.tetra.strain.rate
• zone.tetra.stress

zone functions

• zone.aspect
• zone.bad
• zone.code
• zone.condition
• zone.containing
• zone.copy
• zone.create.gp
• zone.create.interface.elem
• zone.create.pos
• zone.create.ratio
• zone.creep.time.total
• zone.creep.timestep
• zone.cycle.init
• zone.density
• zone.dynamic.mul
• zone.dynamic.time.total
• zone.dynamic.timestep
• zone.extra
• zone.find
• zone.flow
• zone.fluid.density
• zone.fluid.model
• zone.fluid.prop
• zone.fluid.prop.index
• zone.fluid.ratio
• zone.fluid.stress.normal
• zone.fluid.time.total
• zone.fluid.unbal.avg
• zone.fluid.unbal.max
• zone.flux
• zone.force.update
• zone.geom.test
• zone.gp
• zone.gp.num
• zone.group
• zone.group.remove
• zone.head
• zone.hysteretic
• zone.id
• zone.inbox
• zone.isgroup
• zone.islive
• zone.join
• zone.list
• zone.maxid
• zone.mech.convergence
• zone.mech.prop.name
• zone.mech.prop.num
• zone.mech.ratio
• zone.mech.ratio
• zone.mech.ratio.local
• zone.mech.ratio
• zone.model
• zone.model.init
• zone.near
• zone.near.all
• zone.near.list
• zone.near.live
• zone.near.map
• zone.next
• zone.num
• zone.ortho
• zone.overlays
• zone.planarity
• zone.plane.traction
• zone.pos
• zone.pp
• zone.prop
• zone.prop.index
• zone.rotation.inc
• zone.rotation.rate
• zone.state
• zone.state.restore
• zone.state.save
• zone.strain.inc
• zone.strain.rate
• zone.strain.shear.inc
• zone.strain.shear.rate
• zone.strain.vol.inc
• zone.strain.vol.rate
• zone.stress
• zone.stress.effective
• zone.stress.int
• zone.stress.max
• zone.stress.min
• zone.stress.prin
• zone.temp
• zone.test.quality
• zone.thermal.model
• zone.thermal.prop
• zone.thermal.prop.index
• zone.thermal.ratio
• zone.thermal.time.total
• zone.typeid
• zone.unbal
• zone.vol
• zone.vol.deformed
• zone.was.updated
• zone.work.elastic.shear
• zone.work.elastic.total
• zone.work.elastic.vol
• zone.work.plastic.shear
• zone.work.plastic.total
• zone.work.plastic.vol

zone.aspect(ZONE_PNT)

zone.bad(ZONE_PNT)(2D ONLY)

zone.code(ZONE_PNT)

zone.condition(ZONE_PNT,INT)

zone.containing(VEC+<,ZONE_PNT>)

zone.copy(ZONE_PNT,ZONE_PNT)

zone.create.gp(STR,LIST)

zone.create.interface.elem(ZONE_PNT,INT,STR)

zone.create.pos(STR,LIST<,FLT>)

zone.create.ratio(FLT,INT,INT)

zone.creep.time.total

zone.creep.timestep

zone.cycle.init(ZONE_PNT)

zone.density(ZONE_PNT)

zone.dynamic.mul(ZONE_PNT)

zone.dynamic.time.total(ZONE_PNT)

zone.dynamic.timestep

zone.extra(ZONE_PNT<,INT>)

zone.find(INT)

zone.flow(ZONE_PNT)

zone.fluid.density(ZONE_PNT)

zone.fluid.model(ZONE_PNT)

zone.fluid.prop(ZONE_PNT,STR)

zone.fluid.prop.index(ZONE_PNT,STR)

zone.fluid.ratio

zone.fluid.stress.normal

zone.fluid.time.total

zone.fluid.unbal.avg

zone.fluid.unbal.max

zone.flux(ZONE_PNT)

zone.force.update

zone.geom.test(ZONE_PNT)

zone.gp(ZONE_PNT<,INT>)

zone.gp.num(ZONE_PNT)

zone.group(ZONE_PNT<,STR/IND>)

zone.group.remove(ZONE_PNT,STR/IND<,STR/IND>)

zone.head

zone.hysteretic(ZONE_PNT,STR)

zone.id(ZONE_PNT)

zone.inbox(VEC,VEC<,BOOL>)

zone.isgroup(ZONE_PNT,STR/IND<,STR/IND>)

zone.islive(ZONE_PNT)

zone.join(ZONE_PNT,INT)

zone.list

zone.maxid

zone.mech.convergence

zone.mech.prop.name(ZONE_PNT,INT)

zone.mech.prop.num(ZONE_PNT)

zone.mech.ratio

zone.mech.ratio.avg

zone.mech.ratio.local

zone.mech.ratio.max

zone.model(ZONE_PNT)

zone.model.init(ZONE_PNT)

zone.near(VEC+)

zone.near.all(VEC+)

zone.near.list(VEC3+,FLT)

zone.near.live(VEC+,BOOL,BOOL,BOOL,STR)

zone.near.map(VEC+,FLT)

zone.next(ZONE_PNT)

zone.num

zone.ortho(ZONE_PNT)

zone.overlays(ZONE_PNT)

zone.planarity(ZONE_PNT)

zone.plane.traction(ZONE_PNT,VEC<,ARR_PNT>)

zone.pos(ZONE_PNT)

zone.pp(ZONE_PNT)

zone.prop(ZONE_PNT,STR/INT)

zone.prop.index(ZONE_PNT,STR)

zone.rotation.inc(ZONE_PNT)

zone.rotation.rate(ZONE_PNT)

zone.state(ZONE_PNT)

zone.state.restore(ZONE_PNT)

zone.state.save(ZONE_PNT)

zone.strain.inc(ZONE_PNT)

zone.strain.rate(ZONE_PNT)

zone.strain.shear.inc(ZONE_PNT)

zone.strain.shear.rate(ZONE_PNT)

zone.strain.vol.inc(ZONE_PNT)

zone.strain.vol.rate

zone.stress(ZONE_PNT)

zone.stress.effective(ZONE_PNT)

zone.stress.int(ZONE_PNT)

zone.stress.max(ZONE_PNT)

zone.stress.min(ZONE_PNT)

zone.stress.prin(ZONE_PNT)

zone.temp(ZONE_PNT)

zone.test.quality(ZONE_PNT,INT)

zone.thermal.model(ZONE_PNT)

zone.thermal.prop(ZONE_PNT,STR)

zone.thermal.prop.index(ZONE_PNT,STR)

zone.thermal.ratio

zone.thermal.time.total

zone.typeid

zone.unbal

zone.vol(ZONE_PNT)

zone.vol.deformed(ZONE_PNT)

zone.was.updated

zone.work.elastic.shear(ZONE_PNT)

zone.work.elastic.total(ZONE_PNT)

zone.work.elastic.vol(ZONE_PNT)

zone.work.plastic.shear(ZONE_PNT)

zone.work.plastic.total(ZONE_PNT)

zone.work.plastic.vol(ZONE_PNT)