Error Handling

On success, S3L_rc_fft_setup returns S3L_SUCCESS.

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

• S3L_ERR_ARG_RANK - The rank of array a is not 1, 2, or 3.

• S3L_ERR_ARG_NREAL - The data type of a is not real.

• S3L_ERR_ARG_NEVEN - Some of the extents of a are not even.

• S3L_ERR_ARG_EXTENTS - The extents of a are not correct for the rank of a and the number of processors over which a is distributed. This relationship is summarized below:

  • If a is 1D, its length must be divisible by 4*sqr(np) where np is the number of processes over which the a is distributed.

  • If a is 2D, its extents must both be divisible by 2*np

  • If a is 3D, its first extent must be even and its last two extents must both be divisible by 2*np.