Merge remote-tracking branch 'origin/release-v4.6.1'
[WRF.git] / external / fftpack / fftpack5 / rfft1f.F
blob9a16fa46cbce4ba01a87fb08ad27524af13f00c1
1 subroutine rfft1f ( n, inc, r, lenr, wsave, lensav, work, lenwrk, ier )
3 !*****************************************************************************80
5 !! RFFT1F: real single precision forward fast Fourier transform, 1D.
7 !  Discussion:
9 !    RFFT1F computes the one-dimensional Fourier transform of a periodic
10 !    sequence within a real array.  This is referred to as the forward
11 !    transform or Fourier analysis, transforming the sequence from physical
12 !    to spectral space.  This transform is normalized since a call to
13 !    RFFT1F followed by a call to RFFT1B (or vice-versa) reproduces the
14 !    original array within roundoff error.
17 !    Copyright (C) 1995-2004, Scientific Computing Division,
18 !    University Corporation for Atmospheric Research
20 !  Modified:
22 !    25 March 2005
24 !  Author:
26 !    Paul Swarztrauber
27 !    Richard Valent
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 R, of two consecutive elements within the sequence.
50 !    Input/output, real ( kind = 4 ) R(LENR), on input, contains the sequence
51 !    to be transformed, and on output, the transformed data.
53 !    Input, integer ( kind = 4 ) LENR, the dimension of the R array.
54 !    LENR must be at least INC*(N-1) + 1.
56 !    Input, real ( kind = 4 ) WSAVE(LENSAV).  WSAVE's contents must be
57 !    initialized with a call to RFFT1I before the first call to routine RFFT1F
58 !    or RFFT1B for a given transform length N.
60 !    Input, integer ( kind = 4 ) LENSAV, the dimension of the WSAVE array.
61 !    LENSAV must be at least N + INT(LOG(REAL(N))) + 4.
63 !    Workspace, real ( kind = 4 ) WORK(LENWRK).
65 !    Input, integer ( kind = 4 ) LENWRK, the dimension of the WORK array.
66 !    LENWRK must be at least N.
68 !    Output, integer ( kind = 4 ) IER, error flag.
69 !    0, successful exit;
70 !    1, input parameter LENR not big enough:
71 !    2, input parameter LENSAV not big enough;
72 !    3, input parameter LENWRK not big enough.
74   implicit none
76   integer ( kind = 4 ) lenr
77   integer ( kind = 4 ) lensav
78   integer ( kind = 4 ) lenwrk
80   integer ( kind = 4 ) ier
81   integer ( kind = 4 ) inc
82   integer ( kind = 4 ) n
83   real ( kind = 4 ) work(lenwrk)
84   real ( kind = 4 ) wsave(lensav)
85   real ( kind = 4 ) r(lenr)
87   ier = 0
89   if ( lenr < inc * ( n - 1 ) + 1 ) then
90     ier = 1
91     call xerfft ( 'rfft1f ', 6 )
92     return
93   end if
95   if ( lensav < n + int ( log ( real ( n, kind = 4 ) ) ) + 4 ) then
96     ier = 2
97     call xerfft ( 'rfft1f ', 8 )
98     return
99   end if
101   if ( lenwrk < n ) then
102     ier = 3
103     call xerfft ( 'rfft1f ', 10 )
104     return
105   end if
107   if ( n == 1 ) then
108     return
109   end if
111   call rfftf1 ( n, inc, r, work, wsave, wsave(n+1) )
113   return