hipfftmakeplan3d Interface Reference

hipfftmakeplan3d Interface Reference#

HIPFORT API Reference: hipfort_hipfft::hipfftmakeplan3d Interface Reference
hipfort_hipfft::hipfftmakeplan3d Interface Reference

Initialize a new two-dimensional FFT plan. More...

Public Member Functions

integer(kind(hipfft_success)) function hipfftmakeplan3d_ (plan, nx, ny, nz, myType, workSize)
 
integer(kind(hipfft_success)) function hipfftmakeplan3d_rank_0 (plan, nx, ny, nz, myType, workSize)
 
integer(kind(hipfft_success)) function hipfftmakeplan3d_rank_1 (plan, nx, ny, nz, myType, workSize)
 

Detailed Description

Initialize a new two-dimensional FFT plan.

Assumes that the plan has been created already, and modifies the plan associated with the plan handle. Three-dimensional data should be stored in C ordering (row-major format), so that indexes in z-direction (k index) vary the fastest.

Parameters
[in]planHandle of the FFT plan.
[in]nxNumber of elements in the x-direction (slowest index).
[in]nyNumber of elements in the y-direction.
[in]nzNumber of elements in the z-direction (fastest index).
[in]typeFFT type.
[out]workSizePointer to work area size (returned value).

Member Function/Subroutine Documentation

◆ hipfftmakeplan3d_()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftmakeplan3d::hipfftmakeplan3d_ ( type(c_ptr), value  plan,
integer(c_int), value  nx,
integer(c_int), value  ny,
integer(c_int), value  nz,
integer(kind(hipfft_r2c)), value  myType,
type(c_ptr), value  workSize 
)

◆ hipfftmakeplan3d_rank_0()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftmakeplan3d::hipfftmakeplan3d_rank_0 ( type(c_ptr)  plan,
integer(c_int)  nx,
integer(c_int)  ny,
integer(c_int)  nz,
integer(kind(hipfft_r2c))  myType,
integer(c_size_t), target  workSize 
)

◆ hipfftmakeplan3d_rank_1()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftmakeplan3d::hipfftmakeplan3d_rank_1 ( type(c_ptr)  plan,
integer(c_int)  nx,
integer(c_int)  ny,
integer(c_int)  nz,
integer(kind(hipfft_r2c))  myType,
integer(c_size_t), dimension(:), target  workSize 
)

The documentation for this interface was generated from the following file: