kml_fft(f)_mpi_local_size_3d
Describes the size and location of the local process data and calculates the space to be allocated.
Interface Definition
C interface:
ptrdiff_t kml_fft_mpi_local_size_3d(ptrdiff_t n0, ptrdiff_t n1, ptrdiff_t n2, MPI_Comm comm, ptrdiff_t *local_n0, ptrdiff_t *local_0_start);
ptrdiff_t kml_fftf_mpi_local_size_3d(ptrdiff_t n0, ptrdiff_t n1, ptrdiff_t n2, MPI_Comm comm, ptrdiff_t *local_n0, ptrdiff_t *local_0_start);
ptrdiff_t kml_ffth_mpi_local_size_3d(ptrdiff_t n0, ptrdiff_t n1, ptrdiff_t n2, MPI_Comm comm, ptrdiff_t *local_n0, ptrdiff_t *local_0_start);
Return Value
The function returns a value of the ptrdiff_t type, indicating the number of elements to be allocated (complex number, for complex DFT).
Parameters
Parameter |
Data Type |
Description |
Input/Output |
|---|---|---|---|
n0 |
|
Size of dimension 1 of the data to be processed. Constraint: n0 ≥ 1. |
Input |
n1 |
|
Size of dimension 2 of the data to be processed. Constraint: n1 ≥ 1. |
Input |
n2 |
|
Size of dimension 3 of the data to be processed. Constraint: n2 ≥ 1. |
Input |
comm |
|
MPI communicator handle. |
Input |
local_n0 |
|
Size of local process data. |
Output |
local_0_start |
|
Offset of the local process data relative to the start point of the global data. |
Output |
Dependencies
C: "kfft-mpi.h"