Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 11/07/2023
Public

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

Document Table of Contents

DftiCommitDescriptorDM

Performs all initialization for the actual FFT computation.

Syntax

Status = DftiCommitDescriptorDM(handle)

Include Files

  • mkl_cdft.f90

Input Parameters

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

Description

The cluster FFT interface requires a function that completes initialization of a previously created descriptor before the descriptor can be used for FFT computations in a particular MPI process. The DftiCommitDescriptorDM function performs all initialization that facilitates the actual FFT computation. For the current implementation, it may involve exploring many different factorizations of the input length to search for a highly efficient computation method.

Any changes of configuration parameters of a committed descriptor via the set value function (see Descriptor Configuration Functions) requires a re-committal of the descriptor before a computation function can be invoked. Typically, this committal function is called right before a computation function call (see FFT Computation Functions).

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

   
INTERFACE DftiCommitDescriptorDM
   INTEGER(4) FUNCTION DftiCommitDescriptorDM(handle);
     TYPE(DFTI_DESCRIPTOR_DM), POINTER :: handle
 END FUNCTION
END INTERFACE