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.

creep process utilities

• creep.active
• creep.cycle
• creep.safety.factor
• creep.solve
• creep.step
• creep.time.total
• creep.timestep
• creep.timestep.given
• creep.timestep.max

creep.active

creep.cycle

creep.safety.factor

creep.solve(STR)

creep.step

creep.time.total

creep.timestep

creep.timestep.given

creep.timestep.max

dynamic process utilities

• dynamic.active
• dynamic.cycle
• dynamic.safety.factor
• dynamic.solve
• dynamic.step
• dynamic.time.total
• dynamic.timestep
• dynamic.timestep.given
• dynamic.timestep.max

dynamic.active

dynamic.cycle

dynamic.safety.factor

dynamic.solve(STR)

dynamic.step

dynamic.time.total

dynamic.timestep

dynamic.timestep.given

dynamic.timestep.max

file utilities

• file.all
• file.close
• file.delete
• file.end
• file.exist
• file.name
• file.open
• file.open.check
• file.pos
• file.read
• file.rename
• file.size
• file.write

file.all(STR<,STR><,INT>)

file.close(<FILE_PNT>)

file.delete(STR)

file.end(<FILE_PNT>)

file.exist(STR)

file.name(<FILE_PNT>)

file.open(STR<,STR><,STR>)

file.open.check(STR<,STR><,STR>)

file.pos(<FILE_PNT>)

file.read(<INT/FILE_PNT><,INT>)

file.rename(STR,STR)

file.size(<FILE_PNT/STR>)

file.write(<FILE_PNT>)

fluid process utilities

• fluid.active
• fluid.cycle
• fluid.safety.factor
• fluid.solve
• fluid.step
• fluid.time.total
• fluid.timestep
• fluid.timestep.given
• fluid.timestep.max

fluid.active

fluid.cycle

fluid.safety.factor

fluid.solve(STR)

fluid.step

fluid.time.total

fluid.timestep

fluid.timestep.given

fluid.timestep.max

global utilities

• global.cycle
• global.deterministic
• global.dim
• global.fos
• global.gravity
• global.step
• global.threads
• global.timestep
• global.title

global.cycle

global.deterministic

global.dim

global.fos

global.gravity

global.step

global.threads

global.timestep

global.title

io utilities

• io.dialog.in
• io.dialog.message
• io.dialog.notify
• io.in
• io.input
• io.out

io.dialog.in(STR<,STR>)

io.dialog.message(STR,STR,INT)

io.dialog.notify(INT,INT,STR)

io.in(STR)

io.input(STR)

io.out(ANY)

mail utilities

• mail.account
• mail.attachment.add
• mail.attachment.delete
• mail.body
• mail.clear
• mail.domain
• mail.from
• mail.host
• mail.password
• mail.port
• mail.recipient.add
• mail.recipient.delete
• mail.send
• mail.subject

mail.account(STR)

mail.attachment.add(STR)

mail.attachment.delete(STR)

mail.body(BOOL,STR)

mail.clear

mail.domain(STR)

mail.from(STR)

mail.host(STR)

mail.password(STR)

mail.port(INT)

mail.recipient.add(STR,STR)

mail.recipient.delete(STR,STR)

mail.send

mail.subject(STR)

math utilities

• math.aangle.to.euler
• math.abs
• math.acos
• math.and
• math.area.intersect.poly.poly
• math.area.poly
• math.asin
• math.atan
• math.atan2
• math.bound
• math.ceiling
• math.choose
• math.closest.segment.point
• math.closest.triangle.point
• math.cos
• math.cosh
• math.cross
• math.ddir.from.normal
• math.degrad
• math.dip.from.normal
• math.dist.segment.point
• math.dist.segment.segment
• math.dist.triangle.segment
• math.dot
• math.erf
• math.erfc
• math.euler.to.aangle
• math.exp
• math.expint
• math.floor
• math.gamma
• math.in.range
• math.ln
• math.log
• math.lshift
• math.mag
• math.mag2
• math.max
• math.min
• math.normal.from.dip
• math.normal.from.dip.ddir
• math.not
• math.or
• math.outer.product
• math.pi
• math.random.gauss
• math.random.uniform
• math.round
• math.rshift
• math.sgn
• math.sin
• math.sinh
• math.sqrt
• math.tan
• math.tanh
• math.triangle.inside
• math.triangle.interp
• math.unit

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(List)

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)

