external/fftpack/fftpack5/cfftmb.F

   1 subroutine cfftmb ( lot, jump, n, inc, c, lenc, wsave, lensav, work, &
   2   lenwrk, ier )
   3
   4 !*****************************************************************************80
   5 !
   6 !! CFFTMB: complex single precision backward FFT, 1D, multiple vectors.
   7 !
   8 !  Discussion:
   9 !
  10 !    CFFTMB computes the one-dimensional Fourier transform of multiple
  11 !    periodic sequences within a complex array.  This transform is referred
  12 !    to as the backward transform or Fourier synthesis, transforming the
  13 !    sequences from spectral to physical space.  This transform is
  14 !    normalized since a call to CFFTMF followed by a call to CFFTMB (or
  15 !    vice-versa) reproduces the original array within roundoff error.
  16 !
  17 !    The parameters INC, JUMP, N and LOT are consistent if equality
  18 !    I1*INC + J1*JUMP = I2*INC + J2*JUMP for I1,I2 < N and J1,J2 < LOT
  19 !    implies I1=I2 and J1=J2.  For multiple FFTs to execute correctly,
  20 !    input variables INC, JUMP, N and LOT must be consistent, otherwise
  21 !    at least one array element mistakenly is transformed more than once.
  22 !
  23 !
  24 !    Copyright (C) 1995-2004, Scientific Computing Division,
  25 !    University Corporation for Atmospheric Research
  26 !
  27 !  Modified:
  28 !
  29 !    24 March 2005
  30 !
  31 !  Author:
  32 !
  33 !    Paul Swarztrauber
  34 !    Richard Valent
  35 !
  36 !  Reference:
  37 !
  38 !    Paul Swarztrauber,
  39 !    Vectorizing the Fast Fourier Transforms,
  40 !    in Parallel Computations,
  41 !    edited by G. Rodrigue,
  42 !    Academic Press, 1982.
  43 !
  44 !    Paul Swarztrauber,
  45 !    Fast Fourier Transform Algorithms for Vector Computers,
  46 !    Parallel Computing, pages 45-63, 1984.
  47 !
  48 !  Parameters:
  49 !
  50 !    Input, integer ( kind = 4 ) LOT, the number of sequences to be transformed
  51 !    within array C.
  52 !
  53 !    Input, integer ( kind = 4 ) JUMP, the increment between the locations, in
  54 !    array C, of the first elements of two consecutive sequences to be
  55 !    transformed.
  56 !
  57 !    Input, integer ( kind = 4 ) N, the length of each sequence to be
  58 !    transformed.  The transform is most efficient when N is a product of
  59 !    small primes.
  60 !
  61 !    Input, integer ( kind = 4 ) INC, the increment between the locations, in
  62 !    array C, of two consecutive elements within the same sequence to be
  63 !    transformed.
  64 !
  65 !    Input/output, complex ( kind = 4 ) C(LENC), an array containing LOT
  66 !    sequences, each having length N, to be transformed.  C can have any
  67 !    number of dimensions, but the total number of locations must be at least
  68 !    LENC.  On output, C contains the transformed sequences.
  69 !
  70 !    Input, integer ( kind = 4 ) LENC, the dimension of the C array.
  71 !    LENC must be at least (LOT-1)*JUMP + INC*(N-1) + 1.
  72 !
  73 !    Input, real ( kind = 4 ) WSAVE(LENSAV).  WSAVE's contents must be
  74 !    initialized with a call to CFFTMI before the first call to routine CFFTMF
  75 !    or CFFTMB for a given transform length N.
  76 !
  77 !    Input, integer ( kind = 4 ) LENSAV, the dimension of the WSAVE array.
  78 !    LENSAV must be at least 2*N + INT(LOG(REAL(N))) + 4.
  79 !
  80 !    Workspace, real ( kind = 4 ) WORK(LENWRK).
  81 !
  82 !    Input, integer ( kind = 4 ) LENWRK, the dimension of the WORK array.
  83 !    LENWRK must be at least 2*LOT*N.
  84 !
  85 !    Output, integer ( kind = 4 ) IER, error flag.
  86 !    0, successful exit
  87 !    1, input parameter LENC not big enough;
  88 !    2, input parameter LENSAV not big enough;
  89 !    3, input parameter LENWRK not big enough;
  90 !    4, input parameters INC, JUMP, N, LOT are not consistent.
  91 !
  92   implicit none
  93
  94   integer ( kind = 4 ) lenc
  95   integer ( kind = 4 ) lensav
  96   integer ( kind = 4 ) lenwrk
  97
  98   complex ( kind = 4 ) c(lenc)
  99   integer ( kind = 4 ) ier
 100   integer ( kind = 4 ) inc
 101   integer ( kind = 4 ) iw1
 102   integer ( kind = 4 ) jump
 103   integer ( kind = 4 ) lot
 104   integer ( kind = 4 ) n
 105   real ( kind = 4 ) work(lenwrk)
 106   real ( kind = 4 ) wsave(lensav)
 107   logical              xercon
 108
 109   ier = 0
 110
 111   if ( lenc < ( lot - 1 ) * jump + inc * ( n - 1 ) + 1 ) then
 112     ier = 1
 113     call xerfft ( 'CFFTMB', 6 )
 114     return
 115   end if
 116
 117   if ( lensav < 2 * n + int ( log ( real ( n, kind = 4 ) ) ) + 4 ) then
 118     ier = 2
 119     call xerfft ( 'CFFTMB', 8 )
 120     return
 121   end if
 122
 123   if ( lenwrk < 2 * lot * n ) then
 124     ier = 3
 125     call xerfft ( 'CFFTMB', 10 )
 126     return
 127   end if
 128
 129   if ( .not. xercon ( inc, jump, n, lot ) ) then
 130     ier = 4
 131     call xerfft ( 'CFFTMB', -1 )
 132     return
 133   end if
 134
 135   if ( n == 1 ) then
 136     return
 137   end if
 138
 139   iw1 = n + n + 1
 140
 141   call cmfm1b ( lot, jump, n, inc, c, work, wsave, wsave(iw1), &
 142     wsave(iw1+1) )
 143
 144   return
 145 end