kml_fft(f/h)_mpi_plan_dft_3d

Create a plan for the three-dimensional C2C transform of a single contiguous data sequence.

Interface Definition

C interface:

kml_fft_plan kml_fft_mpi_plan_dft_3d(int n0, int n1, int n2, kml_fft_complex *in, kml_fft_complex *out, MPI_Comm comm, int sign, unsigned flags);

kml_fftf_plan kml_fftf_mpi_plan_dft_3d(int n0, int n1, int n2, kml_fftf_complex *in, kml_fftf_complex *out, MPI_Comm comm, int sign, unsigned flags);

kml_ffth_plan kml_ffth_mpi_plan_dft_3d(int n0, int n1, int n2, kml_ffth_complex *in, kml_ffth_complex *out, MPI_Comm comm, int sign, unsigned flags);

Return Value

The function returns a structure pointer of the kml_fft(f)_plan type. This object can be passed to the kml_fft(f/h)_execute function as a parameter to perform FFT on the current input and output. It can also be passed to the kml_fft(f/h)_execute_dft function as a parameter to perform FFT on new input and output.

If this function returns a non-null pointer, the plan has been successfully created. Otherwise, the plan fails to be created.

Parameters

Parameter	Data Type	Description	Input/Output
n0	int	Inputs the size of the first dimension in the FFT sequence. The constraint is n0 ≥ 1.	Input
n1	int	Inputs the size of the second dimension in the FFT sequence. The constraint is n1 ≥ 1.	Input
n2	int	Inputs the size of the third dimension in the FFT sequence. The constraint is n2 ≥ 1.	Input
in	Double precision: kml_fft_complex* Single precision: kml_fftf_complex* Half precision: kml_ffth_complex*	Inputs the data to be transformed.	Input
out	Double precision: kml_fft_complex* Single precision: kml_fftf_complex* Half precision: kml_ffth_complex*	Outputs the data generated using FFT.	Output
comm	MPI_Comm	MPI communicator handle	Input
sign	int	Specifies forward or backward transform. -1(KML_FFT_FORWARD): forward +1(KML_FFT_BACKWARD): backward	Input
flags	unsigned int	Planning option, which can be set to: KML_FFT_ESTIMATE: ESTIMATE mode KML_FFT_PATIENT: PATIENT mode KML_FFT_MPI_SCRAMBLED_[IN\|OUT]: The input/output is in scrambled format. This option takes effect only for one-dimensional transform. KML_FFT_MPI_TRANSPOSED_[IN\|OUT]: The input/output is transposed from n₀ × n₁ × n₂ ×... × n_d-1 to n₁ × n₀ × n₂ ×…× n_d-1.	Input

Dependencies

C: "kfft-mpi.h"

Examples

C interface:

    const ptrdiff_t N0 = 4, N1 = 4, N2 = 4;
    kml_fft_plan plan;
    ptrdiff_t alloc_local, local_n0, local_0_start;
 
    MPI_Init(&argc, &argv);
    MPI_Comm comm = MPI_COMM_WORLD;
    kml_fft_mpi_init();
    kml_fft_complex *in = NULL;
    kml_fft_complex *out = NULL;
 
    /* get local data size and allocate */
    alloc_local = kml_fft_mpi_local_size_3d(N0, N1, N2, comm,
                                         &local_n0, &local_0_start);
    if (alloc_local == -1) {
        printf("[%s][%d] allocate size fail.\n", __func__, __LINE__);
    }
    in = (kml_fft_complex *)kml_fft_malloc(sizeof(kml_fft_complex) * alloc_local);
    if (in == NULL) {
        printf("[%s][%d] malloc memory fail.\n", __func__, __LINE__);
    }
    out = (kml_fft_complex *)kml_fft_malloc(sizeof(kml_fft_complex) * alloc_local);
    if (out == NULL) {
        printf("[%s][%d] malloc memory fail.\n", __func__, __LINE__);
    }
 
    /* create plan for in-place forward DFT */
    plan = kml_fft_mpi_plan_dft_3d(N0, N1, N2, in, out, comm,
                                KML_FFT_FORWARD, KML_FFT_MPI_TRANSPOSED_IN);    
            
    /* compute transforms, in-place, as many times as desired */
    kml_fft_execute(plan);
 
    kml_fft_destroy_plan(plan);
 
    MPI_Finalize();

Parent topic: C2C Transforms