mechanical process utilities

• mech.active
• mech.cycle
• mech.safety.factor
• mech.solve
• mech.step
• mech.time.total
• mech.timestep
• mech.timestep.given
• mech.timestep.max

mech.active

mech.cycle

mech.safety.factor

mech.solve(STR)

mech.step

mech.time.total

mech.timestep

mech.timestep.given

mech.timestep.max

socket utilities

• socket.close
• socket.create
• socket.delete
• socket.open
• socket.read
• socket.read.array
• socket.write
• socket.write.array

socket.close(SOCK_PNT/INT)

socket.create

socket.delete(SOCK_PNT)

socket.open(INT/STR,SOCK_PNT/INT<,INT><,INT>)

socket.read(ARR_PNT,INT,SOCK_PNT/INT<,INT>)

socket.read.array(ARR_PNT,SOCK_PNT/INT)

socket.write(ARR_PNT,INT,SOCK_PNT/INT)

socket.write.array(ARR_PNT,SOCK_PNT/INT)

system utilities

• system.beep
• system.clone
• system.command
• system.directory
• system.directory.absolute
• system.directory.create
• system.directory.current
• system.directory.delete
• system.directory.list
• system.directory.relative
• system.environment
• system.error
• system.os
• system.sleep

system.beep(<INT><,INT>)

system.clone(STR<,INT><,BOOL>)

system.command(STR/LIST/MAP/ARR<,BOOL>)

system.directory(<STR><,STR>)

system.directory.absolute(STR<,STR>)

system.directory.create(STR)

system.directory.current

system.directory.delete(STR<,BOOL>)

system.directory.list(<STR><,BOOL><,BOOL>)

system.directory.relative(STR<,STR>)

system.environment(STR)

system.error

system.os(STR<,INT>)

system.sleep(INT)

thermal process utilities

• thermal.active
• thermal.age
• thermal.cycle
• thermal.safety.factor
• thermal.solve
• thermal.step
• thermal.time.analytical
• thermal.timestep
• thermal.timestep.given
• thermal.timestep.max

thermal.active

thermal.age

thermal.cycle

thermal.safety.factor

thermal.solve(STR)

thermal.step

thermal.time.analytical

thermal.timestep

thermal.timestep.given

thermal.timestep.max

time utilities

• time.clock
• time.cpu
• time.kernel
• time.real

time.clock(<INT>)

time.cpu

time.kernel

time.real

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.

array utilities

Arrays are described under Arrays in the FISH “Data Types” section.

• array.copy
• array.delete
• array.dim
• array.size

array.copy(ARR)

array.delete(ARR)

array.dim(ARR)

array.size(ARR_PNT<,INT>)

Constructors

• array
• boolean
• false
• float
• index
• int
• list
• map
• matrix
• null
• string
• tensor
• true
• vector

array(INT/LIST/VEC2/VEC3/MAT/TEN<,INT>)

boolean(BOOL/NUM/PNT)

false

float(BOOL/NUM/STR)

index(NUM/STR)

int(BOOL/NUM/STR)

list(<INT/STR/VEC2/VEC3/MAT/MAP/LIST_PNT>)

map(<ANY/STRUCT/LIST><,ANY/LIST><,ANY><,ANY>)

matrix(INT/LIST/TEN/VEC2/VEC3/ARR<,INT><,FLT/INT>)

null

string(ANY<,INT><,STR><,INT><,STR>)

tensor(<NUM/LIST/MAT/VEC3/ARR><,NUM><,NUM><,NUM><,NUM><,NUM>)

true

vector(NUM/LIST/STR/MAT/ARR<,NUM><,NUM>)

list utilities

• list.append
• list.at
• list.concatenate
• list.count
• list.create
• list.extend
• list.find.index
• list.insert
• list.insert.list
• list.max
• list.min
• list.prepend
• list.range
• list.resize
• list.reverse
• list.separate
• list.sequence
• list.size
• list.sort
• list.sum

list.append(LIST,ANY)

list.at(LIST,INT)

list.concatenate(ANY<,INT>)

list.count(LIST,ANY)

list.create(INT<,ANY>)

list.extend(LIST,ANY)

list.find.index(LIST,ANY<,INT>)

list.insert(LIST,INT,ANY)

list.insert.list(LIST,INT,ANY)

list.max(LIST)

list.min(LIST)

list.prepend(ANY,LIST)

list.range(NUM,NUM<,NUM>)

list.resize(LIST,INT<,ANY>)

list.reverse(LIST)

list.separate(ANY,INT)

list.sequence(ANY)

list.size(LIST)

list.sort(LIST)

list.sum(LIST)

map utilities

Maps are described under Maps in the FISH “Data Types” section.

• map.add
• map.add.list
• map.has
• map.keys
• map.merge
• map.remove
• map.size
• map.value
• map.value.all

map.add(MAP,ANY,ANY)

map.add.list(MAP,LIST,LIST)

map.has(MAP,ANY)

map.keys(MAP)

map.merge(MAP,MAP)

map.remove(MAP,ANY)

map.size(MAP)

map.value(MAP,ANY)

map.value.all(MAP)

matrix utilities

Matrices are described under Matrices in the FISH “Data Types” section.

• matrix.cols
• matrix.det
• matrix.from.axis.angle
• matrix.from.euler
• matrix.identity
• matrix.inverse
• matrix.lubksb
• matrix.ludcmp
• matrix.rows
• matrix.to.axis.angle
• matrix.to.euler
• matrix.transpose

matrix.cols(MAT)

matrix.det(MAT/TEN)

matrix.from.axis.angle(VEC3)

matrix.from.euler(VEC3)

matrix.identity(INT)

matrix.inverse(MAT/TEN/ARR)

matrix.lubksb(MAT/TEN/ARR,LIST/ARR,ARR/MAT/VEC3/VEC2)

matrix.ludcmp(MAT/TEN/ARR,LIST/ARR)

matrix.rows(MAT)

matrix.to.axis.angle(MAT)

matrix.to.euler(MAT)

matrix.transpose(MAT)

memory utilities

• memory
• memory.create
• memory.delete
• memory.fortran.float
• memory.fortran.index
• memory.fortran.integer
• memory.offset
• memory.size

memory(MEM)

memory.create(INT)

memory.delete(MEM)

memory.fortran.float

memory.fortran.index

memory.fortran.integer

memory.offset(MEM)

memory.size(MEM)

string utilities

Strings are described under Strings in the FISH “Data Types” section.

• string.build
• string.compare
• string.csv.from
• string.csv.to
• string.file.ext
• string.file.name
• string.file.path
• string.find
• string.find.regex
• string.join
• string.len
• string.lower
• string.match.regex
• string.replace
• string.replace.regex
• string.simplify
• string.split
• string.split.regex
• string.sub
• string.token
• string.token.type
• string.type
• string.upper

string.build(STR<,ANY><,ANY>)

string.csv.from(STR<,STR>)

string.csv.to(LIST<,STR>)

string.file.ext(STR)

string.file.name(STR)

string.file.path(STR)

string.find(STR,STR)

string.find.regex(STR,STR)

string.join(LIST,STR)

string.len(STR)

string.lower(STR)

string.match.regex(STR,STR)

string.replace(STR,STR,STR)

string.replace.regex(STR,STR,STR)

string.simplify(STR)

string.split(STR<,STR>)

string.split.regex(STR,STR)

string.sub(STR,INT<,INT>)

string.token(STR,INT)

string.token.type(STR,INT)

string.type(STR)

string.upper(STR)

structure utilities

Structures are described under Structures in the FISH “Data Types” section.

structure.check(STRUCT,STRUCT)

structure.from.map(STR,MAP)

structure.name(STRUCT)

• structure.check
• structure.name
• structure.from.map

tensor utilities

Tensors are described under Tensors in the FISH “Data Types” section.

• tensor.i2
• tensor.j2
• tensor.prin
• tensor.prin.dir
• tensor.prin.from
• tensor.total
• tensor.trace

tensor.i2(TEN)

tensor.j2(TEN)

tensor.prin(TEN)

tensor.prin.dir(TEN)

tensor.prin.from(LIST)

tensor.total(TEN)

tensor.trace(TEN)

type utilities

• type
• type.index
• type.name
• type.pointer
• type.pointer.id
• type.pointer.name

type(ANY)

type.index(PNT)

type.name(ANY)

type.pointer(PNT)

type.pointer.id(PNT)

type.pointer.name(PNT)

version utilities

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

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