free_Helmholtz_2D/free_Helmholtz_3D
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 theFFT interface (for details, refer toFFT Functions). The structureIntel® oneAPI Math Kernel Libraryyhandleis used only byfree_Helmholtz_3D.
- ipar
- MKL_INTarray of size 128. Contains integer data used by Fast Helmholtz Solver (for details, refer toipar).
Output Parameters
- xhandle, yhandle
- Data structures used by theFFT interface. Memory allocated for the structures is released on output.Intel® oneAPI Math Kernel Library
- ipar
- Contains integer data used by Fast Helmholtz Solver. On output, the status of the routine call is written toipar[0].
- stat
- MKL_INT*. Routine completion status, which is also written toipar[0].
Description
The FFT functions. To release memory allocated for other parameters, include memory release statements in your code.
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
Return Values
- stat= 0
- The routine successfully completed the task.
- stat= -1000
- The routine stopped because of anFFT or TT interface error.Intel® oneAPI Math Kernel Library
- stat= -99999
- The routine failed to complete the task because of a fatal error.