hipfftmpattachcomm Interface Reference

hipfftmpattachcomm Interface Reference#

hipFORT API Reference: hipfort_hipfftxt::hipfftmpattachcomm Interface Reference
hipfort_hipfftxt::hipfftmpattachcomm Interface Reference

Set a multi-processing communicator on a plan. More...

Public Member Functions

integer(c_int) function hipfftmpattachcomm_ (plan, comm_type, comm_handle)
 

Detailed Description

Set a multi-processing communicator on a plan.

Attach a multi-processing communication handle to a hipFFT plan. 'comm_handle' points to the handle, whose type depends on the multi-processing library being used. With MPI (Message Passing Interface) for example, 'comm_handle' points to an MPI communicator.

This function must only be called on a plan that has already been allocated by hipfftCreate, but before the plan is initialized with any of the 'hipfftMakePlan' functions.

Parameters
[in]plan- The FFT plan.
[in]comm_type- Type of communication handle.
[in]comm_handle- Pointer to the communication handle.
Warning
Experimental

Member Function/Subroutine Documentation

◆ hipfftmpattachcomm_()

integer(c_int) function hipfort_hipfftxt::hipfftmpattachcomm::hipfftmpattachcomm_ ( type(c_ptr), value  plan,
integer(c_int), value  comm_type,
type(c_ptr), value  comm_handle 
)

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