kml_fft(f/h)_ mpi_plan_r2r_2d

接口定义

C interface：

kml_fft_plan kml_fft_mpi_plan_r2r_2d(ptrdiff_t n0, ptrdiff_t n1, double *in, double *out, kml_fft_r2r_kind kind0, kml_fft_r2r_kind kind1, MPI_comm comm, unsigned flags);

kml_fftf_plan kml_fftf_mpi_plan_r2r_2d(ptrdiff_t n0, ptrdiff_t n1, float *in, float *out, kml_fftf_r2r_kind kind0, kml_fftf_r2r_kind kind1, MPI_comm comm, unsigned flags);

kml_ffth_plan kml_ffth_mpi_plan_r2r_2d(ptrdiff_t n0, ptrdiff_t n1, __fp16 *in, __fp16 *out, kml_ffth_r2r_kind kind0, kml_ffth_r2r_kind kind1, MPI_comm comm, unsigned flags);

返回值

函数返回一个kml_fft(f)_plan类型的结构体指针。将该对象作为参数传入kml_fft(f)_execute函数中使用，将对当前提供的输入in和输出out执行FFT变换；另外，也可以通过将该对象作为参数传入kml_fft(f)_execute_r2r函数中以对新的输入in和输出out执行FFT变换。

如果函数返回非空指针，则表示plan执行成功，否则表示执行失败。

参数

依赖

C: "kfft-mpi.h"

示例

C interface：

    const ptrdiff_t N0 = 4, N1 = 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_r2r_kind kind0 = KML_FFT_R2HC;
    kml_fft_r2r_kind kind1 = KML_FFT_R2HC;
    double *in = NULL;
    double *out = NULL;
 
    /* get local data size and allocate */
    alloc_local = kml_fft_mpi_local_size_2d(N0, N1, comm, &local_n0, &local_0_start);
    if (alloc_local == -1) {
        printf("[%s][%d] allocate size fail!!!\n", __func__, __LINE__);
    }
    in = (double *)kml_fft_malloc(sizeof(double) * alloc_local);
    if (in == NULL) {
        printf("[%s][%d] malloc memory fail!!!\n", __func__, __LINE__);
    }
    out = (double *)kml_fft_malloc(sizeof(double) * 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_r2r_2d(N0, N1, in, out, comm, kind0, kind1, KML_FFT_MPI_TRANSPOSED_IN);    
            
    /* compute transforms, in-place, as many times as desired */
    kml_fft_execute_r2r(plan, in, out);
 
    kml_fft_destroy_plan(plan);
    kml_fft_mpi_cleanup();
 
    MPI_Finalize();