Error Handling

On success, S3L_fft_setup returns S3L_SUCCESS.

S3L_fft_setup performs generic checking of the validity of the arrays it accepts as arguments. If an array argument contains an invalid or corrupted value, the function terminates and an error code indicating which value of the array handle was invalid is returned. See Appendix A of this manual for a detailed list of these error codes.

The following conditions will cause S3L_fft_setup to terminate and return the associated error code:

• S3L_ERR_FFT_RANKGT3 - The rank of array a is larger than 3.

• S3L_ERR_ARG_NCOMPLEX - a is not of type S3L_complex or S3L_double_complex.

• S3L_ERR__FFT_EXTSQPROCS - a is a 1D array, but its extent is not a multiple of the square of the number of processes over which it was defined.