FISH Type Index

These type specifiers are used in FISH function signatures throughout the PFC documentation.

?
indicates an optional argument
ANY
any type, exept array
ARR_PNT
pointer to an array
B_PNT
ball pointer
BCF_PNT
ball CFD pointer
BR_PNT
brick pointer
BTH_PNT
ball thermal pointer
BODY_PNT
body pointer
BOOL
Boolean
BZB_PNT
ball-zone coupled ball pointer
BZGP_PNT
ball-zone coupled gridpoint pointer
C_PNT
contact pointer
CL_PNT
clump pointer
CLP_PNT
clump pebble pointer
CLPTH_PNT
clump pebble thermal pointer
CLCF_PNT
clump CFD pointer
CLPCF_PNT
clump CFD pebble pointer
CLT_PNT
clump template pointer
CLTH_PNT
clump thermal pointer
D_PNT
discrete fracture network (DFN) pointer
DFN
discrete fracture network (DFN)
DT_PNT
discrete fracture network (DFN) template pointer
ECF_PNT
element CFD pointer
FG_PNT
fragment pointer
FI_PNT
fracture intersection pointer
FILE_PNT
file pointer
FIS_PNT
FISH pointer
FLT
floating-point number
FR_PNT
fracture pointer
FV_PNT
fracture vertex pointer
GE_PNT
geometric edge pointer
GN_PNT
geometric node pointer
GPOL_PNT
geometric polygon pointer
GSET
geometric set indicator (can be a name, pointer, or ID)
GSET_PNT
geometric set pointer
IND
general index
INT
integer number
LAB_PNT
pointer to a label
LIST
pointer to a list (or container) of objects
MAT
matrix
MAT_PNT
matrix pointer
MAP
map (associative container)
MEM_PNT
pointer to a memitem
MEAS_PNT
measurement region pointer
NULL
null pointer
NUM
floating-point or integer number
PNT
general pointer
PV_PNT
pointer to a plot view in the user interface
RAN
range descriptor—string or named-range pointer
RAN_PNT
pointer to a named range
SOCK
socket descriptor—integer or socket pointer
SOCK_PNT
pointer to a socket
STR
string
STRUC_PNT
FISH structure pointer
TAB
table descriptor—integer, string, or table pointer
TAB_PNT
table pointer
TEN
tensor
TEN_PNT
tensor pointer
UDS_PNT
user-defined scalar pointer
UDT_PNT
user-defined tensor pointer
UDV_PNT
user-defined vector pointer
V2
2D vector
V2+
2D vector, which can be entered as either a single vector argument or two NUM arguments
V3
3D vector
V3+
3D vector, which can be entered as either a single vector argument or three NUM arguments
VEC
2D or 3D vector
VEC+
2D or 3D vector, which can be entered as either a single vector argument or as two to three NUM arguments
VOID
void return type
W_PNT
wall pointer
WF_PNT
wall facet pointer
WFTH_PNT
wall thermal facet pointer
WTH_PNT
wall thermal pointer
WV_PNT
wall vertex pointer
Table 1: 3DEC Types
BC_IND block contact index
BC_PNT block contact pointer
BF_IND block face index
BF_PNT block face pointer
BFEF_PNT finite element block face pointer
BFE_PNT finite element block pointer
BGP_IND block gridpoint index
BGP_PNT block gridpoint pointer
BL_PNT block pointer
BSC_IND block subcontact index
BSC_PNT block subcontact pointer
BZ_IND block zone index
BZ_PNT block zone pointer
B_IND block index
FB_IND fblock index
FB_PNT fblock pointer
FK_IND flowknot index
FK_PNT flowknot pointer
FP_IND flowplane index
FP_PNT flowplane pointer
FPV_IND flowplane vertex index
FPV_PNT flowplane vertex pointer
FPZ_PNT flowplane zone pointer
F_PNT flowplane pointer
PFZ_IND flowplane zone index
SB_IND sel beam index
SB_PNT sel beam pointer
SB_IND sel cable index
SB_PNT sel cable pointer
SL_IND sel liner index
SL_PNT sel liner pointer
SN_IND sel node index
SN_PNT sel node pointer
SP_PNT sel prop pointer
SR_IND sel reinforcement index
SR_PNT sel reinforcement pointer