updated top-level README and version_decl for V4.4.2 (#1795)
[WRF.git] / external / fftpack / fftpack5 / zfft1f.F
blobe46f48e1a93125a7094c0388635402b8f251d740
1 subroutine zfft1f ( n, inc, c, lenc, wsave, lensav, work, lenwrk, ier )
3 !*****************************************************************************80
5 !! ZFFT1F: complex double precision forward fast Fourier transform, 1D.
7 !  Discussion:
9 !    ZFFT1F computes the one-dimensional Fourier transform of a single
10 !    periodic sequence within a complex array.  This transform is referred
11 !    to as the forward transform or Fourier analysis, transforming the
12 !    sequence from physical to spectral space.
14 !    This transform is normalized since a call to ZFFT1F followed
15 !    by a call to ZFFT1B (or vice-versa) reproduces the original
16 !    array within roundoff error.
20 !  Modified:
22 !    26 Ausust 2009
24 !  Author:
26 !    Original complex single precision by Paul Swarztrauber, Richard Valent.
27 !    Complex double precision version by John Burkardt.
29 !  Reference:
31 !    Paul Swarztrauber,
32 !    Vectorizing the Fast Fourier Transforms,
33 !    in Parallel Computations,
34 !    edited by G. Rodrigue,
35 !    Academic Press, 1982.
37 !    Paul Swarztrauber,
38 !    Fast Fourier Transform Algorithms for Vector Computers,
39 !    Parallel Computing, pages 45-63, 1984.
41 !  Parameters:
43 !    Input, integer ( kind = 4 ) N, the length of the sequence to be
44 !    transformed.  The transform is most efficient when N is a product of
45 !    small primes.
47 !    Input, integer ( kind = 4 ) INC, the increment between the locations, in
48 !    array C, of two consecutive elements within the sequence to be transformed.
50 !    Input/output, complex ( kind = 8 ) C(LENC) containing the sequence to
51 !    be transformed.
53 !    Input, integer ( kind = 4 ) LENC, the dimension of the C array.
54 !    LENC must be at least INC*(N-1) + 1.
56 !    Input, real ( kind = 8 ) WSAVE(LENSAV).  WSAVE's contents must be
57 !    initialized with a call to ZFFT1I before the first call to routine ZFFT1F
58 !    or ZFFT1B for a given transform length N.  WSAVE's contents may be re-used
59 !    for subsequent calls to ZFFT1F and ZFFT1B with the same N.
61 !    Input, integer ( kind = 4 ) LENSAV, the dimension of the WSAVE array.
62 !    LENSAV must be at least 2*N + INT(LOG(REAL(N))) + 4.
64 !    Workspace, real ( kind = 8 ) WORK(LENWRK).
66 !    Input, integer ( kind = 4 ) LENWRK, the dimension of the WORK array.
67 !    LENWRK must be at least 2*N.
69 !    Output, integer ( kind = 4 ) IER, error flag.
70 !    0, successful exit;
71 !    1, input parameter LENC   not big enough;
72 !    2, input parameter LENSAV not big enough;
73 !    3, input parameter LENWRK not big enough;
74 !    20, input error returned by lower level routine.
76   implicit none
78   integer ( kind = 4 ) lenc
79   integer ( kind = 4 ) lensav
80   integer ( kind = 4 ) lenwrk
82   complex ( kind = 8 ) c(lenc)
83   integer ( kind = 4 ) ier
84   integer ( kind = 4 ) inc
85   integer ( kind = 4 ) iw1
86   integer ( kind = 4 ) n
87   real ( kind = 8 ) work(lenwrk)
88   real ( kind = 8 ) wsave(lensav)
90   ier = 0
92   if ( lenc < inc * ( n - 1 ) + 1 ) then
93     ier = 1
94     call xerfft ( 'ZFFT1F', 6 )
95     return
96   end if
98   if ( lensav < 2 * n + int ( log ( real ( n, kind = 8 ) ) ) + 4 ) then
99     ier = 2
100     call xerfft ( 'ZFFT1F', 8 )
101     return
102   end if
104   if ( lenwrk < 2 * n ) then
105     ier = 3
106     call xerfft ( 'ZFFT1F', 10 )
107     return
108   end if
110   if ( n == 1 ) then
111     return
112   end if
114   iw1 = n + n + 1
116   call z1fm1f ( n, inc, c, work, wsave, wsave(iw1), wsave(iw1+1) )
118   return