Integer, Intent (In)	::	n1, n2, n3
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (In)	::	x(n1n2n3)
Complex (Kind=nag_wp), Intent (Out)	::	y((n1/2+1)n2n3)

C Header Interface

#include <nag.h>

void	c06pyf_ (const Integer n1, const Integer n2, const Integer n3, const double x[], Complex y[], Integer ifail)

The routine may be called by the names c06pyf or nagf_sum_fft_real_3d.

3 Description

c06pyf computes the three-dimensional discrete Fourier transform of a trivariate sequence of real data values

x_{j_{1} j_{2} j_{3}}

, for

j_{1} = 0, 1, \dots, n_{1} - 1

j_{2} = 0, 1, \dots, n_{2} - 1

and

j_{3} = 0, 1, \dots, n_{3} - 1

The discrete Fourier transform is here defined by

{\hat{z}}_{k_{1} k_{2} k_{3}} = \frac{1}{\sqrt{n_{1} n_{2} n_{3}}} \sum_{j_{1} = 0}^{n_{1} - 1} \sum_{j_{2} = 0}^{n_{2} - 1} \sum_{j_{3} = 0}^{n_{3} - 1} x_{j_{1} j_{2} j_{3}} \times \exp (- 2 π i (\frac{j_{1} k_{1}}{n_{1}} + \frac{j_{2} k_{2}}{n_{2}} + \frac{j_{3} k_{3}}{n_{3}})),

where

k_{1} = 0, 1, \dots, n_{1} - 1

k_{2} = 0, 1, \dots, n_{2} - 1

and

k_{3} = 0, 1, \dots, n_{3} - 1

. (Note the scale factor of

\frac{1}{\sqrt{n_{1} n_{2} n_{3}}}

in this definition.)

The transformed values

{\hat{z}}_{k_{1} k_{2} k_{3}}

are complex. Because of conjugate symmetry (i.e.,

{\hat{z}}_{k_{1} k_{2} k_{3}}

is the complex conjugate of

{\hat{z}}_{(n_{1} - k_{1}) (n_{2} - k_{2}) (n_{3} - k_{3})}

), only slightly more than half of the Fourier coefficients need to be stored in the output.

A call of c06pyf followed by a call of c06pzf will restore the original data.

This routine calls c06pqf and c06prf to perform multiple one-dimensional discrete Fourier transforms by the fast Fourier transform (FFT) algorithm in Brigham (1974) and Temperton (1983).

4 References

Brigham E O (1974) The Fast Fourier Transform Prentice–Hall

Temperton C (1983) Fast mixed-radix real Fourier transforms J. Comput. Phys. 52 340–350

5 Arguments

1: $n1$ – Integer Input: On entry: $n_{1}$ , the first dimension of the transform.

Constraint: $n1 \geq 1$ .
2: $n2$ – Integer Input: On entry: $n_{2}$ , the second dimension of the transform.

Constraint: $n2 \geq 1$ .
3: $n3$ – Integer Input: On entry: $n_{3}$ , the third dimension of the transform.

Constraint: $n3 \geq 1$ .
4: $x (n1 \times n2 \times n3)$ – Real (Kind=nag_wp) array Input: On entry: the real input dataset $x$ , where $x_{j_{1} j_{2} j_{3}}$ is stored in $x (j_{3} \times n_{1} n_{2} + j_{2} \times n_{1} + j_{1} + 1)$ , for $j_{1} = 0, 1, \dots, n_{1} - 1$ , $j_{2} = 0, 1, \dots, n_{2} - 1$ and $j_{3} = 0, 1, \dots, n_{3} - 1$ . That is, if x is regarded as a three-dimensional array of dimension $(0 : n1 - 1, 0 : n2 - 1, 0 : n3 - 1)$ , $x (j_{1}, j_{2}, j_{3})$ must contain $x_{j_{1} j_{2} j_{3}}$ .
5: $y ((n1 / 2 + 1) \times n2 \times n3)$ – Complex (Kind=nag_wp) array Output: On exit: the complex output dataset $\hat{z}$ , where ${\hat{z}}_{k_{1} k_{2} k_{3}}$ is stored in $y (k_{3} \times (n_{1} / 2 + 1) n_{2} + k_{2} \times (n_{1} / 2 + 1) + k_{1} + 1)$ , for $k_{1} = 0, 1, \dots, n_{1} / 2$ , $k_{2} = 0, 1, \dots, n_{2} - 1$ and $k_{3} = 0, 1, \dots, n_{3} - 1$ . That is, if y is regarded as a three-dimensional array of dimension $(0 : n1 / 2, 0 : n2 - 1, 0 : n3 - 1)$ , $y (k_{1}, k_{2}, k_{3})$ contains ${\hat{z}}_{k_{1} k_{2} k_{3}}$ . Note the first dimension is cut roughly by half to remove the redundant information due to conjugate symmetry.
6: $ifail$ – Integer Input/Output: On entry: ifail must be set to $0$ , $−1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $−1$ means that an error message is printed while a value of $1$ means that it is not.

If halting is not appropriate, the value $−1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $- 1$ or $1$ is used it is essential to test the value of ifail on exit.

On exit: $ifail = 0$ unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

ifail = 0

−1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: On entry, $n1 = ⟨ value ⟩$ .
Constraint: $n1 \geq 1$ .

$ifail = 2$: On entry, $n2 = ⟨ value ⟩$ .
Constraint: $n2 \geq 1$ .

$ifail = 3$: On entry, $n3 = ⟨ value ⟩$ .
Constraint: $n3 \geq 1$ .

$ifail = 4$: An internal error has occurred in this routine. Check the routine call and any array sizes. If the call is correct then please contact NAG for assistance.

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Some indication of accuracy can be obtained by performing a forward transform using c06pyf and a backward transform using c06pzf, and comparing the results with the original sequence (in exact arithmetic they would be identical).

8 Parallelism and Performance

c06pyf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

c06pyf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.

Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

The time taken by c06pyf is approximately proportional to

n_{1} n_{2} n_{3} \log (n_{1} n_{2} n_{3})

, but also depends on the factors of

n_{1}

n_{2}

and

n_{3}

. c06pyf is fastest if the only prime factors of

n_{1}

n_{2}

and

n_{3}

are

2

3

and

5

, and is particularly slow if one of the dimensions is a large prime, or has large prime factors.

Workspace is internally allocated by c06pyf. The total size of these arrays is approximately proportional to

n_{1} n_{2} n_{3}

10 Example

This example reads in a trivariate sequence of real data values and prints their discrete Fourier transforms as computed by c06pyf. Inverse transforms are then calculated by calling c06pzf showing that the original sequences are restored.

c06py: FL CL CPP AD

NAG FL Interfacec06pyf (fft_​real_​3d)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
c06pyf (fft_real_3d)