FISH Functions

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

Zone Gridpoint Functions

gp.accel(GP_PNT<,INT>) Get the acceleration vector for the gridpoint.
gp.biot.modulus(GP_PNT) Get/set the fluid Biot modulus.
gp.convergence(GP_PNT) Returns the gridpoint convergence value, defined as the ratio of...
gp.copy(GP_PNT,GP_PNT) Copies the gridpoint state information from the source to the...
gp.disp(GP_PNT<,INT>) Get/set the displacement vector for the gridpoint.
gp.disp.small(GP_PNT<,INT>) Get the small displacement vector for the gridpoint.
gp.dynamic.mul(GP_PNT) Get/set the dynamic stepping multiplier.
gp.extra(GP_PNT<,INT>) Get/set the extra variable at the index associated with the...
gp.find(INT) Get a pointer to the gridpoint with internally assigned ID...
gp.fix(GP_PNT<,INT>) Get/set a vector indicating gridpoint fixity.
gp.flow(GP_PNT) Get/set the unbalanced flow discharge at a gridpoint.
gp.fluid.load(GP_PNT) Get/set the additional fluid load.
gp.fluid.modulus(GP_PNT) Get/set the gridpoint fluid bulk modulus.
gp.fluid.modulus.confined(GP_PNT) Get/set the fluid flow confined modulus times nodal volume.
gp.fluid.tension(GP_PNT) Get/set the gridpoint fluid tension limit.
gp.fluid.unbal(GP_PNT) Get/set the the fluid out-of-balance flow; used in the fast...
gp.fluid.vol.inv(GP_PNT) Get the inverse of the fluid nodal volume.
gp.force.app(GP_PNT<,INT>) Get the total applied force at a gridpoint.
gp.force.load(GP_PNT<,INT>) Get/set the FISH applied force at a gridpoint.
gp.force.unbal(GP_PNT<,INT>) Get/set the unbalanced force at a gridpoint.
gp.group(GP_PNT<,STR>) Get/set the group name assigned to zone gridpoint gp in...
gp.group.remove(GP_PNT,STR) Remove the group s from zone gridpoint gp in all...
gp.head Get the first zone gridpoint in the list of all...
gp.id(GP_PNT) Get the zone gridpoint ID number, which is a unique...
gp.isgroup(GP_PNT,STR<,STR>) Check if the group name s is associated with the...
gp.link.index(GP_PNT) Get the index location of this gridpoint in the first...
gp.link.zone(GP_PNT) Get the first zone connected to this gridpoint.
gp.list Get the list of all gridpoints in the model.
gp.mass.add(GP_PNT<,INT>) Get/set the added mass vector for the gridpoint.
gp.mass.gravity(GP_PNT) Get the gravitational mass.
gp.mass.inertial(GP_PNT) Get the gridpoint inertial mass.
gp.maxid Get the maximum ID number assigned to any gridpoint in...
gp.near(VEC+) Get the gridpoint nearest v ; will return null if there...
gp.near.all(VEC+) Get the gridpoint nearest v ; will return null if there...
gp.near.live(VEC+,BOOL,BOOL,BOOL,STR) Get the gridpoint nearest point v .
gp.next(GP_PNT) Get the next gridpoint after gp in the list of...
gp.num Get the total number of gridpoints in the model.
gp.pos(GP_PNT<,INT>) Get/set the position of the gridpoint.
gp.pp(GP_PNT<,INT>) Get/set the gridpoint pore pressure.
gp.pp.fix(GP_PNT) Get/set the flag indicating that the pore pressure in the...
gp.ratio(GP_PNT) Get the local gridpoint mechanical convergence ratio.
gp.ratio.target(GP_PNT) Get/set the target local gridpoint mechanical convergence ratio.
gp.sat(GP_PNT) Get/set the fluid saturation.
gp.state.restore(GP_PNT) Restores all gridpoint state information from the currently open FISH ...
gp.state.save(GP_PNT) Saves all gridpoint state information to the currently open FISH ...
gp.stiff(GP_PNT) Get the accumulated gridpoint effective stiffness.
gp.temp(GP_PNT) Get/set the current gridpoint temperature.
gp.temp.change(GP_PNT) Get/set the temperature change of the grid point since the...
gp.temp.fix(GP_PNT) Get/set the flag indicating that temperature in this gridpoint is...
gp.temp.source(GP_PNT) Get/set the applied FISH temperature source at a gridpoint.
gp.typeid Get an identifier that uniquely determines the type of object.
gp.vel(GP_PNT<,INT>) Get/set the velocity vector for the gridpoint.

Zone Functions

