Developer Reference

  • 2020.2
  • 07/15/2020
  • Public Content
Contents

pardiso_getenv_f, pardiso_setenv_f,
pardiso_getenv, pardiso_setenv

Retrieves additional values from or sets additional values in the
Intel® MKL
PARDISO handle (deprecated).

Syntax

error = pardiso_getenv_f
(
handle
,
param
,
value
)
error = pardiso_setenv_f
(
handle
,
param
,
value
)
error = pardiso_getenv
(
handle
,
param
,
value
)
error = pardiso_setenv
(
handle
,
param
,
value
)
The
pardiso_getenv
and
pardiso_setenv
interfaces are deprecated; use
pardiso_getenv_f
and
pardiso_setenv_f
instead.
Include Files
  • mkl.fi
    ,
    mkl_pardiso.f90
pardiso_setenv
requires the
value
parameter to be converted to the string in C notation if it is called from Fortran. You can do this using
mkl_cvt_to_null_terminated_str
subroutine declared in the
mkl_dss.f90
include file.
Description
These functions operate with the
Intel® MKL
PARDISO handle. The
pardiso_getenv_f
routine retrieves additional values from the
Intel® MKL
PARDISO handle, and
pardiso_setenv_f
sets specified values in the
Intel® MKL
PARDISO handle.
The
pardiso_getenv
and
pardiso_setenv
routines (deprecated) provide similar functionality.
These functions enable retrieving and setting the name of the
Intel® MKL
PARDISO OOC file.
To retrieve the
Intel® MKL
PARDISO OOC file name, you can apply this function to any properly-created handle.
To set the
Intel® MKL
PARDISO OOC file name in the handle you must call the function before the reordering stage. This is because the OOC file name is stored in the handle after the reordering stage and it is not changed during further computations.
A 1024-byte internal buffer is used inside
Intel® MKL
PARDISO for storing the OOC file name. Allocate a 1024-byte buffer for passing to the
pardiso_getenv_f
or
pardiso_getenv
function as the
value
parameter.
Input Parameters
handle
Fortran:
MKL_FORTRAN_HANDLE
Intel® MKL
PARDISO handle for which to set and from which to retrieve information. (SeeDSS Interface Description for structure description)
param
Fortran:
INTEGER
.
Specifies the required parameter. The only value is
PARDISO_OOC_FILE_NAME
, defined in the corresponding include file.
value
Fortran:
CHARACTER
*1024
array.
Input parameter for
pardiso_setenv_f
and
pardiso_setenv
. Contains the name of the OOC file that must be used in the handle.
This string must be null-terminated (terminated with
CHAR(0)
).
Output Parameters
handle
Output parameter for
pardiso_setenv_f
and
pardiso_setenv
. Data object of the
MKL_DSS_HANDLE
type (see DSS Interface Description).
value
Output parameter for
pardiso_getenv_f
and
pardiso_getenv
. Contains the name of the OOC file
as a null-terminated string,
which must be used in the handle.

Example (FORTRAN)

INCLUDE 'mkl_pardiso.f90' INCLUDE 'mkl_dss.f90' PROGRAM pardiso_sym_f90 USE mkl_pardiso USE mkl_dss INTEGER*8 pt(64) CHARACTER*1024 file_name INTEGER error pt(1:64) = 0 file_name = 'pardiso_ooc_file'//CHAR(0) error = pardiso_setenv_f(pt, PARDISO_OOC_FILE_NAME, file_name) ! call pardiso() here END PROGRAM

Product and Performance Information

1

Intel's compilers may or may not optim