Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 6/24/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

free_sph_p/free_sph_np

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

Syntax

void free_sph_p(DFTI_DESCRIPTOR_HANDLE* handle_s, DFTI_DESCRIPTOR_HANDLE* handle_c, MKL_INT* ipar, MKL_INT* stat);

void free_sph_np(DFTI_DESCRIPTOR_HANDLE* handle, MKL_INT* ipar, MKL_INT* stat);

Include Files

  • mkl_poisson.f90

Input Parameters

handle_s, handle_c, handle

DFTI_DESCRIPTOR_HANDLE*. Data structures used by the Intel® oneAPI Math Kernel Library (oneMKL) FFT interface (for details, refer toFFT Functions). The structures handle_s and handle_c are used only in free_sph_p, and handle is used only in free_sph_np.

ipar

MKL_INT array of size 128. Contains integer data to be used by Fast Helmholtz Solver on a sphere (for details, refer to ipar).

Output Parameters

handle_s, handle_c, handle

Data structures used by the Intel® oneAPI Math Kernel Library (oneMKL) FFT interface. Memory allocated for the structures is released on output.

ipar

Contains integer data to be used by Fast Helmholtz Solver on a sphere. 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_sph_p/free_sph_np routine releases the memory used by the handle_s, handle_c or handlestructures, needed for calling the Intel® oneAPI Math Kernel Library (oneMKL) 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 (oneMKL) FFT or TT interface error.

stat= -99999

The routine failed to complete the task because of a fatal error.