zone.aspect(ZONE_PNT) Get the measure of a zone’s aspect ratio.
zone.bad(ZONE_PNT)(2D ONLY) Get the zone status based on the extruder criteria.
zone.code(ZONE_PNT) Get the zone code.
zone.condition(ZONE_PNT<,INT>) Get the zone condition number.
zone.containing(VEC+<,ZONE_PNT>) Get the zone that encompasses the point v .
zone.copy(ZONE_PNT,ZONE_PNT) Copies the zone state information from the source zone to...
zone.create.interface.elem(ZONE_PNT,INT,STR) create new interface elements attached to a zone face.
zone.create.ratio(FLT,INT,INT) Get a value calculated by a geometric progression, given a...
zone.creep.time.total Get/set the total accumulated zone module creep time.
zone.creep.timestep Get/set the timestep used by the zone creep module when...
zone.cycle.init(ZONE_PNT) Initialize the zone for cycling.
zone.density(ZONE_PNT) Get/set the density of the zone.
zone.dynamic.mul(ZONE_PNT) Get the multiple calculated for that zone when dynamic multistepping...
zone.dynamic.time.total(ZONE_PNT) Get/set the total accumulated zone module dynamic time.
zone.dynamic.timestep Get/set the timestep used by the zone dynamic module when...
zone.extra(ZONE_PNT<,INT>) Get/sets the value stored in the i th extra variable array...
zone.find(INT) Get the zone with internally assigned ID number i .
zone.flow(ZONE_PNT<,INT>) Get the specific discharge vector for the zone.
zone.fluid.density(ZONE_PNT) Get/set the fluid density for the zone.
zone.fluid.model(ZONE_PNT) Get/set the fluid flow constitituve model for the zone.
zone.fluid.prop(ZONE_PNT,STR) Get/set the value for fluid property s in zone z .
zone.fluid.ratio Get the current fluid convergence ratio for zones.
zone.fluid.stress.normal Get the representative stress magnitude for the fast flow solution...
zone.fluid.time.total Get/set the total accumulated zone module fluid time.
zone.fluid.timestep Get/set the current fluid timestep.
zone.fluid.unbal.avg Get the average unbalanced fluid volume limit for the fast...
zone.fluid.unbal.max Get the maximum unbalanced fluid limit for the fast flow...
zone.flux(ZONE_PNT<,INT>) Get the zone average heat flux vector.
zone.force.update Flags the cycling logic so that a geometry update is...
zone.geom.test(ZONE_PNT) Test the geometric fitness of a zone.
zone.gp(ZONE_PNT,INT) Get the gridpoint associated with the zone at index i .
zone.gp.num(ZONE_PNT) Get the number of unique gridpoints associated with this type...
zone.group(ZONE_PNT<,STR>) Get/set the group name assigned to zone z in slot...
zone.group.remove(ZONE_PNT,STR) Remove the group s from zone z , in all slots...
zone.head Get the first zone in the list of all zones...
zone.hysteretic(ZONE_PNT,STR) Get/set the hysteretic damping parameter s in zone z .
zone.id(ZONE_PNT) Get the zone ID number, a unique number assigned by...
zone.inbox(VEC,VEC<,BOOL>) Get zones with extents intersecting a box.
zone.isgroup(ZONE_PNT,STR<,STR>) Check if the group s is associated with the zone.
zone.islive(ZONE_PNT) Checks if the zone is “live”, meaning it has a...
zone.join(ZONE_PNT,INT) Get the zone joined to face i of zone z .
zone.link.index(ZONE_PNT,INT) Get the index of the next zone in the list...
zone.link.zone(ZONE_PNT,INT) Get the next zone in the list of all zones...
zone.list Get the list of all zones in the model.
zone.maxid Get the maximum ID number assigned to any zone in...
zone.mech.convergence Get the current maximum value of convergence in any gridpoint...
zone.mech.prop.name(ZONE_PNT,INT) Get the name of the i th property in the list...
zone.mech.prop.num(ZONE_PNT) Get the total number of properties accepted by the mechanical...
zone.mech.ratio Get the current zone mechanical convergence ratio.
zone.mech.ratio.avg Get the current zone mechanical average convergence ratio.
zone.mech.ratio.local Get the current zone mechanical local convergence ratio.
zone.mech.ratio.max Get the current zone mechanical maximum convergence ratio.
zone.mech.unbal.max Get the zone maximum unbalanced force.
zone.model(ZONE_PNT) Get/set the name of the current zone mechanical constitutive model.
zone.model.init(ZONE_PNT) Initializes all constitutive models (mechanical, fluid, and thermal) assigned to...
zone.near(VEC+) Get the zone with the centroid nearest v .
zone.near.all(VEC+) Get the zone with the centroid nearest v .
zone.near.live(VEC+,BOOL,BOOL,BOOL,STR) Get the zone with a centroid nearest point v .
zone.near.map(VEC+,FLT) Finds all zones with centroids within f distance of position...
zone.next(ZONE_PNT) Get the next zone after z in the list of...
zone.num Get the total number of zones in the model.
zone.ortho Get a measure of orthogonality for the zone.
zone.overlays(ZONE_PNT) Get the number of overlays available in the zone.
zone.planarity(ZONE_PNT) Get a measure of how planar the quadrilateral faces of...
zone.plane.traction(ZONE_PNT,VEC<,ARR_PNT>) Get the traction on the zone in the place normal...
zone.pos(ZONE_PNT<,INT>) Get the zone centroid position.
zone.pp(ZONE_PNT) Get/set the average zone pore pressure.
zone.prop(ZONE_PNT,STR) Get/set the value of property s in the zone.
zone.rotation.inc(ZONE_PNT<,INT<,INT>>) Get the zone rotational increment tensor, or a component of...
zone.rotation.rate(ZONE_PNT<,INT<,INT>>) Get the zone rotation rate tensor or component.
zone.state(ZONE_PNT) Get/set the current plasticity state indicators for the zone.
zone.state.restore(ZONE_PNT) Restores all zone state information from the currently open FISH ...
zone.state.save(ZONE_PNT) Saves all zone state information to the currently open FISH ...
zone.strain.inc(ZONE_PNT<,INT<,INT>>) Get the zone strain increment, based on the current displacement...
zone.strain.rate(ZONE_PNT,INT<,INT>) Get the zone strain rate, based on the current velocity...
zone.strain.shear.inc(ZONE_PNT) Get the zone shear strain increment based on the current...
zone.strain.shear.rate(ZONE_PNT) Get the zone shear strain rate based on the current...
zone.strain.vol.inc(ZONE_PNT) Get the zone volumetric strain increment based on the current...
zone.strain.vol.rate Get the zone volumetric strain rate based on the current...
zone.stress(ZONE_PNT<,INT<,INT>>) Get/set the zone stress.
zone.stress.effective(ZONE_PNT,INT<,INT>) Get the zone effective stress.
zone.stress.int(ZONE_PNT) Get the intermediate principal stress of the volume-weighted average of...
zone.stress.max(ZONE_PNT) Get the maximum (most positive) principal value of the volume-averaged...
zone.stress.min(ZONE_PNT) Get the minimum (most negative) principal value of the volume-averaged...
zone.stress.prin(ZONE_PNT<,INT>) Get the zone principal stress, calculated from the volume-weighted average...
zone.stress.prin.dir(ZONE_PNT,ARR_PNT,ARR_PNT) Get the zone principal stress directions, calculated from the volume-averaged...
zone.temp(ZONE_PNT) Get/set the zone temperature.
zone.test.quality(ZONE_PNT,INT) Get a measure of the zone quality, or how the...
zone.thermal.model(ZONE_PNT) Get/set the thermal flow constitutive model for the zone.
zone.thermal.prop(ZONE_PNT,STR) Get/set the value for thermal property s in zone z .
zone.thermal.ratio Get the current thermal convergence ratio for zones.
zone.thermal.time.total Get/set the total accumulated zone module thermal time.
zone.thermal.timestep Get/set the current thermal timestep.
zone.typeid Get an identifier that uniquely determines the type of object.
zone.unbal Get the current maximum unbalanced force on any gridpoint in...
zone.vol(ZONE_PNT) Get the zone volume calculated using the current position of...
zone.vol.deformed(ZONE_PNT) Get the volume of a zone using gridpoint positions that...
zone.was.updated Returns TRUE if the last validation check actually performed a...
zone.work.elastic.shear(ZONE_PNT) Get the shear elastic work.
zone.work.elastic.total(ZONE_PNT) Get the total elastic work.
zone.work.elastic.vol(ZONE_PNT) Get the volumetric elastic work.
zone.work.plastic.shear(ZONE_PNT) Get the shear plastic work dissipated.
zone.work.plastic.total(ZONE_PNT) Get the total plastic work dissipated.
zone.work.plastic.vol(ZONE_PNT) Get the volumetric plastic work dissipated.

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_PNT,INT) Get the area of the face.
zone.face.extra(ZONE_PNT,INT,INT) Get/set the value of the index in the extra variable...
zone.face.find(ZONE_PNT,INT/GP_PNT,INT/GP_PNT,INT/GP_PNT) Get the face index of zone z that contains the...
zone.face.find.normal(ZONE_PNT,VEC) Get the face index of zone z whose outward-facing normal...
zone.face.gp(ZONE_PNT,INT,INT) Get a pointer to a gridpoint on face given by...
zone.face.group(ZONE_PNT,INT<,STR>) Get/set the group name associated with the face identified by...
zone.face.group.remove(ZONE_PNT,INT,STR) Removes the group name s from the face identified by...
zone.face.isgroup(ZONE_PNT,INT,STR<,STR>) Check if the group name s is associated with the...
zone.face.normal(ZONE_PNT,INT<,INT>) Get the normal to the face, facing outward from zone...
zone.face.pos(ZONE_PNT,INT<,INT>) Get the position of the face, defined as the centroid...
zone.face.size(ZONE_PNT,INT) Get the number of unique face vertices.

