FFTOptions#

class nvmath.distributed.fft.FFTOptions( fft_type: Literal['C2C'] | None = None, reshape: bool = True, logger: Logger | None = None, blocking: Literal[True, 'auto'] = 'auto', )[source]#

A data class for providing options to the FFT object and the family of wrapper functions fft() and ifft().

fft_type#

The type of FFT to perform, available options include 'C2C'.

Type:: Literal[‘C2C’] | None

reshape#

Reshape the output distribution to the same slab distribution used by the input. This only applies when using a Slab distribution. The default is True.

Type:: bool

logger#

Python Logger object. The root logger will be used if a logger object is not provided.

Type:: logging.Logger

blocking#

A flag specifying the behavior of the execution functions and methods, such as fft() and FFT.execute(). When blocking is True, the execution methods do not return until the operation is complete. When blocking is "auto", the methods return immediately when the input tensor is on the GPU. The execution methods always block when the input tensor is on the CPU, to ensure that the user doesn’t inadvertently use the result before it becomes available. The default is "auto".

Type:: Literal[True, ‘auto’]