libvhcall-fortran
2.13.0
|
VH call Fortran API provides features which invoke Fortran subroutine or function on VH side from a VE program. More...
Data Types | |
interface | fvhcall_args_set |
Interface of setting value to VH Call arguments object. More... | |
Public Member Functions | |
integer(int64) function | fvhcall_install (libName) |
Load a VH library. More... | |
integer(int64) function | fvhcall_find (handle, symbolName) |
Find a symbol in VH library. More... | |
integer function | fvhcall_uninstall (handle) |
Unload a VH library. More... | |
integer(int64) function | fvhcall_args_alloc () |
Allocate VH Call arguments object. More... | |
integer(int64) function | fvhcall_args_alloc_num (num) |
Allocate VH Call arguments object which can contain optional argument. More... | |
subroutine | fvhcall_args_clear (args) |
Clear VH Call arguments object. More... | |
subroutine | fvhcall_args_free (args) |
Free VH Call arguments object. More... | |
integer function | fvhcall_invoke_with_args (symID, args, retval) |
Invoke a function or subroutine in VH library with passing arguments. More... | |
integer function | fvhcall_args_set_string (args, intent, argnum, val) |
Set a character(len=n) argument: n is the length of character (n>=1). More... | |
integer function | fvhcall_args_set_integer (args, intent, argnum, val) |
Set an integer argument. More... | |
integer function | fvhcall_args_set_iarr_d1 (args, intent, argnum, val) |
Set an argument of 1 dimensional array of type integer. More... | |
integer function | fvhcall_args_set_iarr_d2 (args, intent, argnum, val) |
Set an argument of 2 dimensional array of type integer. More... | |
integer function | fvhcall_args_set_iarr_d3 (args, intent, argnum, val) |
Set an argument of 3 dimensional array of type integer. More... | |
integer function | fvhcall_args_set_integer8 (args, intent, argnum, val) |
Set an integer(kind=8) argument. More... | |
integer function | fvhcall_args_set_i8arr_d1 (args, intent, argnum, val) |
Set an argument of 1 dimensional array of type integer(kind=8). More... | |
integer function | fvhcall_args_set_i8arr_d2 (args, intent, argnum, val) |
Set an argument of 2 dimensional array of type integer(kind=8). More... | |
integer function | fvhcall_args_set_i8arr_d3 (args, intent, argnum, val) |
Set an argument of 3 dimensional array of type integer(kind=8). More... | |
integer function | fvhcall_args_set_real (args, intent, argnum, val) |
Set a real argument. More... | |
integer function | fvhcall_args_set_rarr_d1 (args, intent, argnum, val) |
Set an argument of 1 dimensional array of type real. More... | |
integer function | fvhcall_args_set_rarr_d2 (args, intent, argnum, val) |
Set an argument of 2 dimensional array of type real. More... | |
integer function | fvhcall_args_set_rarr_d3 (args, intent, argnum, val) |
Set an argument of 3 dimensional array of type real. More... | |
integer function | fvhcall_args_set_double (args, intent, argnum, val) |
Set a double argument. More... | |
integer function | fvhcall_args_set_darr_d1 (args, intent, argnum, val) |
Set an argument of 1 dimensional array of type double. More... | |
integer function | fvhcall_args_set_darr_d2 (args, intent, argnum, val) |
Set an argument of 2 dimensional array of type double. More... | |
integer function | fvhcall_args_set_darr_d3 (args, intent, argnum, val) |
Set an argument of 3 dimensional array of type double. More... | |
integer function | fvhcall_args_set_complex (args, intent, argnum, val) |
Set a complex argument. More... | |
integer function | fvhcall_args_set_carr_d1 (args, intent, argnum, val) |
Set an argument of 1 dimensional array of type complex. More... | |
integer function | fvhcall_args_set_carr_d2 (args, intent, argnum, val) |
Set an argument of 2 dimensional array of type complex. More... | |
integer function | fvhcall_args_set_carr_d3 (args, intent, argnum, val) |
Set an argument of 3 dimensional array of type complex. More... | |
integer function | fvhcall_args_set_double_complex (args, intent, argnum, val) |
Set a double complex argument. More... | |
integer function | fvhcall_args_set_dcarr_d1 (args, intent, argnum, val) |
Set an argument of 1 dimensional array of type double complex. More... | |
integer function | fvhcall_args_set_dcarr_d2 (args, intent, argnum, val) |
Set an argument of 2 dimensional array of type double complex. More... | |
integer function | fvhcall_args_set_dcarr_d3 (args, intent, argnum, val) |
Set an argument of 3 dimensional array of type double complex. More... | |
integer function | fvhcall_args_set_charr_d1 (args, intent, argnum, val) |
Set an argument of 1 dimensional array of type character. More... | |
integer function | fvhcall_args_set_charr_d2 (args, intent, argnum, val) |
Set an argument of 2 dimensional array of type character. More... | |
integer function | fvhcall_args_set_charr_d3 (args, intent, argnum, val) |
Set an argument of 3 dimensional array of type character. More... | |
Public Attributes | |
integer, parameter | fvhcall_intent_in =1 |
Intent of argument. More... | |
integer, parameter | fvhcall_intent_out =3 |
Intent of argument. More... | |
integer, parameter | fvhcall_intent_inout =2 |
Intent of argument. More... | |
VH call Fortran API provides features which invoke Fortran subroutine or function on VH side from a VE program.
The arguments need to be string, scalar or 1-3 dimensional array.
The return value of function needs to be 64bit INTEGER.
Please add the following code and specify -lvhcall_fortran option to compile VE fortran program.
integer(int64) function vhcall_fortran::fvhcall_install | ( | character(len=*), intent(in) | libName | ) |
Load a VH library.
[in] | libName | file name to load on VH |
integer(int64) function vhcall_fortran::fvhcall_find | ( | integer(int64) | handle, |
character(len=*), intent(in) | symbolName | ||
) |
Find a symbol in VH library.
[in] | handle | 64-bit integer specifying handle of VH library |
[in] | symbolName | the name of function or subroutine. Function or subroutine in module is found by moduleName::symbolName. |
integer function vhcall_fortran::fvhcall_uninstall | ( | integer(int64) | handle | ) |
Unload a VH library.
[in] | handle | 64-bit integer specifying handle of the VH library |
integer(int64) function vhcall_fortran::fvhcall_args_alloc | ( | ) |
Allocate VH Call arguments object.
integer(int64) function vhcall_fortran::fvhcall_args_alloc_num | ( | integer | num | ) |
Allocate VH Call arguments object which can contain optional argument.
[in] | num | number of arguments. |
subroutine vhcall_fortran::fvhcall_args_clear | ( | integer(int64) | args | ) |
Clear VH Call arguments object.
[in] | args | 64-bit integer specifying arguments object |
subroutine vhcall_fortran::fvhcall_args_free | ( | integer(int64) | args | ) |
Free VH Call arguments object.
[in] | args | 64-bit integer specifying arguments object |
integer function vhcall_fortran::fvhcall_invoke_with_args | ( | integer(int64) | symID, |
integer(int64) | args, | ||
integer(int64), optional, target | retval | ||
) |
Invoke a function or subroutine in VH library with passing arguments.
[in] | symID | 64-bit integer specifying symbol of the VH subroutine or function |
[in] | args | 64-bit integer specifying arguments object |
[out] | retval | 64-bit integer return value of VH library function. This is omitted when symID specifies subroutine. |
integer function vhcall_fortran::fvhcall_args_set_string | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
character(len=*), target | val | ||
) |
Set a character(len=n) argument: n is the length of character (n>=1).
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_integer | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
integer, target | val | ||
) |
Set an integer argument.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_iarr_d1 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
integer, dimension(:), target | val | ||
) |
Set an argument of 1 dimensional array of type integer.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_iarr_d2 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
integer, dimension(:,:), target | val | ||
) |
Set an argument of 2 dimensional array of type integer.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_iarr_d3 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
integer, dimension(:,:,:), target | val | ||
) |
Set an argument of 3 dimensional array of type integer.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_integer8 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
integer(kind=8), target | val | ||
) |
Set an integer(kind=8) argument.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_i8arr_d1 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
integer(kind=8), dimension(:), target | val | ||
) |
Set an argument of 1 dimensional array of type integer(kind=8).
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_i8arr_d2 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
integer(kind=8), dimension(:,:), target | val | ||
) |
Set an argument of 2 dimensional array of type integer(kind=8).
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_i8arr_d3 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
integer(kind=8), dimension(:,:,:), target | val | ||
) |
Set an argument of 3 dimensional array of type integer(kind=8).
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_real | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
real, target | val | ||
) |
Set a real argument.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_rarr_d1 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
real, dimension(:), target | val | ||
) |
Set an argument of 1 dimensional array of type real.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_rarr_d2 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
real, dimension(:,:), target | val | ||
) |
Set an argument of 2 dimensional array of type real.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_rarr_d3 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
real, dimension(:,:,:), target | val | ||
) |
Set an argument of 3 dimensional array of type real.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_double | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
double precision, target | val | ||
) |
Set a double argument.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_darr_d1 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
double precision, dimension(:), target | val | ||
) |
Set an argument of 1 dimensional array of type double.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_darr_d2 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
double precision, dimension(:,:), target | val | ||
) |
Set an argument of 2 dimensional array of type double.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_darr_d3 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
double precision, dimension(:,:,:), target | val | ||
) |
Set an argument of 3 dimensional array of type double.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_complex | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
complex, target | val | ||
) |
Set a complex argument.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_carr_d1 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
complex, dimension(:), target | val | ||
) |
Set an argument of 1 dimensional array of type complex.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_carr_d2 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
complex, dimension(:,:), target | val | ||
) |
Set an argument of 2 dimensional array of type complex.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_carr_d3 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
complex, dimension(:,:,:), target | val | ||
) |
Set an argument of 3 dimensional array of type complex.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_double_complex | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
complex(kind(0d0)), target | val | ||
) |
Set a double complex argument.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_dcarr_d1 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
complex(kind(0d0)), dimension(:), target | val | ||
) |
Set an argument of 1 dimensional array of type double complex.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_dcarr_d2 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
complex(kind(0d0)), dimension(:,:), target | val | ||
) |
Set an argument of 2 dimensional array of type double complex.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_dcarr_d3 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
complex(kind(0d0)), dimension(:,:,:), target | val | ||
) |
Set an argument of 3 dimensional array of type double complex.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_charr_d1 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
character, dimension(:), target | val | ||
) |
Set an argument of 1 dimensional array of type character.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_charr_d2 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
character, dimension(:,:), target | val | ||
) |
Set an argument of 2 dimensional array of type character.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer function vhcall_fortran::fvhcall_args_set_charr_d3 | ( | integer(int64) | args, |
integer | intent, | ||
integer | argnum, | ||
character, dimension(:,:,:), target | val | ||
) |
Set an argument of 3 dimensional array of type character.
[in] | args | 64-bit integer specifying arguments object |
[in] | intent | parameter of fvhcall_intent_[in/out/inout]. This specifies what the argument is used for input, output or input/output. |
[in] | argnum | the argnum-th argument of callee function (counting from 1). |
[in] | val | value to be set |
integer, parameter vhcall_fortran::fvhcall_intent_in =1 |
Intent of argument.
Argument is used as input
integer, parameter vhcall_fortran::fvhcall_intent_out =3 |
Intent of argument.
Argument is used as output.
integer, parameter vhcall_fortran::fvhcall_intent_inout =2 |
Intent of argument.
Argument is used as input and output.