Zone Tetra Functions

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,ARR_PNT) Gets the gridpoint pointers associated with a tetrahedron number itet ...
zone.tet.num(ZONE_PNT) Get the number of tetra in each overlay of the...
zone.tet.smallest.vol(ZONE_PNT) Get the volume of the smallest tetrahedron in an overlay.
zone.tet.strain.inc(ZONE_PNT,INT,INT<,INT<,INT>>) Get the zone tetra strain increment based on the current...
zone.tet.strain.rate(ZONE_PNT,INT,INT<,INT<,INT>>) Get the zone tetra strain rate based on the current...
zone.tet.stress(ZONE_PNT,INT,INT<,INT<,INT>>) Get/set the zone tetra stress.

Zone Field Data Functions

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 Get/set the scalar value retrieved from a name that returns...
zone.field.extra Get/set the index used to retrieve extra variables.
zone.field.get(VEC+<,FLT>) Get data from the model at the location specified by...
zone.field.get.gp(GP_PNT,ZONE_PNT) Get data directly from the gridpoint gp and zone z .
zone.field.gravity Get/set gravitational force setting.
zone.field.hide.fluidnull Get/set the null fluid constitutive model setting.
zone.field.hide.mechnull Get/set the null mechanical constitutive model setting.
zone.field.hide.thermnull Get/set the null thermal constitutive model setting.
zone.field.index Get/set the the index number of the data type name...
zone.field.init Initializes the zone field data system for the current method...
zone.field.log Get/set the logarithmic setting.
zone.field.method.index Get/set the index number of the extrapolation method used for...
zone.field.method.name Get/set the method used for extrapolation of zone-based variables.
zone.field.name Get/set the name of the value being retrieved from zones.
zone.field.power Get/set the power exponent used for the inverse-distance-weighting method of...
zone.field.prop Get/set the name of the property to retrieve when the...
zone.field.quantity Get/set the scalar quantity to retrieve when the value being...
zone.field.radius.ratio Get/set the the radius ratio parameter used for the inverse-distance-weighting ...
zone.field.reset Removes the effect of zone.
zone.field.source Get/set where values are derived from when appropriate.
zone.field.tol Get/set the tolerance used for the polynomial method of extrapolation.
zone.field.type Get/set the type to assume, for those values where the...

