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

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

#### 接口定义

C interface：

kml_fft_plan kml_fft_mpi_plan_r2r_3d(ptrdiff_t n0, ptrdiff_t n1, ptrdiff_t n2, double *in, double *out, kml_fft_r2r_kind kind0, kml_fft_r2r_kind kind1, kml_fft_r2r_kind kind2, MPI_Comm comm, unsigned flags);

kml_fftf_plan kml_fftf_mpi_plan_r2r_3d(ptrdiff_t n0, ptrdiff_t n1, ptrdiff_t n2, float *in, float *out, kml_fftf_r2r_kind kind0, kml_fftf_r2r_kind kind1, kml_fftf_r2r_kind kind2, MPI_Comm comm, unsigned flags);

kml_ffth_plan kml_ffth_mpi_plan_r2r_3d(ptrdiff_t n0, ptrdiff_t n1, ptrdiff_t n2, __fp16 *in, __fp16 *out, kml_ffth_r2r_kind kind0, kml_ffth_r2r_kind kind1, kml_ffth_r2r_kind kind2, 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创建成功，否则表示创建失败。


#### 参数

| 参数名 | 数据类型 | 描述 | 输入/输出 |
| --- | --- | --- | --- |
| n0 | ptrdiff\_t | 输入FFT序列第一维的大小，约束：n0 ≥ 1。 | 输入 |
| n1 | ptrdiff\_t | 输入FFT序列第二维的大小，约束：n1 ≥ 1。 | 输入 |
| n2 | ptrdiff\_t | 输入FFT序列第三维的大小，约束：n2 ≥ 1。 | 输入 |
| in | 双精度：double\* 单精度：float\* 半精度：\_\_fp16\* | 输入需要变换的数据。 | 输入 |
| out | 双精度：double\* 单精度：float\* 半精度：\_\_fp16\* | 输出快速傅里叶变换后的数据。 | 输出 |
| kind0 | 双精度：kml\_fft\_r2r\_kind\* 单精度：kml\_fftf\_r2r\_kind\* 半精度：kml\_ffth\_r2r\_kind\* | kind0表示FFT序列第一维的R2R变换类型，有以下可选值： KML\_FFT\_R2HC KML\_FFT\_HC2R KML\_FFT\_DHT KML\_FFT\_REDFT00 KML\_FFT\_REDFT01 KML\_FFT\_REDFT10 KML\_FFT\_REDFT11 KML\_FFT\_RODFT00 KML\_FFT\_RODFT01 KML\_FFT\_RODFT10 KML\_FFT\_RODFT11 | 输入 |
| kind1 | 双精度：kml\_fft\_r2r\_kind\* 单精度：kml\_fftf\_r2r\_kind\* 半精度：kml\_ffth\_r2r\_kind\* | kind1表示FFT序列第二维的R2R变换类型，有以下可选值： KML\_FFT\_R2HC KML\_FFT\_HC2R KML\_FFT\_DHT KML\_FFT\_REDFT00 KML\_FFT\_REDFT01 KML\_FFT\_REDFT10 KML\_FFT\_REDFT11 KML\_FFT\_RODFT00 KML\_FFT\_RODFT01 KML\_FFT\_RODFT10 KML\_FFT\_RODFT11 | 输入 |
| kind2 | 双精度：kml\_fft\_r2r\_kind\* 单精度：kml\_fftf\_r2r\_kind\* 半精度：kml\_ffth\_r2r\_kind\* | kind2表示FFT序列第三维的R2R变换类型，有以下可选值： KML\_FFT\_R2HC KML\_FFT\_HC2R KML\_FFT\_DHT KML\_FFT\_REDFT00 KML\_FFT\_REDFT01 KML\_FFT\_REDFT10 KML\_FFT\_REDFT11 KML\_FFT\_RODFT00 KML\_FFT\_RODFT01 KML\_FFT\_RODFT10 KML\_FFT\_RODFT11 | 输入 |
| comm | MPI\_Comm | MPI句柄通信器 | 输入 |
| 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_r2r_kind kind0 = KML_FFT_R2HC;
kml_fft_r2r_kind kind1 = KML_FFT_R2HC;
kml_fft_r2r_kind kind2 = KML_FFT_R2HC;
double *in = NULL;
double *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 = (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_3d(N0, N1, N2, in, out, kind0, kind1, kind2, comm, 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();
```