FISH Functions
FISH language intrinsics are listed by group below. Beneath these, for convenience, the groups of general element intrinsics and FLAC3D-specific intrinsics are also listed.
The type specifiers used in the FISH function signatures are given in the “FISH Type Index” section.
- Array Utilities
- Component Utilities
- Constructors
- Creep Process Utilities
- Dynamic Process Utilities
- File Utilities
- Fluid Process Utilities
- Global Utilities
- IO Utilities
- List Utilities
- Mail Utilities
- Map Utilities
- Math Utilities
- Matrix Utilities
- Mechanical Process Utilities
- Memory Utilities
- Socket Utilities
- String Utilities
- Structure Utilities
- System Utilities
- Tensor Utilities
- Thermal Process Utilities
- Time Utilities
- Type Utilities
- Version Utilities
Array Utilities
Arrays are described under Arrays in the FISH “Data Types” section.
array.convert(MAT_PNT/TEN_PNT) | |
array.copy(ARR_PNT) | |
array.create(INT<,NUM>) | |
array.delete(ARR_PNT) | |
array.dim(ARR_PNT) | |
array.size(ARR_PNT,INT) |
Component Utilities
Vectors are described under Vectors in the FISH “Data Types” section.
comp(VEC/MAT_PNT/TEN_PNT,INT<,INT>) |
Constructors
boolean(BOOL/NUM/PNT) | |
false | |
float(BOOL/NUM/STR) | |
index(NUM/STR) | |
int(BOOL/NUM/STR) | |
null | |
true | |
vector(ARR_PNT/MAT_PNT/NUM<,NUM><,NUM>) |
Creep Process Utilities
creep.active | |
creep.age | |
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.age | |
dynamic.cycle | |
dynamic.safety.factor | |
dynamic.solve(STR) | |
dynamic.step | |
dynamic.time.total | |
dynamic.timestep | |
dynamic.timestep.given | |
dynamic.timestep.max |
File Utilities
Fluid Process Utilities
fluid.active | |
fluid.age | |
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(<INT>) | |
global.step | |
global.threads | |
global.timestep | |
global.title |
IO Utilities
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) |
List Utilities
list.find(LIST,INT) | |
list.find.name(LIST,INT/STR) | |
list.size(LIST) |
Mail Utilities
Map Utilities
Maps are described under Maps in the FISH “Data Types” section.
map(NUM/STR,ANY<,NUM/STR/ANY>) | |
map.add(MAP,NUM/STR,ANY) | |
map.has(MAP,NUM/STR) | |
map.keys(MAP) | |
map.remove(MAP,NUM/STR) | |
map.size(MAP) | |
map.value(MAP,NUM/STR) |
Math Utilities
Matrix Utilities
Matrices are described under Matrices in the FISH “Data Types” section.
Mechanical Process Utilities
mech.active | |
mech.cycle | |
mech.energy(STR) | |
mech.safety.factor | |
mech.solve(STR) | |
mech.step | |
mech.time.total | |
mech.timestep | |
mech.timestep.given | |
mech.timestep.max |
Memory Utilities
memory(MEM_PNT) | |
memory.create(INT) | |
memory.delete(MEM_PNT) |
Socket Utilities
String Utilities
Strings are described under Strings in the FISH “Data Types” section.
Structure Utilities
Structures are described under Structures in the FISH “Data Types” section.
struct.check(STRUCT_PNT,STRUCT_PNT) | |
struct.name(STRUCT_PNT) |
System Utilities
system.beep(<INT><,INT>) | |
system.clone(STR<,INT>) | |
system.command(STR/ARR_PNT/MAP) | |
system.directory(<STR><,STR>) | |
system.environment(STR) | |
system.error | |
system.os(STR<,INT>) | |
system.sleep(INT) |
Tensor Utilities
Tensors are described under Tensors in the FISH “Data Types” section.
Thermal Process Utilities
thermal.active | |
thermal.cycle | |
thermal.safety.factor | |
thermal.solve(STR) | |
thermal.step | |
thermal.time.total | |
thermal.timestep | |
thermal.timestep.given | |
thermal.timestep.max |
Time Utilities
time.clock(<INT>) | |
time.cpu | |
time.real |
Type Utilities
type(ANY) | |
type.index(PNT) | |
type.name(ANY) | |
type.pointer(PNT) | |
type.pointer.id(PNT) | |
type.pointer.name(PNT) |
Version Utilities
code.debug | |
code.name | |
version.code.major | |
version.code.minor | |
version.fish.major | |
version.fish.minor |
|
---|
Creep Process Utilities |
Dynamic Process Utilities |
Fluid Process Utilities |
Mechanical Process Utilities |
Thermal Process Utilities |
Was this helpful? ... | PFC 6.0 © 2019, Itasca | Updated: Nov 19, 2021 |