Zone Attach Functions

attach.create(GP_PNT,GP_PNT/ZONE_PNT<,GP_PNT/INT>) If only one gridpoint pointer is given as a parameter,...
attach.delete(ATTACH_PNT) Deletes an attachment, return value is undefined.
attach.extra(ATTACH_PNT<,INT>) Get/set the value stored in the i th extra variable array...
attach.find(INT) Get the pointer to the attach condition with ID i .
attach.group(ATTACH_PNT<,STR>) Check if the group s is associated with the attach.
attach.group.remove(ATTACH_PNT,STR) Remove the attach condition with the group name.
attach.id(ATTACH_PNT) Get the ID number of the given attach condition.
attach.list Get the list of all attaches in the model.
attach.master(ATTACH_PNT<,INT>) Get the master gridpoint pointer.
attach.master.face(ATTACH_PNT) Get the face side associated with this attach condition (from...
attach.master.zone(ATTACH_PNT) Get a pointer to the master zone for type 3...
attach.maxid Get the maximum ID number assigned to any attach condition...
attach.num Get the total number of attach conditions in the model.
attach.pos(ATTACH_PNT<,INT>) Get the attach position.
attach.slave(ATTACH_PNT) Get a pointer to the slave gridpoint.
attach.snap(ATTACH_PNT) Get/set snap option for attach.
attach.type(ATTACH_PNT) Get 1, 2, or 3, indicating that the attachment is...
attach.typeid Get an identifier that uniquely determines the type of object.
attach.weight.edge(ATTACH_PNT) Get a value in the range 0 to 1.
attach.weight.face(ATTACH_PNT) Get a vector with all components in the range 0...

Zone Interface Functions

interface.find(INT) Get the interface with internally assigned ID number i .
interface.head Get the first interface in the list of all interfaces...
interface.id(INTERFACE_PNT) Get the interface ID number, a unique number assigned by...
interface.list Get the list of all interfaces in the model.
interface.name(INTERFACE_PNT) Get the interface with the assigned name s .
interface.next(INTERFACE_PNT) Get the next interface after it in the list of...

Zone Interface Element Functions

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_PNT) Get the area of the interface element.
interface.elem.extra(INTERFACE_ELEM_PNT<,INT>) Get/set the value stored in the i th extra variable array...
interface.elem.head(INTERFACE_PNT) Following sentence doesn’t make sense.
interface.elem.host.face(INTERFACE_ELEM_PNT) Get the face ID number (1-6) to which the interface...
interface.elem.host.zone(INTERFACE_ELEM_PNT) Get the address of the zone to which the interface...
interface.elem.id(INTERFACE_ELEM_PNT) Get the ID number of the given interface element.
interface.elem.join(INTERFACE_ELEM_PNT,INT) Get the pointer to the adjacent interface element joined across...
interface.elem.list(INTERFACE_PNT) Get the list of all interface elements in the model.
interface.elem.next(INTERFACE_ELEM_PNT) Get the next interface element after ie in the list...
interface.elem.normal(INTERFACE_ELEM_PNT<,INT>) Get the normal vector for the interface element.
interface.elem.vertex(INTERFACE_ELEM_PNT,INT) Get the pointer of the vertex associated with the interface...

