hipfftplan3d Interface Reference

hipfftplan3d Interface Reference#

HIPFORT API Reference: hipfort_hipfft::hipfftplan3d Interface Reference
hipfort_hipfft::hipfftplan3d Interface Reference

Create a new three-dimensional FFT plan. More...

Public Member Functions

integer(kind(hipfft_success)) function hipfftplan3d_ (plan, nx, ny, nz, myType)

Detailed Description

Create a new three-dimensional FFT plan.

Allocate and initialize a new three-dimensional FFT plan. Three-dimensional data should be stored in C ordering (row-major format), so that indexes in z-direction (k index) vary the fastest.

[out]planPointer to the FFT plan handle.
[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.

Member Function/Subroutine Documentation

◆ hipfftplan3d_()

integer(kind(hipfft_success)) function hipfort_hipfft::hipfftplan3d::hipfftplan3d_ ( type(c_ptr)  plan,
integer(c_int), value  nx,
integer(c_int), value  ny,
integer(c_int), value  nz,
integer(kind(hipfft_r2c)), value  myType 

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