free_Helmholtz_2D/free_Helmholtz

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

Syntax

void free_Helmholtz_2D(DFTI_DESCRIPTOR_HANDLE* xhandle, int* ipar, int* stat);

void free_Helmholtz_3D(DFTI_DESCRIPTOR_HANDLE* xhandle, DFTI_DESCRIPTOR_HANDLE* yhandle, int* ipar, int* stat);

Include Files

The Fortran interfaces are specified in the mkl_poisson.f90 include file and the C interfaces are specified in the mkl_poisson.h include file.

Input Parameters

xhandle, yhandle	DFTI_DESCRIPTOR_HANDLE*. Data structures used by the Intel MKL FFT interface (for details, refer to FFT Functions). The structure yhandle is used only by free_Helmholtz_3D.
ipar	int array of size 128. Contains integer data to be used by Fast Helmholtz Solver (for details, refer to Common Parameters).

Output Parameters

xhandle, yhandle	Data structures used by the Intel MKL FFT interface. Memory allocated for the structures is released on output.
ipar	Contains integer data to be used by Fast Helmholtz Solver. Status of the routine call is written to ipar[0].
stat	int*. Routine completion status, which is also written to ipar[0].

Description

The free_Helmholtz_2D-free_Helmholtz_3D routine cleans the memory used by the xhandle and yhandle structures, needed for calling the Intel MKL FFT functions. To release memory allocated for other parameters, include cleaning of the memory in your code.

Return Values