FISH Functions

Functions built into the FISH language by group below.

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

c array c list c string
c constructors c mail c structure
c creep process c map c system
c dynamic process c math c tensor
c file c matrix c thermal process
c fluid process c mechanical process c time
c global c memory c type
c io c socket c version

At the bottom of the page, for convenience, a list of links to indexes of code-specific functions and commonly used functions is also provided.

math utilities

math.aangle.to.euler(VEC3)
math.abs(NUM)
math.acos(NUM)
math.and(INT,INT)
math.area.intersect.poly.poly(MAP,MAP)
math.area.poly(MAP)
math.asin(NUM)
math.atan(NUM)
math.atan2(NUM,NUM)
math.bound(NUM/VEC2/VEC3,NUM/VEC2/VEC3,NUM/VEC2/VEC3)
math.ceiling(NUM)
math.choose(BOOL,ANY,ANY)
math.closest.segment.point(VEC2/VEC3,VEC2/VEC3,VEC2/VEC3)
math.closest.triangle.point(VEC2/VEC3,VEC2/VEC3,VEC2/VEC3,VEC2/VEC3)
math.cos(NUM)
math.cosh(NUM)
math.cross(VEC2/VEC3,VEC2/VEC3)
math.ddir.from.normal(VEC3+)
math.degrad
math.dip.from.normal(VEC2/VEC3)
math.dist.segment.point(VEC2/VEC3,VEC2/VEC3,VEC2/VEC3)
math.dist.segment.segment(VEC2/VEC3,VEC2/VEC3,VEC2/VEC3,VEC2/VEC3)
math.dist.triangle.segment(VEC2/VEC3,VEC2/VEC3,VEC2/VEC3,VEC2/VEC3,VEC2/VEC3)
math.dot(VEC,VEC)
math.erf(FLT)
math.erfc(FLT)
math.euler.to.aangle(VEC3)
math.exp(NUM)
math.expint(FLT)
math.floor(NUM)
math.gamma(FLT)
math.in.range(NUM/VEC2/VEC3,NUM/VEC2/VEC3,NUM/VEC2/VEC3)
math.ln(NUM)
math.log(NUM)
math.lshift(INT,INT)
math.mag(VEC2/VEC3)
math.mag2(VEC2/VEC3)
math.max(ANY,ANY<,ANY>)
math.min(NUM,NUM<,NUM>)
math.normal.from.dip(FLT)
math.normal.from.dip.ddir(FLT,FLT)
math.not(INT)
math.or(INT,INT)
math.outer.product(MAT/VEC2/VEC3,MAT/VEC2/VEC3)
math.pi
math.random.gauss(<INT>)
math.random.uniform(<INT>)
math.round(NUM)
math.rshift(INT,INT)
math.sgn(NUM)
math.sin(NUM)
math.sinh(NUM)
math.sqrt(NUM)
math.tan(NUM)
math.tanh(NUM)
math.triangle.inside(VEC2,VEC2,VEC2,VEC2)
math.triangle.interp(VEC2,FLT,VEC2,FLT,VEC2,FLT,VEC2)
math.unit(VEC)

Value Type utilities

In this group: c array, Constructors, c list, c map, c matrix, c memory, c string, c structure, c tensor, c type.

version utilities

code.name
version.code.major
version.code.minor
version.fish.major
version.fish.minor

Other FISH Indexes

In addition to the functions shown above, which are built into the FISH language, there are groups of functions that are provided specifically by the program that uses them (i.e., FLAC3D, 3DEC, or PFC), and a last set of function groups that are used commonly by all the software.

  • FLAC3D FISH Function Index
  • PFC FISH Function Index
  • Common FISH Function Index