dft.fft
Small FFT wrapper for the DFT prototype.
import mlx_atomistic.dft.fft
Functions
Section titled “Functions”def fft3(field: mx.array) -> mx.arrayReturn the 3D FFT of a real or complex field.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
field | mx.array |
Returns
mx.array
fft_backend
Section titled “fft_backend”def fft_backend() -> FFTBackendReturn the backend that will be used by the FFT helpers.
Returns
FFTBackend
def ifft3(field_g: mx.array) -> mx.arrayReturn the inverse 3D FFT of a reciprocal-space field.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
field_g | mx.array |
Returns
mx.array
real_to_reciprocal
Section titled “real_to_reciprocal”def real_to_reciprocal(field: mx.array) -> mx.arrayAlias for fft3 used by notebooks and docs.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
field | mx.array |
Returns
mx.array
reciprocal_to_real
Section titled “reciprocal_to_real”def reciprocal_to_real(field_g: mx.array) -> mx.arrayReturn the real component of an inverse 3D FFT.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
field_g | mx.array |
Returns
mx.array