cg_iRIC_Read_BC_String_WithGridId

Reads the value of a string boundary condition.

Format (FORTRAN)

call cg_iRIC_Read_BC_String_WithGridId(fid, gid, type, num, name, strvalue, ier)

Format (C/C++)

ier = cg_iRIC_Read_BC_String_WithGridId(fid, gid, type, num, name, strvalue)

Format (Python)

strvalue = cg_iRIC_Read_BC_String_WithGridId(fid, gid, type, num, name)

Arguments and returned value

fid

Table 268 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 269 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 270 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 271 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 272 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

strvalue

Table 273 Description of strvalue

Item

Value

Name

strvalue

Input/Output

Output

Description

The value of the condition

Data type (FORTRAN)

character(*)

Data type (C/C++)

char*

Data type (Python)

str

ier

Table 274 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)