FreeDescriptorDM

Syntax

Fortran:

Status = DftiFreeDescriptorDM(handle)

C/C++:

status = DftiFreeDescriptorDM(&handle);

Include Files

The Fortran interface is specified in the mkl_cdft.f90 include file and the C interface is specified in the mkl_cdft.h include file.

Input Parameters

handle

The descriptor handle. Must be valid, that is, created in a call to DftiCreateDescriptorDM.

Output Parameters

Description

This function frees up all memory allocated for a descriptor in a particular MPI process. Call the DftiFreeDescriptorDM function to delete the descriptor handle. Upon successful completion of DftiFreeDescriptorDM the descriptor handle is no longer valid.

Return Values

The function returns DFTI_NO_ERROR when completes successfully. If the function fails, it returns a value of another error class constant (for the list of constants, refer to Error Codes).

Interface and Prototype

! Fortran Interface

INTERFACE DftiFreeDescriptorDM

 INTEGER(4) FUNCTION DftiFreeDescriptorDM(handle)

      TYPE(DFTI_DESCRIPTOR_DM), POINTER :: handle

   END FUNCTION

END INTERFACE

/* C/C++ prototype */ 

MKL_LONG DftiFreeDescriptorDM(DFTI_DESCRIPTOR_DM_HANDLE *handle);