kml_fft(f/h)_mpi_local_size_1d
Describe the size and location of the local process data and calculate the space to be allocated.
Interface Definition
C interface:
ptrdiff_t kml_fft_mpi_local_size_1d(ptrdiff_t n0, 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_1d(ptrdiff_t n0, 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_1d(ptrdiff_t n0, 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);
Return Value
The function returns a value of the ptrdiff_t type, indicating the number of elements to be allocated. The local_ni and local_i_start parameters return a part of the stored input 1D array (local_i_start~local_i_start+local_ni-1). The local_no and local_o_start parameters return a part of the stored output 1D array (local_o_start~local_o_start+local_no-1).
Parameters
Parameter |
Data Type |
Description |
Input/Output |
|---|---|---|---|
n0 |
ptrdiff_t |
Size of the 1D FFT data to be processed. Constraint: n0 ≥ 1. |
Input |
comm |
MPI_Comm |
MPI communicator handle. |
Input |
sign |
int |
Matches the parameter passed during plan creation. |
Input |
flags |
unsigned int |
Matches the parameter passed during plan creation. |
Input |
local_ni |
ptrdiff_t* |
Size of the input data of the local process. |
Output |
local_i_start |
ptrdiff_t* |
Offset of the input data of the local process relative to the start point of the global input data. |
Output |
local_no |
ptrdiff_t* |
Size of the output data of the local process. |
Output |
local_o_start |
ptrdiff_t* |
Offset of the output data of the local process relative to the start point of the global output data. |
Output |
Dependencies
C: "kfft-mpi.h"