heffte/heffte__c__defines_8h_source.html

 /*

     -- heFFTe --

        Univ. of Tennessee, Knoxville

        @date

 */


 #ifndef HEFFTE_C_DEFINES_H

 #define HEFFTE_C_DEFINES_H


 #include "heffte_config.h"


 #define Heffte_BACKEND_STOCK 0


 #ifdef Heffte_ENABLE_FFTW

 #define Heffte_BACKEND_FFTW 1

 #endif

 #ifdef Heffte_ENABLE_MKL

 #define Heffte_BACKEND_MKL 2

 #endif

 #ifdef Heffte_ENABLE_CUDA

 #define Heffte_BACKEND_CUFFT 10

 #endif

 #ifdef Heffte_ENABLE_ROCM

 #define Heffte_BACKEND_ROCFFT 11

 #endif


 #define Heffte_SUCCESS 0


 #define Heffte_RESHAPE_ALGORITHM_ALLTOALLV 0

 #define Heffte_RESHAPE_ALGORITHM_P2P_PLINED 1

 #define Heffte_RESHAPE_ALGORITHM_P2P 2


 typedef struct{

     int use_reorder;

     int algorithm;

     int use_pencils;

     int use_gpu_aware;

 } heffte_plan_options;


 typedef struct{

     int backend_type;

     int using_r2c;

     void *fft;

 } heffte_fft_plan;


 typedef heffte_fft_plan* heffte_plan;


 #define Heffte_SCALE_NONE 0

 #define Heffte_SCALE_FULL 1

 #define Heffte_SCALE_SYMMETRIC 2


 #endif // HEFFTE_C_DEFINES_H

heffte_plan
heffte_fft_plan * heffte_plan
C-style wrapper around an instance of heffte::fft3d or heffte::fft3d_r2c using some backend.
Definition: heffte_c_defines.h:146

heffte_fft_plan
Generic wrapper around some fft3d/fft3d_r2c instance, use heffte_plan instead of this.
Definition: heffte_c_defines.h:133

heffte_fft_plan::backend_type
int backend_type
Remembers the type of the backend.
Definition: heffte_c_defines.h:135

heffte_fft_plan::using_r2c
int using_r2c
If 0 then using heffte::fft3d, otherwise using heffte::fft3d_r2c.
Definition: heffte_c_defines.h:137

heffte_fft_plan::fft
void * fft
Wrapper around an object of type heffte::fft3d or heffte::fft3d_r2c.
Definition: heffte_c_defines.h:139

heffte_plan_options
Equivalent to heffte::plan_options but defined for the C API.
Definition: heffte_c_defines.h:113

heffte_plan_options::use_gpu_aware
int use_gpu_aware
Corresponds to heffte::plan_options::use_gpu_aware.
Definition: heffte_c_defines.h:121

heffte_plan_options::use_reorder
int use_reorder
Corresponds to heffte::plan_options::use_reorder.
Definition: heffte_c_defines.h:115

heffte_plan_options::use_pencils
int use_pencils
Corresponds to heffte::plan_options::use_pencils.
Definition: heffte_c_defines.h:119

heffte_plan_options::algorithm
int algorithm
Corresponds to heffte::plan_options::use_alltoall, must be one of the Heffte_RESHAPE_ALGORITHM option...
Definition: heffte_c_defines.h:117