kml_fft(f/h)_mpi_local_size_many_1d

描述了本地进程数据的大小和位置,以及计算需要分配的空间。

接口定义

C interface:

ptrdiff_t kml_fft_mpi_local_size_many_1d(ptrdiff_t n0, ptrdiff_t howmany, MPI_Comm comm, int sign, unsigned flags, ptrdiff_t *local_ni, ptrdiff_t *local_i_start, ptrdiff_t *local_no, ptrdiff_t *local_o_start);

ptrdiff_t kml_fftf_mpi_local_size_many_1d(ptrdiff_t n0, ptrdiff_t howmany, MPI_Comm comm, int sign, unsigned flags, ptrdiff_t *local_ni, ptrdiff_t *local_i_start, ptrdiff_t *local_no, ptrdiff_t *local_o_start);

ptrdiff_t kml_ffth_mpi_local_size_many_1d(ptrdiff_t n0, ptrdiff_t howmany, MPI_Comm comm, int sign, unsigned flags, ptrdiff_t *local_ni, ptrdiff_t *local_i_start, ptrdiff_t *local_no, ptrdiff_t *local_o_start);

返回值

函数返回一个ptrdiff_t类型的值,表示要分配的元素的数量(复数,对于复数DFT);local_ni和local_i_start参数返回存储在此过程中的转换输入的1d数组的一部分(local_i_start~local_i_start+local_ni-1);local_no和local_o_start参数返回存储在此过程中的转换输出的1d数组的一部分(local_o_start~local_o_start+local_no-1)。

参数

参数名

数据类型

描述

输入/输出

n0

ptrdiff_t

1D FFT待处理数据大小,约束:n0 ≥ 1。

输入

howmany

ptrdiff_t

howmany表示要多少个变换,与创建plan时传入参数匹配。

输入

comm

MPI_Comm

MPI通信器的句柄。

输入

sign

int

与创建plan时传入的参数匹配。

输入

flags

unsigned int

与创建plan时传入的参数匹配。

输入

local_ni

ptrdiff_t*

本地进程输入数据大小。

输出

local_i_start

ptrdiff_t*

本地进程输入数据相对全局输入数据起点偏移量。

输出

local_no

ptrdiff_t*

本地进程输出数据大小。

输出

local_o_start

ptrdiff_t*

本地进程输出数据相对全局输出数据起点偏移量。

输出

依赖

C: "kfft-mpi.h"

示例

    const ptrdiff_t N0 = 4;
    kml_fft_plan plan;
    ptrdiff_t alloc_local, local_ni, local_i_start, local_no, local_o_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;
    ptrdiff_t howmany = 1;
    /* get local data size and allocate */
    alloc_local = kml_fft_mpi_local_size_many_1d(N0, howmany, comm, KML_FFT_FORWARD, KML_FFT_MPI_TRANSPOSED_IN,
                                            &local_ni, &local_i_start, &local_no, &local_o_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_1d(N0, in, out, comm,
                                KML_FFT_FORWARD, KML_FFT_MPI_TRANSPOSED_IN);    
            
    /* compute transforms, in-place, as many times as desired */
    kml_fft_execute_dft(plan, int, out);
    kml_fft_destroy_plan(plan);
    MPI_Finalize();
    return 0;