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

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

#### 接口定义

C interface：

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

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

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

Fortran interface：

RES = KML_FFT_PLAN_DFT_3D(N0, N1, N2, IN, OUT, SIGN, FLAGS);

RES = KML_FFTF_PLAN_DFT_3D(N0, N1, N2, IN, OUT, SIGN, FLAGS);

RES = KML_FFTH_PLAN_DFT_3D(N0, N1, N2, IN, OUT, SIGN, FLAGS);


#### 返回值

函数返回一个kml_fft(f/h)_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\* | 输出快速傅里叶变换后的数据。 | 输出 |
| sign | int | 描述正向变换或反向变换。 \-1(KML\_FFT\_FORWARD)：forward +1(KML\_FFT\_BACKWARD)：backward | 输入 |
| flags | unsigned int | planning选项，描述ESTIMATE模式或PATIENT模式。 KML\_FFT\_ESTIMATE：ESTIMATE模式 KML\_FFT\_PATIENT：PATIENT模式 | 输入 |


#### 依赖

C: "kfft.h"


#### 示例

C interface：

```
int n0 = 2;
int n1 = 3;
int n2 = 2;
double init[12][2] = {{120, 0}, {8, 8}, {0, 0}, {0, 16}, {0, 16}, {-8, 8}, {-8, 0}, {-8, 8}, {-16, 0}, {0, -16}, {-40, 8}, {-8, -8}};
kml_fft_complex *in;
in = (kml_fft_complex*)kml_fft_malloc(sizeof(kml_fft_complex) * n0 * n1 * n2);
for (int i = 0; i < n0 * n1 * n2; i++) {
in[i][0] = init[i][0];
in[i][1] = init[i][1];
}
kml_fft_complex *out;
out = (kml_fft_complex*)kml_fft_malloc(sizeof(kml_fft_complex) * n0 * n1 * n2);
kml_fft_plan plan;
plan = kml_fft_plan_dft_3d(n0, n1, n2, in, out, KML_FFT_FORWARD, KML_FFT_ESTIMATE);
kml_fft_execute_dft(plan, in, out);
kml_fft_destroy_plan(plan);
kml_fft_free(in);
kml_fft_free(out);
/*
* out = {{4.000000e+01, 4.000000e+01}, {7.200000e+01, 8.000000e+00},
*        {1.272154e+02, -3.064102e+01}, {1.112154e+02, -3.492820e+01},
*        {1.687846e+02, 3.864102e+01}, {1.527846e+02, -2.107180e+01},
*        {2.000000e+02, 5.600000e+01}, {1.680000e+02, -4.000000e+01},
*        {1.229282e+02, -7.215390e+00}, {6.321539e+01, 4.078461e+01},
*        {1.090718e+02, -4.878461e+01}, {1.047846e+02, -7.846097e-01}}
*/
```

Fortran interface：

```
INTEGER(C_INT) :: N0 = 2
INTEGER(C_INT) :: N1 = 3
INTEGER(C_INT) :: N2 = 2
REAL(C_DOUBLE), DIMENSION(12, 2) :: INIT
TYPE(KML_FFT_COMPLEX), POINTER :: IN(:), OUT(:)
TYPE(C_PTR) :: PIN, POUT
TYPE(C_SIZE_T) :: SIZE
SIZE = 16 * N0 * N1 * N2
PIN = KML_FFT_MALLOC(SIZE)
POUT = KML_FFT_MALLOC(SIZE)
CALL C_F_POINTER(PIN, IN, SHAPE=[N0 * N1 * N2])
CALL C_F_POINTER(POUT, OUT, SHAPE=[N0 * N1 * N2])
DATA INIT/120, 8, 0, 0, 0, -8, -8, -8, -16, 0, -40, -8, 0, 8, 0, 16, 16, 8, 0, 8, 0, -16, 8, -8/
INTEGER :: I = 1
DO WHILE(I <= N0 * N1 * N2)
IN(I)%R = INIT(I, 0)
IN(I)%I = INIT(I, 1)
I = I + 1
END DO
TYPE(C_PTR) :: PLAN
PLAN = KML_FFT_PLAN_DFT_3D(N0, N1, N2, IN, OUT, KML_FFT_FORWARD, KML_FFT_ESTIMATE)
CALL KML_FFT_EXECUTE_DFT(PLAN, IN, OUT)
CALL KML_FFT_DESTROY_PLAN(PLAN)
CALL KML_FFT_FREE(PIN)
CALL KML_FFT_FREE(POUT)
!
! OUT = /4.000000E+01, 4.000000E+01, 7.200000E+01, 8.000000E+00,
!        1.272154E+02, -3.064102E+01, 1.112154E+02, -3.492820E+01,
!        1.687846E+02, 3.864102E+01, 1.527846E+02, -2.107180E+01,
!        2.000000E+02, 5.600000E+01, 1.680000E+02, -4.000000E+01,
!        1.229282E+02, -7.215390E+00, 6.321539E+01, 4.078461E+01,
!        1.090718E+02, -4.878461E+01, 1.047846E+02, -7.846097E-01/
!
```