---
title: kml_fft(f/h)_mpi_plan_dft
description: "C interface："
url: https://www.hikunpeng.com/document/detail/zh/kunpengaccel/math-lib/devg-kml/kunpengaccel_kml_0336.html
sourcePath: /source/zh/kunpengaccel/math-lib/devg-kml/kunpengaccel_kml_0336.html
indexId: 1743412c0543e9dd3393aaceea00987d13f7c74a503a1f1a7edf67457b1dcab868
---
# kml_fft(f/h)_mpi_plan_dft

#### 接口定义

C interface：

kml_fft_plan kml_fft_mpi_plan_dft(int rank, const int *n, kml_fft_complex *in, kml_fft_complex *out, MPI_Comm comm, int sign, unsigned flags);

kml_fftf_plan kml_fftf_mpi_plan_dft(int rank, const int *n, kml_fftf_complex *in, kml_fftf_complex *out, MPI_Comm comm, int sign, unsigned flags);

kml_ffth_plan kml_ffth_mpi_plan_dft(int rank, const int *n, kml_ffth_complex *in, kml_ffth_complex *out, MPI_Comm comm, int sign, unsigned flags);


#### 返回值

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

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


#### 参数

| 参数名 | 数据类型 | 描述 | 输入/输出 |
| --- | --- | --- | --- |
| rank | int | FFT变换的维度是rank。约束：1≤rank≤3。 | 输入 |
| n | const int \* | n是维度为rank的数组，包含FFT序列每一维度的大小。约束：n[i]≥1, for i in 0 to rank \- 1。 | 输入 |
| in | 双精度：kml\_fft\_complex\* 单精度：kml\_fftf\_complex\* 半精度：kml\_ffth\_complex\* | 输入待变换的数据。 | 输入 |
| out | 双精度：kml\_fft\_complex\* 单精度：kml\_fftf\_complex\* 半精度：kml\_ffth\_complex\* | 输出快速傅里叶变换后的数据。 | 输出 |
| comm | MPI\_Comm | MPI通信器的句柄。 | 输入 |
| sign | int | 描述正向变换或反向变换。 \-1(KML\_FFT\_FORWARD)：forward +1(KML\_FFT\_BACKWARD)：backward | 输入 |
| flags | unsigned int | planning选项，未使用。 | 输入 |


#### 依赖

C: "kfft-mpi.h"


#### 示例

```
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;
ptrdiff_t rank = 2;
ptrdiff_t *n = (ptrdiff_t *)kml_fft_malloc(sizeof(ptrdiff_t) * rank);
n[0] = 3;
n[1] = 4;
/* get local data size and allocate */
alloc_local = kml_fft_mpi_local_size(rank, n, 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(rank, n, 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);
kml_fft_mpi_cleanup();
MPI_Finalize();
```