cg_iRIC_Read_BC_Functional_WithGridId

Reads the variable values (X, Y) of functional boundary condition.

Format (FORTRAN)

call cg_iRIC_Read_BC_Functional_WithGridId(fid, gid, type, num, name, x_arr, y_arr, ier)

Format (C/C++)

ier = cg_iRIC_Read_BC_Functional_WithGridId(fid, gid, type, num, name, x_arr, y_arr)

Format (Python)

x_arr, y_arr = cg_iRIC_Read_BC_Functional_WithGridId(fid, gid, type, num, name)

Arguments and returned value

fid

Table 174 Description of fid

Item	Value
Name	fid
Input/Output	Input
Description	File ID
Data type (FORTRAN)	integer
Data type (C/C++)	int
Data type (Python)	int

gid

Table 175 Description of gid

Item	Value
Name	gid
Input/Output	Input
Description	Grid ID (Start from 1)
Data type (FORTRAN)	integer
Data type (C/C++)	int
Data type (Python)	int

type

Table 176 Description of type

Item	Value
Name	type
Input/Output	Input
Description	The name of the boundary condition
Data type (FORTRAN)	character(*)
Data type (C/C++)	const char*
Data type (Python)	str

num

Table 177 Description of num

Item	Value
Name	num
Input/Output	Input
Description	Boundary condition number
Data type (FORTRAN)	integer
Data type (C/C++)	int
Data type (Python)	int

name

Table 178 Description of name

Item	Value
Name	name
Input/Output	Input
Description	The name of the variable
Data type (FORTRAN)	character(*)
Data type (C/C++)	const char*
Data type (Python)	str

x_arr

Table 179 Description of x_arr

Item	Value
Name	x_arr
Input/Output	Output
Description	The array of X values
Data type (FORTRAN)	double precision, dimension(:)
Data type (C/C++)	double*
Data type (Python)	numpy.array

y_arr

Table 180 Description of y_arr

Item	Value
Name	y_arr
Input/Output	Output
Description	The array of Y values
Data type (FORTRAN)	double precision, dimension(:)
Data type (C/C++)	double*
Data type (Python)	numpy.array

ier

Table 181 Description of ier

Item	Value
Name	ier
Input/Output	Output
Description	Error code. 0 means success, other values mean error.
Data type (FORTRAN)	integer
Data type (C/C++)	int
Data type (Python)	(Not defined)