updated top-level README and version_decl for V4.4.2 (#1795)
[WRF.git] / external / fftpack / fftpack5 / costmi.F
blobf9d3bf2388ae216a798d2a97d543a0b335f9130a
1 subroutine costmi ( n, wsave, lensav, ier )
3 !*****************************************************************************80
5 !! COSTMI: initialization for COSTMB and COSTMF.
7 !  Discussion:
9 !    COSTMI initializes array WSAVE for use in its companion routines
10 !    COSTMF and COSTMB.  The prime factorization of N together with a
11 !    tabulation of the trigonometric functions are computed and stored
12 !    in array WSAVE.  Separate WSAVE arrays are required for different
13 !    values of N.
16 !    Copyright (C) 1995-2004, Scientific Computing Division,
17 !    University Corporation for Atmospheric Research
19 !  Modified:
21 !    29 March 2005
23 !  Author:
25 !    Paul Swarztrauber
26 !    Richard Valent
28 !  Reference:
30 !    Paul Swarztrauber,
31 !    Vectorizing the Fast Fourier Transforms,
32 !    in Parallel Computations,
33 !    edited by G. Rodrigue,
34 !    Academic Press, 1982.
36 !    Paul Swarztrauber,
37 !    Fast Fourier Transform Algorithms for Vector Computers,
38 !    Parallel Computing, pages 45-63, 1984.
40 !  Parameters:
42 !    Input, integer ( kind = 4 ) N, the length of each sequence to be
43 !    transformed.  The transform is most efficient when N is a product of
44 !    small primes.
46 !    Input, integer ( kind = 4 ) LENSAV, the dimension of the WSAVE array.
47 !    LENSAV must be at least 2*N + INT(LOG(REAL(N))) + 4
49 !    Output, real ( kind = 4 ) WSAVE(LENSAV), containing the prime factors of N
50 !    and also containing certain trigonometric values which will be used
51 !    in routines COSTMB or COSTMF.
53 !    Output, integer ( kind = 4 ) IER, error flag.
54 !    0, successful exit;
55 !    2, input parameter LENSAV not big enough;
56 !    20, input error returned by lower level routine.
58   implicit none
60   integer ( kind = 4 ) lensav
62   real ( kind = 4 ) dt
63   real ( kind = 4 ) fk
64   integer ( kind = 4 ) ier
65   integer ( kind = 4 ) ier1
66   integer ( kind = 4 ) k
67   integer ( kind = 4 ) kc
68   integer ( kind = 4 ) lnsv
69   integer ( kind = 4 ) n
70   integer ( kind = 4 ) nm1
71   integer ( kind = 4 ) np1
72   integer ( kind = 4 ) ns2
73   real ( kind = 4 ) pi
74   real ( kind = 4 ) wsave(lensav)
76   ier = 0
78   if ( lensav < 2 * n + int ( log ( real ( n, kind = 4 ) ) ) + 4 ) then
79     ier = 2
80     call xerfft ( 'costmi', 3 )
81     return
82   end if
84   if ( n <= 3 ) then
85     return
86   end if
88   nm1 = n - 1
89   np1 = n + 1
90   ns2 = n / 2
91   pi = 4.0E+00 * atan ( 1.0E+00 )
92   dt = pi / real ( nm1, kind = 4 )
94   fk = 0.0E+00
95   do k = 2, ns2
96     kc = np1 - k
97     fk = fk + 1.0E+00
98     wsave(k) = 2.0E+00 * sin ( fk * dt )
99     wsave(kc) = 2.0E+00 * cos ( fk * dt )
100   end do
102   lnsv = nm1 + int ( log ( real ( nm1, kind = 4 ) ) ) + 4
104   call rfftmi ( nm1, wsave(n+1), lnsv, ier1 )
106   if ( ier1 /= 0 ) then
107     ier = 20
108     call xerfft ( 'costmi', -5 )
109     return
110   end if
112   return