Zone Interface Node Functions

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_PNT) Get the characteristic area of the node (only valid after...
interface.node.disp(INTERFACE_NODE_PNT<,INT>) Get the displacement vector for the interface node.
interface.node.disp.shear(INTERFACE_NODE_PNT<,INT>) Get/set the relative shear displacement vector for the interface node.
interface.node.extra(INTERFACE_NODE_PNT<,INT>) Get/set the value stored in the i th extra variable array...
interface.node.find(INTERFACE_PNT,INT) Get the interface node with the given ID number.
interface.node.head(INTERFACE_PNT) Get the first interface node in the list of all...
interface.node.host.face(INTERFACE_NODE_PNT) Get the face ID (1-6) of the zone face to...
interface.node.host.weight(INTERFACE_NODE_PNT,INT) Get the weighting factor for vertex i (1-4) of the...
interface.node.host.zone(INTERFACE_NODE_PNT) Get the zone pointer to which the node is attached.
interface.node.id(INTERFACE_NODE_PNT) Get the ID number of the given interface node.
interface.node.list(INTERFACE_PNT) Get the list of all interface nodes in the model.
interface.node.next(INTERFACE_NODE_PNT) Get the next interface node after in in the list...
interface.node.normal(INTERFACE_NODE_PNT<,INT>) Get the normal vector for the interface node, which is...
interface.node.penetration(INTERFACE_NODE_PNT) Get interface node penetration with the contacting zone face (only...
interface.node.pos(INTERFACE_NODE_PNT<,INT>) Get/set the position vector for the interface node.
interface.node.pp(INTERFACE_NODE_PNT) Get the pore pressure of the node (only valid after...
interface.node.prop(INTERFACE_NODE_PNT,STR) Get/set the property identified by s of the interface node.
interface.node.slip(INTERFACE_NODE_PNT) Get/set the slip status (0-2) of the interface node: 0...
interface.node.stress.normal(INTERFACE_NODE_PNT) Get the normal stress at the node.
interface.node.stress.normal.add(INTERFACE_NODE_PNT) Get/set the additional normal stress.
interface.node.stress.shear(INTERFACE_NODE_PNT<,INT>) Get/set the shear stress vector for the interface node.
interface.node.target.face(INTERFACE_NODE_PNT) Get the face ID (1-6) of the zone face in...
interface.node.target.weight(INTERFACE_NODE_PNT,INT) Get the weighting factor for vertex i (1-4) of the...
interface.node.target.zone(INTERFACE_NODE_PNT) Get the zone pointer in contact with the node.
interface.node.tol(INTERFACE_NODE_PNT) Get/set the interface node contact tolerance, a dimensionless measure of how...
interface.node.vel(INTERFACE_NODE_PNT<,INT>) Get/set the velocity vector for the interface node.