---
title: kml_fft(f/h)_mpi_plan_dft_3d
description: "建立单个连续数据序列3维C2C变换的plan。"
url: https://www.hikunpeng.com/document/detail/zh/kunpenghpcs/hpckit/devg/kunpengaccel_kml_0360.html
sourcePath: /source/zh/kunpenghpcs/hpckit/devg/kunpengaccel_kml_0360.html
indexId: 4a9e89bbb6d700faab6302af0f5266fb555451fa09e1f90e250c4a84b5256c2261
---
# kml_fft(f/h)_mpi_plan_dft_3d

建立单个连续数据序列3维C2C变换的plan。

#### 接口定义

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);


#### 返回值

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

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


#### 参数

| 参数名 | 数据类型 | 描述 | 输入/输出 |
| --- | --- | --- | --- |
| n0 | int | 输入FFT序列第一维的大小，约束：n0≥1。 | 输入 |
| n1 | int | 输入FFT序列第二维的大小，约束：n1≥1。 | 输入 |
| n2 | int | 输入FFT序列第三维的大小，约束：n2≥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选项，可设置为如下选项： KML\_FFT\_ESTIMATE：ESTIMATE模式 KML\_FFT\_PATIENT：PATIENT模式 KML\_FFT\_MPI\_SCRAMBLED\_[IN\|OUT]：表示输入/输出按照scrambled格式，仅对一维变换生效 KML\_FFT\_MPI\_TRANSPOSED\_[IN\|OUT]：表示输入/输出由n0 × n1 × n2 × … × nd\-1转化为n1 × n0 × n2 ×…× nd\-1 | 输入 |


#### 依赖

C: "kfft-mpi.h"


#### 示例

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();
```