Developer Reference for Intel® oneAPI Math Kernel Library - C

Developer Reference

  • 2021.1
  • 12/04/2020
  • Public Content
Contents

free_Helmholtz_2D/free_Helmholtz_3D

Releases the memory allocated for the data structures used by the FFT interface.

Syntax

void free_Helmholtz_2D
(
DFTI_DESCRIPTOR_HANDLE*
xhandle,
MKL_INT*
ipar,
MKL_INT*
stat
)
;
void free_Helmholtz_3D
(
DFTI_DESCRIPTOR_HANDLE*
xhandle,
DFTI_DESCRIPTOR_HANDLE*
yhandle,
MKL_INT*
ipar,
MKL_INT*
stat
)
;
Include Files
  • mkl.h
Input Parameters
xhandle, yhandle
DFTI_DESCRIPTOR_HANDLE*
. Data structures used by the
Intel® oneAPI Math Kernel Library
 FFT interface (for details, refer toFFT Functions). The structure
yhandle
 is used only by
free_Helmholtz_3D
.
ipar
MKL_INT
 array of size 128. Contains integer data used by Fast Helmholtz Solver (for details, refer to
ipar
).
Output Parameters
xhandle, yhandle
Data structures used by the
Intel® oneAPI Math Kernel Library
 FFT interface. Memory allocated for the structures is released on output.
ipar
Contains integer data used by Fast Helmholtz Solver. On output, the status of the routine call is written to
ipar[0]
.
stat
MKL_INT*
. Routine completion status, which is also written to
ipar[0]
.
Description
The
free_Helmholtz_2D-free_Helmholtz_3D
 routine releases the memory used by the
xhandle
 and
yhandle
structures, which are needed for calling the
Intel® oneAPI Math Kernel Library
 FFT functions. To release memory allocated for other parameters, include memory release statements in your code.
Return Values
stat
= 0
The routine successfully completed the task.
stat
= -1000
The routine stopped because of an
Intel® oneAPI Math Kernel Library
 FFT or TT interface error.
stat
= -99999
The routine failed to complete the task because of a fatal error.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.