rocfft_brick_create Interface Reference

rocfft_brick_create Interface Reference#

HIPFORT API Reference: hipfort_rocfft::rocfft_brick_create Interface Reference

Define a brick as part of a decomposition of a field. More...

Public Member Functions
integer(kind(rocfft_status_success)) function	rocfft_brick_create_ (brick, field_lower, field_upper, brick_stride, dim_with_batch, deviceid)

Detailed Description

Define a brick as part of a decomposition of a field.

Fields can contain a full-dimensional data distribution. The decomposition is specified by providing a lower coordinate and an upper coordinate in the field's index space. The lower coordinate is inclusive (contained within the brick) and the upper coordinate is exclusive (first index past the end of the brick).

One must also provide a stride for the brick data which specifies how the brick's data is arranged in memory.

All coordinates and strides must include batch dimensions, and are in column-major order (fastest-moving dimension first).

A HIP device ID is also provided - each brick may reside on a different device.

All arrays may be re-used or freed immediately after the function returns.

Parameters

[out]	brick	- : brick structure
[in]	field_lower	- : array of length `dim_with_batch` specifying the lower index (inclusive) for the brick in the field's index space.
[in]	field_upper	- : array of length `dim_with_batch` specifying the upper index (exclusive) for the brick in the field's index space.
[in]	brick_stride	- : array of length `dim_with_batch` specifying the brick's stride in memory
[in]	dim_with_batch	- : length of the arrays; this must match the dimension of the FFT plus one for the batch dimension.
[in]	deviceID	- : HIP device ID for the device on which the brick's data is resident.

Warning: Experimental! This feature is part of an experimental API preview.

Member Function/Subroutine Documentation