quantum-espresso/Modules/fft_scalar.f90

2443 lines
77 KiB
Fortran

!
! Copyright (C) 2001-2006 Quantum-ESPRESSO group
! This file is distributed under the terms of the
! GNU General Public License. See the file `License'
! in the root directory of the present distribution,
! or http://www.gnu.org/copyleft/gpl.txt .
!
!----------------------------------------------------------------------!
! FFT scalar drivers Module - contains machine-dependent routines for: !
! FFTW, FFTW3, MKL v.8, ESSL, SCSL, COMPLIB, SUNPERF libraries !
! (both 3d for serial execution and 1d+2d FFTs for parallel execution) !
! NEC ASL, CXML libraries (3d only, no parallel execution) !
! Written by Carlo Cavazzoni, modified by P. Giannozzi, contributions !
! by Martin Hilgemans, Guido Roma, Pascal Thibaudeau, Stephane Lefranc,!
! Nicolas Lacorne - Last update June 2006 !
!----------------------------------------------------------------------!
#if defined __HPM
# include "/cineca/prod/hpm/include/f_hpm.h"
#endif
#include "f_defs.h"
#if defined __FFTMKL8
#include "mkl_dfti.f90"
MODULE DFTI_WRAPPER
INTERFACE DftiCreateDescriptor
FUNCTION dfti_create_descriptor_1d(DFTI_Desc, precision, domain, dim, length)
!DEC$ATTRIBUTES C :: dfti_create_descriptor_1d
!MS$ATTRIBUTES REFERENCE :: precision
!MS$ATTRIBUTES REFERENCE :: domain
!MS$ATTRIBUTES REFERENCE :: dim
!MS$ATTRIBUTES REFERENCE :: length
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_create_descriptor_1d
INTEGER, INTENT(IN) :: precision
INTEGER, INTENT(IN) :: domain
INTEGER, INTENT(IN) :: dim, length
C_POINTER :: DFTI_Desc
END FUNCTION dfti_create_descriptor_1d
FUNCTION dfti_create_descriptor_highd(DFTI_Desc, precision, domain, dim, length)
!DEC$ATTRIBUTES C :: dfti_create_descriptor_highd
!MS$ATTRIBUTES REFERENCE :: precision
!MS$ATTRIBUTES REFERENCE :: domain
!MS$ATTRIBUTES REFERENCE :: dim
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_create_descriptor_highd
INTEGER, INTENT(IN) :: precision
INTEGER, INTENT(IN) :: domain
INTEGER, INTENT(IN) :: dim
INTEGER, INTENT(IN), DIMENSION(*) :: length
C_POINTER :: DFTI_Desc
END FUNCTION dfti_create_descriptor_highd
END INTERFACE DftiCreateDescriptor
INTERFACE DftiCommitDescriptor
FUNCTION dfti_commit_descriptor_external(DFTI_Desc)
!DEC$ATTRIBUTES C :: dfti_commit_descriptor_external
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_commit_descriptor_external
C_POINTER ::DFTI_Desc
END FUNCTION dfti_commit_descriptor_external
END INTERFACE
INTERFACE DftiSetValue
FUNCTION dfti_set_value_intval(DFTI_Desc, OptName, IntVal)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_set_value_intval
!MS$ATTRIBUTES REFERENCE :: OptName
!MS$ATTRIBUTES REFERENCE :: IntVal
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_set_value_intval
INTEGER, INTENT(IN) :: OptName
INTEGER, INTENT(IN) :: IntVal
C_POINTER :: DFTI_Desc
END FUNCTION dfti_set_value_intval
FUNCTION dfti_set_value_sglval(DFTI_Desc, OptName, sglval)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_set_value_sglval
!MS$ATTRIBUTES REFERENCE :: OptName
!MS$ATTRIBUTES REFERENCE :: sglval
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_set_value_sglval
INTEGER, INTENT(IN) :: OptName
REAL(4), INTENT(IN) :: sglval
C_POINTER :: DFTI_Desc
END FUNCTION dfti_set_value_sglval
FUNCTION dfti_set_value_dblval(DFTI_Desc, OptName, DblVal)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_set_value_dblval
!MS$ATTRIBUTES REFERENCE :: OptName
!MS$ATTRIBUTES REFERENCE :: DblVal
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_set_value_dblval
INTEGER, INTENT(IN) :: OptName
REAL(8), INTENT(IN) :: DblVal
C_POINTER :: DFTI_Desc
END FUNCTION dfti_set_value_dblval
FUNCTION dfti_set_value_intvec(DFTI_Desc, OptName, IntVec)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_set_value_intvec
!MS$ATTRIBUTES REFERENCE :: OptName
!MS$ATTRIBUTES REFERENCE :: IntVec
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_set_value_intvec
INTEGER, INTENT(IN) :: OptName
INTEGER, INTENT(IN), DIMENSION(*) :: IntVec
C_POINTER :: DFTI_Desc
END FUNCTION dfti_set_value_intvec
FUNCTION dfti_set_value_chars(DFTI_Desc, OptName, Chars)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_set_value_chars
!MS$ATTRIBUTES REFERENCE :: OptName
!MS$ATTRIBUTES REFERENCE :: Chars
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_set_value_chars
INTEGER, INTENT(IN) :: OptName
CHARACTER(*), INTENT(IN) :: Chars
C_POINTER :: DFTI_Desc
END FUNCTION dfti_set_value_chars
END INTERFACE
INTERFACE DftiGetValue
FUNCTION dfti_get_value_intval(DFTI_Desc, OptName, IntVal)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_get_value_intval
!MS$ATTRIBUTES REFERENCE :: OptName
!MS$ATTRIBUTES REFERENCE :: IntVal
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_get_value_intval
INTEGER, INTENT(IN) :: OptName
INTEGER, INTENT(OUT) :: IntVal
C_POINTER :: DFTI_Desc
END FUNCTION dfti_get_value_intval
FUNCTION dfti_get_value_sglval(DFTI_Desc, OptName, sglval)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_get_value_sglval
!MS$ATTRIBUTES REFERENCE :: OptName
!MS$ATTRIBUTES REFERENCE :: sglval
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_get_value_sglval
INTEGER, INTENT(IN) :: OptName
REAL(4), INTENT(OUT) :: sglval
C_POINTER :: DFTI_Desc
END FUNCTION dfti_get_value_sglval
FUNCTION dfti_get_value_dblval(DFTI_Desc, OptName, DblVal)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_get_value_dblval
!MS$ATTRIBUTES REFERENCE :: OptName
!MS$ATTRIBUTES REFERENCE :: DblVal
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_get_value_dblval
INTEGER, INTENT(IN) :: OptName
REAL(8), INTENT(OUT) :: DblVal
C_POINTER :: DFTI_Desc
END FUNCTION dfti_get_value_dblval
FUNCTION dfti_get_value_intvec(DFTI_Desc, OptName, IntVec)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_get_value_intvec
!MS$ATTRIBUTES REFERENCE :: OptName
!MS$ATTRIBUTES REFERENCE :: IntVec
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_get_value_intvec
INTEGER, INTENT(IN) :: OptName
INTEGER, INTENT(OUT), DIMENSION(*) :: IntVec
C_POINTER :: DFTI_Desc
END FUNCTION dfti_get_value_intvec
FUNCTION dfti_get_value_chars(DFTI_Desc, OptName, Chars)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_get_value_chars
!MS$ATTRIBUTES REFERENCE :: OptName
!MS$ATTRIBUTES REFERENCE :: Chars
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_get_value_chars
INTEGER, INTENT(IN) :: OptName
CHARACTER(*), INTENT(OUT) :: Chars
C_POINTER :: DFTI_Desc
END FUNCTION dfti_get_value_chars
END INTERFACE
INTERFACE DftiComputeForward
FUNCTION dfti_compute_forward_z(DFTI_Desc, a_tst)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_compute_forward_z
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_compute_forward_z
COMPLEX(8), INTENT(INOUT), DIMENSION(*) :: a_tst
C_POINTER :: DFTI_Desc
END FUNCTION dfti_compute_forward_z
FUNCTION dfti_compute_forward_z_out(DFTI_Desc, a_tst, a_tst_out)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_compute_forward_z_out
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_compute_forward_z_out
COMPLEX(8), INTENT(IN), DIMENSION(*) :: a_tst
COMPLEX(8), INTENT(OUT), DIMENSION(*) :: a_tst_out
C_POINTER :: DFTI_Desc
END FUNCTION dfti_compute_forward_z_out
END INTERFACE
INTERFACE DftiFreeDescriptor
FUNCTION dfti_free_descriptor_external(hand_c1d)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_free_descriptor_external
!MS$ATTRIBUTES REFERENCE :: hand_c1d
INTEGER dfti_free_descriptor_external
C_POINTER :: hand_c1d
END FUNCTION dfti_free_descriptor_external
END INTERFACE
INTERFACE DftiComputeBackward
FUNCTION dfti_compute_backward_z(DFTI_Desc , a_tst)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_compute_backward_z
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_compute_backward_z
COMPLEX(8), INTENT(INOUT), DIMENSION(*) :: a_tst
C_POINTER :: DFTI_Desc
END FUNCTION dfti_compute_backward_z
FUNCTION dfti_compute_backward_z_out(DFTI_Desc , a_tst, a_tst_out)
USE MKL_DFT_TYPE
!DEC$ATTRIBUTES C :: dfti_compute_backward_z_out
!MS$ATTRIBUTES REFERENCE :: DFTI_Desc
INTEGER dfti_compute_backward_z_out
COMPLEX(8), INTENT(IN), DIMENSION(*) :: a_tst
COMPLEX(8), INTENT(OUT), DIMENSION(*) :: a_tst_out
C_POINTER :: DFTI_Desc
END FUNCTION dfti_compute_backward_z_out
END INTERFACE
END MODULE DFTI_WRAPPER
#endif
!=----------------------------------------------------------------------=!
MODULE fft_scalar
!=----------------------------------------------------------------------=!
USE kinds
#if defined __FFTMKL8
use MKL_DFT_TYPE
use DFTI_WRAPPER
! use MKL_DFTI
#endif
IMPLICIT NONE
SAVE
PRIVATE
PUBLIC :: cft_1z, cft_2xy, cft_b, cfft3d, cfft3ds
PUBLIC :: good_fft_dimension, allowed, good_fft_order
! ... Local Parameter
! ndims Number of different FFT tables that the module
! could keep into memory without reinitialization
! nfftx Max allowed fft dimension
INTEGER, PARAMETER :: ndims = 3, nfftx = 2049
! Workspace that is statically allocated is defined here
! in order to avoid multiple copies of the same workspace
! lwork: Dimension of the work space array (if any)
#if defined __ESSL
! ESSL IBM library: see the ESSL manual for DCFT
INTEGER, PARAMETER :: lwork = 20000 + ( 2*nfftx + 256 ) * 64 + 3*nfftx
REAL (DP) :: work( lwork )
#elif defined __SCSL || defined __SUN
! SGI scientific library scsl and SUN sunperf
INTEGER, PARAMETER :: lwork = 2 * nfftx
COMPLEX (DP) :: work(lwork)
#elif defined __FFTW3
! Only FFTW_ESTIMATE is actually used
# define FFTW_MEASURE 0
# define FFTW_ESTIMATE 64
#endif
!=----------------------------------------------------------------------=!
CONTAINS
!=----------------------------------------------------------------------=!
!
!=----------------------------------------------------------------------=!
!
!
!
! FFT along "z"
!
!
!
!=----------------------------------------------------------------------=!
!
SUBROUTINE cft_1z(c, nsl, nz, ldz, isign, cout)
! driver routine for nsl 1d complex fft's of length nz
! ldz >= nz is the distance between sequences to be transformed
! (ldz>nz is used on some architectures to reduce memory conflicts)
! input : c(ldz*nsl) (complex)
! output : cout(ldz*nsl) (complex - NOTA BENE: transform is not in-place!)
! isign > 0 : forward (f(G)=>f(R)), isign <0 backward (f(R) => f(G))
! Up to "ndims" initializations (for different combinations of input
! parameters nz, nsl, ldz) are stored and re-used if available
INTEGER, INTENT(IN) :: isign
INTEGER, INTENT(IN) :: nsl, nz, ldz
COMPLEX (DP) :: c(:), cout(:)
REAL(DP) :: tscale
INTEGER :: i, err, idir, ip
INTEGER, SAVE :: zdims( 3, ndims ) = -1
INTEGER, SAVE :: icurrent = 1
LOGICAL :: done
! ... Machine-Dependent parameters, work arrays and tables of factors
! ltabl Dimension of the tables of factors calculated at the
! initialization stage
#if defined __FFTW || defined __FFTW3
C_POINTER, SAVE :: fw_planz( ndims ) = 0
C_POINTER, SAVE :: bw_planz( ndims ) = 0
! Pointers to the "C" structures containing FFT factors ( PLAN )
! C_POINTER is defined in include/f_defs.h
! for 32bit executables, C_POINTER is integer(4)
! for 64bit executables, C_POINTER is integer(8)
#elif defined __ESSL
! ESSL IBM library: see the ESSL manual for DCFT
INTEGER, PARAMETER :: ltabl = 20000 + 3 * nfftx
REAL (DP), SAVE :: fw_tablez( ltabl, ndims )
REAL (DP), SAVE :: bw_tablez( ltabl, ndims )
#elif defined __SCSL
! SGI scientific library scsl
INTEGER, PARAMETER :: ltabl = 2 * nfftx + 256
REAL (DP), SAVE :: tablez (ltabl, ndims)
REAL (DP) :: DUMMY
INTEGER, SAVE :: isys(0:1) = (/ 1, 1 /)
#elif defined __COMPLIB
! SGI scientific library complib
INTEGER, PARAMETER :: ltabl = 4 * nfftx
REAL (DP), SAVE :: tablez (ltabl, ndims)
#elif defined __SUN
! SUN sunperf library
INTEGER, PARAMETER :: ltabl = 4 * nfftx + 15
REAL (DP), SAVE :: tablez (ltabl, ndims)
#elif defined __FFTMKL8
! INTEL MKL 8
C_POINTER,SAVE :: Desc_Handle(ndims) = 0
integer :: StrideArray(2)
integer Status
#endif
#if defined __HPM
CALL f_hpmstart( 30 + ABS(isign), 'cft_1z' )
#endif
IF( nsl < 0 ) THEN
CALL errore(" fft_scalar: cft_1z ", " nsl out of range ", nsl)
END IF
!
! Here initialize table only if necessary
!
DO ip = 1, ndims
! first check if there is already a table initialized
! for this combination of parameters
done = ( nz == zdims(1,ip) )
#if defined __ESSL || defined __FFTW3 || defined __FFTMKL8
! The initialization in ESSL and FFTW v.3 depends on all three parameters
done = done .AND. ( nsl == zdims(2,ip) ) .AND. ( ldz == zdims(3,ip) )
#endif
IF (done) EXIT
END DO
IF( .NOT. done ) THEN
! no table exist for these parameters
! initialize a new one
! WRITE( stdout, fmt="('DEBUG cft_1z, reinitializing tables ', I3)" ) icurrent
#if defined __FFTW
IF( fw_planz( icurrent) /= 0 ) CALL DESTROY_PLAN_1D( fw_planz( icurrent) )
IF( bw_planz( icurrent) /= 0 ) CALL DESTROY_PLAN_1D( bw_planz( icurrent) )
idir = -1; CALL CREATE_PLAN_1D( fw_planz( icurrent), nz, idir)
idir = 1; CALL CREATE_PLAN_1D( bw_planz( icurrent), nz, idir)
#elif defined __FFTW3
IF( fw_planz( icurrent) /= 0 ) CALL dfftw_destroy_plan( fw_planz( icurrent) )
IF( bw_planz( icurrent) /= 0 ) CALL dfftw_destroy_plan( bw_planz( icurrent) )
idir = -1
CALL dfftw_plan_many_dft( fw_planz( icurrent), 1, nz, nsl, c, &
(/SIZE(c)/), 1, ldz, c, (/SIZE(c)/), 1, ldz, idir, FFTW_ESTIMATE)
idir = 1
CALL dfftw_plan_many_dft( bw_planz( icurrent), 1, nz, nsl, c, &
(/SIZE(c)/), 1, ldz, c, (/SIZE(c)/), 1, ldz, idir, FFTW_ESTIMATE)
#elif defined __ESSL
tscale = 1.0d0 / nz
CALL DCFT ( 1, c(1), 1, ldz, cout(1), 1, ldz, nz, nsl, 1, &
tscale, fw_tablez(1, icurrent), ltabl, work(1), lwork)
CALL DCFT ( 1, c(1), 1, ldz, cout(1), 1, ldz, nz, nsl, -1, &
1.0d0, bw_tablez(1, icurrent), ltabl, work(1), lwork)
#elif defined __COMPLIB
write (6,*) "Warning: FFTs have been heavily restructured, those using complib are untested"
write (6,*) "Warning: Please locate and remove the following line in Modules/fft_scalar.f90:"
write (6,*) " call errore('cft_1z','complib untested, please test',1)"
write (6,*) "Warning: Please recompile, test, report if it works"
call errore('cft_1z','complib untested, please test',1)
CALL ZFFT1DI( nz, tablez (1, icurrent) )
#elif defined __SCSL
CALL ZZFFTM (0, nz, 0, 0.0D0, DUMMY, 1, DUMMY, 1, &
tablez (1, icurrent), DUMMY, isys)
#elif defined __SUN
write (6,*) "Warning: FFTs have been heavily restructured, those using sunperf are untested"
write (6,*) "Warning: Please locate and remove the following line in Modules/fft_scalar.f90:"
write (6,*) " call errore('cft_1z','sunperf untested, please test',1)"
write (6,*) "Warning: Please recompile, test, report if it works"
call errore('cft_1z','sunperf untested, please test',1)
CALL zffti (nz, tablez (1, icurrent) )
#elif defined __FFTMKL8
! IF ( ASSOCIATED(Desc_Handle(icurrent)) ) THEN
write(*,*) "Descriptor:",icurrent,ndims,Desc_Handle(1),Desc_Handle(2),Desc_Handle(3)
IF (Desc_Handle(icurrent) /= 0 ) THEN
write(*,*) "Freeing Descriptor",icurrent,ndims,Desc_Handle(1),Desc_Handle(2),Desc_Handle(3)
Status = DftiFreeDescriptor(Desc_Handle(icurrent))
ENDIF
tscale = 1.0d0 / nz
!write(*,*) "Creating Descriptor",icurrent
Status = DftiCreateDescriptor(Desc_Handle(icurrent) , &
DFTI_DOUBLE,DFTI_COMPLEX,1,nz)
! Status = DftiSetValue(Desc_Handle(icurrent) , &
! DFTI_PLACEMENT,DFTI_INPLACE)
!Status = DftiSetValue(Desc_Handle(icurrent), DFTI_FORWARD_SCALE, tscale )
StrideArray(1) = 0
StrideArray(2) = 1
Status = DftiSetValue(Desc_Handle(icurrent),DFTI_INPUT_STRIDES,StrideArray)
Status = DftiSetValue(Desc_Handle(icurrent),DFTI_OUTPUT_STRIDES,StrideArray)
Status = DftiSetValue(Desc_Handle(icurrent),DFTI_NUMBER_OF_TRANSFORMS,nsl)
Status = DftiSetValue(Desc_Handle(icurrent),DFTI_INPUT_DISTANCE,ldz)
Status = DftiSetValue(Desc_Handle(icurrent),DFTI_OUTPUT_DISTANCE,ldz)
Status = DftiCommitDescriptor(Desc_Handle(icurrent))
#else
CALL errore(' cft_1z ',' no scalar fft driver specified ', 1)
#endif
zdims(1,icurrent) = nz; zdims(2,icurrent) = nsl; zdims(3,icurrent) = ldz;
ip = icurrent
icurrent = MOD( icurrent, ndims ) + 1
END IF
!
! Now perform the FFTs using machine specific drivers
!
#if defined __FFTW
IF (isign < 0) THEN
CALL FFT_Z_STICK(fw_planz( ip), c(1), ldz, nsl)
cout( 1 : ldz * nsl ) = c( 1 : ldz * nsl ) / nz
ELSE IF (isign > 0) THEN
CALL FFT_Z_STICK(bw_planz( ip), c(1), ldz, nsl)
cout( 1 : ldz * nsl ) = c( 1 : ldz * nsl )
END IF
#elif defined __FFTW3
IF (isign < 0) THEN
CALL dfftw_execute_dft( fw_planz( ip), c, cout)
cout( 1 : ldz * nsl ) = cout( 1 : ldz * nsl ) / nz
ELSE IF (isign > 0) THEN
CALL dfftw_execute_dft( bw_planz( ip), c, cout)
END IF
#elif defined __COMPLIB
IF (isign < 0) THEN
idir = -1
CALL zfftm1d( idir, nz, nsl, c(1), 1, ldz, tablez (1, ip) )
cout( 1 : ldz * nsl ) = c( 1 : ldz * nsl ) / nz
ELSE IF( isign > 0 ) THEN
idir = 1
CALL zfftm1d( idir, nz, nsl, c(1), 1, ldz, tablez (1, ip) )
cout( 1 : ldz * nsl ) = c( 1 : ldz * nsl )
END IF
#elif defined __SCSL
IF ( isign < 0 ) THEN
idir = -1
tscale = 1.0d0 / nz
ELSE IF ( isign > 0 ) THEN
idir = 1
tscale = 1.0d0
END IF
IF (isign /= 0) CALL ZZFFTM (idir, nz, nsl, tscale, c(1), ldz, &
cout(1), ldz, tablez (1, ip), work, isys)
#elif defined __ESSL
! essl uses a different convention for forward/backward transforms
! wrt most other implementations: notice the sign of "idir"
IF( isign < 0 ) THEN
idir =+1
tscale = 1.0d0 / nz
CALL DCFT (0, c(1), 1, ldz, cout(1), 1, ldz, nz, nsl, idir, &
tscale, fw_tablez(1, ip), ltabl, work, lwork)
ELSE IF( isign > 0 ) THEN
idir =-1
tscale = 1.0d0
CALL DCFT (0, c(1), 1, ldz, cout(1), 1, ldz, nz, nsl, idir, &
tscale, bw_tablez(1, ip), ltabl, work, lwork)
END IF
#elif defined __SUN
IF ( isign < 0) THEN
DO i = 1, nsl
CALL zfftf ( nz, c(1+(i-1)*ldz), tablez ( 1, ip) )
END DO
cout( 1 : ldz * nsl ) = c( 1 : ldz * nsl ) / nz
ELSE IF( isign > 0 ) THEN
DO i = 1, nsl
CALL zfftb ( nz, c(1+(i-1)*ldz), tablez ( 1, ip) )
enddo
cout( 1 : ldz * nsl ) = c( 1 : ldz * nsl )
END IF
#elif defined __FFTMKL8
IF (isign < 0) THEN
Status = DftiComputeForWard(Desc_Handle(ip), c , cout)
cout( 1 : ldz * nsl ) = cout( 1 : ldz * nsl ) / nz
ELSE IF (isign > 0) THEN
Status = DftiComputeBackWard(Desc_Handle(ip), c , cout)
END IF
#else
CALL errore(' cft_1z ',' no scalar fft driver specified ', 1)
#endif
#if defined __HPM
CALL f_hpmstop( 30 + ABS(isign) )
#endif
RETURN
END SUBROUTINE cft_1z
!
!
!=----------------------------------------------------------------------=!
!
!
!
! FFT along "x" and "y" direction
!
!
!
!=----------------------------------------------------------------------=!
!
!
SUBROUTINE cft_2xy(r, nzl, nx, ny, ldx, ldy, isign, pl2ix)
! driver routine for nzl 2d complex fft's of lengths nx and ny
! input : r(ldx*ldy) complex, transform is in-place
! ldx >= nx, ldy >= ny are the physical dimensions of the equivalent
! 2d array: r2d(ldx, ldy) (x first dimension, y second dimension)
! (ldx>nx, ldy>ny used on some architectures to reduce memory conflicts)
! pl2ix(nx) (optional) is 1 for columns along y to be transformed
! isign > 0 : forward (f(G)=>f(R)), isign <0 backward (f(R) => f(G))
! Up to "ndims" initializations (for different combinations of input
! parameters nx,ny,nzl,ldx) are stored and re-used if available
IMPLICIT NONE
INTEGER, INTENT(IN) :: isign, ldx, ldy, nx, ny, nzl
INTEGER, OPTIONAL, INTENT(IN) :: pl2ix(:)
COMPLEX (DP) :: r( : )
INTEGER :: i, k, j, err, idir, ip, kk
REAL(DP) :: tscale
INTEGER, SAVE :: icurrent = 1
INTEGER, SAVE :: dims( 4, ndims) = -1
LOGICAL :: dofft( nfftx ), done
INTEGER, PARAMETER :: stdout = 6
#if defined __FFTW
C_POINTER, SAVE :: fw_planx( ndims ) = 0, fw_plany( ndims ) = 0
C_POINTER, SAVE :: bw_planx( ndims ) = 0, bw_plany( ndims ) = 0
#elif defined __FFTW3
C_POINTER, SAVE :: fw_plan( 2, ndims ) = 0
C_POINTER, SAVE :: bw_plan( 2, ndims ) = 0
#elif defined __ESSL
INTEGER, PARAMETER :: ltabl = 20000 + 3 * nfftx
REAL (DP), SAVE :: fw_tablex( ltabl, ndims ), fw_tabley( ltabl, ndims )
REAL (DP), SAVE :: bw_tablex( ltabl, ndims ), bw_tabley( ltabl, ndims )
#elif defined __SCSL
INTEGER, PARAMETER :: ltabl = 2 * nfftx + 256
REAL (DP), SAVE :: tablex (ltabl, ndims), tabley(ltabl, ndims)
COMPLEX (DP) :: XY(nx+nx*ny)
REAL (DP) :: DUMMY
INTEGER, SAVE :: isys(0:1) = (/ 1, 1 /)
#elif defined __COMPLIB
INTEGER, PARAMETER :: ltabl = 4 * nfftx
REAL (DP), SAVE :: tablex (ltabl, ndims), tabley (ltabl, ndims)
#elif defined __SUN
INTEGER, PARAMETER :: ltabl = 4 * nfftx + 15
REAL (DP), SAVE :: tablex (ltabl, ndims)
REAL (DP), SAVE :: tabley (ltabl, ndims)
#elif defined __FFTMKL8
C_POINTER,SAVE :: Desc_Handlex(ndims) = 0
C_POINTER,SAVE :: Desc_Handley(ndims) = 0
integer :: StrideArray(3)
integer :: DimArray(2)
integer :: Status
#endif
#if defined __HPM
CALL f_hpmstart( 40 + ABS(isign), 'cft_2xy' )
#endif
#if defined __SCSL
isys(0) = 1
#endif
dofft( 1 : nx ) = .TRUE.
IF( PRESENT( pl2ix ) ) THEN
IF( SIZE( pl2ix ) < nx ) &
CALL errore( ' cft_2xy ', ' wrong dimension for arg no. 8 ', 1 )
DO i = 1, nx
IF( pl2ix(i) < 1 ) dofft( i ) = .FALSE.
END DO
END IF
! WRITE( stdout,*) 'DEBUG: ', COUNT( dofft )
!
! Here initialize table only if necessary
!
DO ip = 1, ndims
! first check if there is already a table initialized
! for this combination of parameters
done = ( ny == dims(1,ip) ) .AND. ( nx == dims(3,ip) )
#if defined __ESSL || defined __FFTW3
! The initialization in ESSL and FFTW v.3 depends on all four parameters
done = done .AND. ( ldx == dims(2,ip) ) .AND. ( nzl == dims(4,ip) )
#endif
IF (done) EXIT
END DO
IF( .NOT. done ) THEN
! no table exist for these parameters
! initialize a new one
! WRITE( stdout, fmt="('DEBUG cft_2xy, reinitializing tables ', I3)" ) icurrent
#if defined __FFTW
IF( fw_plany( icurrent) /= 0 ) CALL DESTROY_PLAN_1D( fw_plany( icurrent) )
IF( bw_plany( icurrent) /= 0 ) CALL DESTROY_PLAN_1D( bw_plany( icurrent) )
idir = -1; CALL CREATE_PLAN_1D( fw_plany( icurrent), ny, idir)
idir = 1; CALL CREATE_PLAN_1D( bw_plany( icurrent), ny, idir)
IF( fw_planx( icurrent) /= 0 ) CALL DESTROY_PLAN_1D( fw_planx( icurrent) )
IF( bw_planx( icurrent) /= 0 ) CALL DESTROY_PLAN_1D( bw_planx( icurrent) )
idir = -1; CALL CREATE_PLAN_1D( fw_planx( icurrent), nx, idir)
idir = 1; CALL CREATE_PLAN_1D( bw_planx( icurrent), nx, idir)
#elif defined __FFTW3
IF ( ldx /= nx .OR. ldy /= ny ) THEN
IF( fw_plan(2,icurrent) /= 0 ) CALL dfftw_destroy_plan( fw_plan(2,icurrent) )
IF( bw_plan(2,icurrent) /= 0 ) CALL dfftw_destroy_plan( bw_plan(2,icurrent) )
idir = -1
CALL dfftw_plan_many_dft( fw_plan(2,icurrent), 1, ny, 1, r(1:), &
(/ldx*ldy/), ldx, 1, r(1:), (/ldx*ldy/), ldx, 1, idir, &
FFTW_ESTIMATE)
idir = 1
CALL dfftw_plan_many_dft( bw_plan(2,icurrent), 1, ny, 1, r(1:), &
(/ldx*ldy/), ldx, 1, r(1:), (/ldx*ldy/), ldx, 1, idir, &
FFTW_ESTIMATE)
IF( fw_plan(1,icurrent) /= 0 ) CALL dfftw_destroy_plan( fw_plan(1,icurrent) )
IF( bw_plan(1,icurrent) /= 0 ) CALL dfftw_destroy_plan( bw_plan(1,icurrent) )
idir = -1
CALL dfftw_plan_many_dft( fw_plan(1,icurrent), 1, nx, ny, r(1:), &
(/ldx*ldy/), 1, ldx, r(1:), (/ldx*ldy/), 1, ldx, idir, &
FFTW_ESTIMATE)
idir = 1
CALL dfftw_plan_many_dft( bw_plan(1,icurrent), 1, nx, ny, r(1:), &
(/ldx*ldy/), 1, ldx, r(1:), (/ldx*ldy/), 1, ldx, idir, &
FFTW_ESTIMATE)
ELSE
IF( fw_plan( 1, icurrent) /= 0 ) CALL dfftw_destroy_plan( fw_plan( 1, icurrent) )
IF( bw_plan( 1, icurrent) /= 0 ) CALL dfftw_destroy_plan( bw_plan( 1, icurrent) )
idir = -1
CALL dfftw_plan_many_dft( fw_plan( 1, icurrent), 2, (/nx, ny/), nzl,&
r(1:), (/nx, ny/), 1, nx*ny, r(1:), (/nx, ny/), 1, nx*ny, idir,&
FFTW_ESTIMATE)
idir = 1
CALL dfftw_plan_many_dft( bw_plan( 1, icurrent), 2, (/nx, ny/), nzl,&
r(1:), (/nx, ny/), 1, nx*ny, r(1:), (/nx, ny/), 1, nx*ny, idir,&
FFTW_ESTIMATE)
END IF
#elif defined __ESSL
tscale = 1.0d0 / ( nx * ny )
CALL DCFT ( 1, r(1), ldx, 1, r(1), ldx, 1, ny, 1, 1, 1.0d0, &
fw_tabley( 1, icurrent), ltabl, work(1), lwork )
CALL DCFT ( 1, r(1), ldx, 1, r(1), ldx, 1, ny, 1, -1, 1.0d0, &
bw_tabley(1, icurrent), ltabl, work(1), lwork )
CALL DCFT ( 1, r(1), 1, ldx, r(1), 1, ldx, nx, ny, 1, &
tscale, fw_tablex( 1, icurrent), ltabl, work(1), lwork)
CALL DCFT ( 1, r(1), 1, ldx, r(1), 1, ldx, nx, ny, -1, &
1.0d0, bw_tablex(1, icurrent), ltabl, work(1), lwork)
#elif defined __COMPLIB
CALL ZFFT1DI( ny, tabley (1, icurrent) )
CALL ZFFT1DI( nx, tablex (1, icurrent) )
#elif defined __SCSL
CALL ZZFFTMR (0, ny, 0, 0.0D0, DUMMY, 1, DUMMY, 1, &
tabley (1, icurrent), DUMMY, isys)
CALL ZZFFTM (0, nx, 0, 0.0D0, DUMMY, 1, DUMMY, 1, &
tablex (1, icurrent), DUMMY, isys)
#elif defined __SUN
CALL zffti (ny, tabley (1, icurrent) )
CALL zffti (nx, tablex (1, icurrent) )
#elif defined __FFTMKL8
! if(ASSOCIATED(Desc_Handlex(icurrent))) then
IF ( ldx /= nx .OR. ldy /= ny ) THEN
if(Desc_Handlex(icurrent) /= 0) then
Status = DftiFreeDescriptor(Desc_Handlex(icurrent))
endif
! if(ASSOCIATED(Desc_Handlex(icurrent))) then
if(Desc_Handley(icurrent) /= 0) then
Status = DftiFreeDescriptor(Desc_Handley(icurrent))
endif
tscale = 1.0d0 / ( nx * ny )
Status = DftiCreateDescriptor(Desc_Handlex(icurrent), DFTI_DOUBLE,DFTI_COMPLEX,1,nx)
Status = DftiCreateDescriptor(Desc_Handley(icurrent), DFTI_DOUBLE,DFTI_COMPLEX,1,ny)
!Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_FORWARD_SCALE, tscale)
!Status = DftiSetValue(Desc_Handley(icurrent),DFTI_FORWARD_SCALE, tscale)
StrideArray(1) = 0
StrideArray(2) = 1
Status = DftiSetValue(Desc_Handley(icurrent),DFTI_INPUT_STRIDES,StrideArray)
Status = DftiSetValue(Desc_Handley(icurrent),DFTI_OUTPUT_STRIDES,StrideArray)
StrideArray(1) = 0
StrideArray(2) = ldx
Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_INPUT_STRIDES,StrideArray)
Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_OUTPUT_STRIDES,StrideArray)
Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_NUMBER_OF_TRANSFORMS,ny)
Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_INPUT_DISTANCE,ldx)
Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_OUTPUT_DISTANCE,ldx)
Status = DftiCommitDescriptor(Desc_Handlex(icurrent))
Status = DftiCommitDescriptor(Desc_Handley(icurrent))
ELSE
if(Desc_Handlex(icurrent) /= 0) then
Status = DftiFreeDescriptor(Desc_Handlex(icurrent))
endif
DimArray(1) = nx
DimArray(2) = ny
StrideArray(1) = 0
StrideArray(2) = 1
StrideArray(3) = nx
tscale = 1.0d0 / ( nx * ny )
!Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_FORWARD_SCALE, tscale)
Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_PLACEMENT, DFTI_INPLACE)
Status = DftiCreateDescriptor(Desc_Handlex(icurrent), DFTI_DOUBLE,DFTI_COMPLEX,2,DimArray)
Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_INPUT_STRIDES,StrideArray)
Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_OUTPUT_STRIDES,StrideArray)
Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_NUMBER_OF_TRANSFORMS,nzl)
Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_INPUT_DISTANCE,nx*ny)
Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_OUTPUT_DISTANCE,nx*ny)
Status = DftiCommitDescriptor(Desc_Handlex(icurrent))
ENDIF
#else
CALL errore(' cft_2xy ',' no scalar fft driver specified ', 1)
#endif
dims(1,icurrent) = ny; dims(2,icurrent) = ldx;
dims(3,icurrent) = nx; dims(4,icurrent) = nzl;
ip = icurrent
icurrent = MOD( icurrent, ndims ) + 1
END IF
!
! Now perform the FFTs using machine specific drivers
!
#if defined __FFTW
IF( isign < 0 ) THEN
CALL FFT_X_STICK( fw_planx(ip), r(1), nx, ny, nzl, ldx, ldy )
do i = 1, nx
do k = 1, nzl
IF( dofft( i ) ) THEN
j = i + ldx*ldy * ( k - 1 )
call FFT_Y_STICK(fw_plany(ip), r(j), ny, ldx)
END IF
end do
end do
tscale = 1.0d0 / ( nx * ny )
CALL ZDSCAL( ldx * ldy * nzl, tscale, r(1), 1)
ELSE IF( isign > 0 ) THEN
do i = 1, nx
do k = 1, nzl
IF( dofft( i ) ) THEN
j = i + ldx*ldy * ( k - 1 )
call FFT_Y_STICK( bw_plany(ip), r(j), ny, ldx)
END IF
end do
end do
CALL FFT_X_STICK( bw_planx(ip), r(1), nx, ny, nzl, ldx, ldy )
END IF
#elif defined __FFTW3
IF ( ldx /= nx .OR. ldy /= ny ) THEN
IF( isign < 0 ) THEN
do j = 0, nzl-1
CALL dfftw_execute_dft( fw_plan (1, ip), &
r(1+j*ldx*ldy:), r(1+j*ldx*ldy:))
end do
do i = 1, nx
do k = 1, nzl
IF( dofft( i ) ) THEN
j = i + ldx*ldy * ( k - 1 )
call dfftw_execute_dft( fw_plan ( 2, ip), r(j:), r(j:))
END IF
end do
end do
tscale = 1.0d0 / ( nx * ny )
CALL ZDSCAL( ldx * ldy * nzl, tscale, r(1), 1)
ELSE IF( isign > 0 ) THEN
do i = 1, nx
do k = 1, nzl
IF( dofft( i ) ) THEN
j = i + ldx*ldy * ( k - 1 )
call dfftw_execute_dft( bw_plan ( 2, ip), r(j:), r(j:))
END IF
end do
end do
do j = 0, nzl-1
CALL dfftw_execute_dft( bw_plan( 1, ip), &
r(1+j*ldx*ldy:), r(1+j*ldx*ldy:))
end do
END IF
ELSE
IF( isign < 0 ) THEN
call dfftw_execute_dft( fw_plan( 1, ip), r(1:), r(1:))
tscale = 1.0d0 / ( nx * ny )
CALL ZDSCAL( ldx * ldy * nzl, tscale, r(1), 1)
ELSE IF( isign > 0 ) THEN
call dfftw_execute_dft( bw_plan( 1, ip), r(1:), r(1:))
END IF
END IF
#elif defined __ESSL
! essl uses a different convention for forward/backward transforms
! wrt most other implementations: notice the sign of "idir"
IF( isign < 0 ) THEN
idir = 1
tscale = 1.0d0 / ( nx * ny )
do k = 1, nzl
kk = 1 + ( k - 1 ) * ldx * ldy
CALL DCFT ( 0, r(kk), 1, ldx, r(kk), 1, ldx, nx, ny, idir, &
tscale, fw_tablex( 1, ip ), ltabl, work( 1 ), lwork)
do i = 1, nx
IF( dofft( i ) ) THEN
kk = i + ( k - 1 ) * ldx * ldy
call DCFT ( 0, r( kk ), ldx, 1, r( kk ), ldx, 1, ny, 1, &
idir, 1.0d0, fw_tabley(1, ip), ltabl, work( 1 ), lwork)
END IF
end do
end do
ELSE IF( isign > 0 ) THEN
idir = -1
DO k = 1, nzl
do i = 1, nx
IF( dofft( i ) ) THEN
kk = i + ( k - 1 ) * ldx * ldy
call DCFT ( 0, r( kk ), ldx, 1, r( kk ), ldx, 1, ny, 1, &
idir, 1.0d0, bw_tabley(1, ip), ltabl, work( 1 ), lwork)
END IF
end do
kk = 1 + ( k - 1 ) * ldx * ldy
CALL DCFT ( 0, r( kk ), 1, ldx, r( kk ), 1, ldx, nx, ny, idir, &
1.0d0, bw_tablex(1, ip), ltabl, work( 1 ), lwork)
END DO
END IF
#elif defined __COMPLIB
IF( isign < 0 ) THEN
idir = -1
DO i = 1, nzl
k = 1 + ( i - 1 ) * ldx * ldy
call zfftm1d( idir, nx, ny, r(k), 1, ldx, tablex (1, ip) )
END DO
do i = 1, nx
IF( dofft( i ) ) THEN
call zfftm1d( idir, ny, nzl, r(i), ldx, ldx*ldy, tabley (1, ip) )
END IF
end do
tscale = 1.0d0 / ( nx * ny )
CALL ZDSCAL( ldx * ldy * nzl, tscale, r(1), 1)
ELSE IF( isign > 0 ) THEN
idir = 1
do i = 1, nx
IF( dofft( i ) ) THEN
call zfftm1d( idir, ny, nzl, r(i), ldx, ldx*ldy, tabley (1, ip) )
END IF
end do
DO i = 1, nzl
k = 1 + ( i - 1 ) * ldx * ldy
call zfftm1d( idir, nx, ny, r(k), 1, ldx, tablex (1, ip) )
END DO
END IF
#elif defined __SCSL
IF( isign < 0 ) THEN
idir = -1
tscale = 1.0d0 / (nx * ny)
DO k = 0, nzl-1
kk = k * ldx * ldy
! FORWARD: ny FFTs in the X direction
CALL ZZFFTM ( idir, nx, ny, tscale, r(kk+1), ldx, r(kk+1), ldx, &
tablex (1, ip), work(1), isys )
! FORWARD: nx FFTs in the Y direction
DO i = 1, nx
IF ( dofft(i) ) THEN
!DIR$IVDEP
!DIR$LOOP COUNT (50)
DO j = 0, ny-1
XY(j+1) = r(i + (j) * ldx + kk)
END DO
CALL ZZFFT(idir, ny, 1.0D0, XY, XY, tabley (1, ip), &
work(1), isys)
!DIR$IVDEP
!DIR$LOOP COUNT (50)
DO j = 0, ny-1
r(i + (j) * ldx + kk) = XY(j+1)
END DO
END IF
END DO
END DO
ELSE IF ( isign > 0 ) THEN
idir = 1
tscale = 1.0d0
DO k = 0, nzl-1
! BACKWARD: nx FFTs in the Y direction
kk = (k) * ldx * ldy
DO i = 1, nx
IF ( dofft(i) ) THEN
!DIR$IVDEP
!DIR$LOOP COUNT (50)
DO j = 0, ny-1
XY(j+1) = r(i + (j) * ldx + kk)
END DO
CALL ZZFFT(idir, ny, 1.0D0, XY, XY, tabley (1, ip), &
work(1), isys)
!DIR$IVDEP
!DIR$LOOP COUNT (50)
DO j = 0, ny-1
r(i + (j) * ldx + kk) = XY(j+1)
END DO
END IF
END DO
! BACKWARD: ny FFTs in the X direction
CALL ZZFFTM ( idir, nx, ny, tscale, r(kk+1), ldx, r(kk+1), ldx, &
tablex (1, ip), work(1), isys )
END DO
END IF
#elif defined __SUN
IF ( isign < 0 ) THEN
DO k = 1, ny * nzl
kk = 1 + ( k - 1 ) * ldx
CALL zfftf ( nx, r (kk), tablex (1, ip) )
END DO
DO i = 1, nx
IF ( dofft(i) ) THEN
DO j = 1, nzl
kk = (j - 1) * ldx * ny + i
CALL ZCOPY (ny, r (kk), ldx, work, 1)
CALL zfftf (ny, work, tabley (1, ip) )
CALL ZCOPY (ny, work, 1, r (kk), ldx)
END DO
END IF
END DO
CALL ZDSCAL ( ldx * ny * nzl, 1d0/(nx * ny), r, 1)
ELSE IF (isign > 0) THEN
DO i = 1, nx
IF ( dofft(i) ) THEN
DO j = 1, nzl
kk = (j - 1) * ldx * ny + i
CALL ZCOPY (ny, r (kk), ldx, work, 1)
CALL zfftb (ny, work, tabley (1, ip) )
CALL ZCOPY (ny, work, 1, r (kk), ldx)
END DO
END IF
END DO
DO k = 1, ny * nzl
kk = 1 + ( k - 1 ) * ldx
CALL zfftb ( nx, r (kk), tablex (1, ip) )
END DO
END IF
#elif defined __FFTMKL8
IF ( ldx /= nx .OR. ldy /= ny ) THEN
IF( isign < 0 ) THEN
do j = 0, nzl-1
Status = DftiComputeForWard(Desc_Handlex(ip), &
r(1+j*ldx*ldy:), r(1+j*ldx*ldy:))
end do
do i = 1, nx
do k = 1, nzl
IF( dofft( i ) ) THEN
j = i + ldx*ldy * ( k - 1 )
Status = DftiComputeForWard(Desc_Handley ( ip), r(j:), r(j:))
END IF
end do
end do
tscale = 1.0d0 / ( nx * ny )
CALL ZDSCAL( ldx * ldy * nzl, tscale, r(1), 1)
ELSE IF( isign > 0 ) THEN
do i = 1, nx
do k = 1, nzl
IF( dofft( i ) ) THEN
j = i + ldx*ldy * ( k - 1 )
Status = DftiComputeBackWard(Desc_Handley(ip), r(j:), r(j:))
END IF
end do
end do
do j = 0, nzl-1
Status = DftiComputeBackWard(Desc_Handlex(ip), &
r(1+j*ldx*ldy:), r(1+j*ldx*ldy:))
end do
END IF
ELSE
IF( isign < 0 ) THEN
Status = DftiComputeForWard( Desc_Handlex(ip), r(1:), r(1:))
tscale = 1.0d0 / ( nx * ny )
CALL ZDSCAL( ldx * ldy * nzl, tscale, r(1), 1)
ELSE IF( isign > 0 ) THEN
Status = DftiComputeBackWard( Desc_Handlex( ip), r(1:), r(1:))
END IF
END IF
#else
CALL errore(' cft_2xy ',' no scalar fft driver specified ', 1)
#endif
#if defined __HPM
CALL f_hpmstop( 40 + ABS(isign) )
#endif
RETURN
END SUBROUTINE cft_2xy
!
!=----------------------------------------------------------------------=!
!
!
!
! 3D scalar FFTs
!
!
!
!=----------------------------------------------------------------------=!
!
SUBROUTINE cfft3d( f, nx, ny, nz, ldx, ldy, ldz, isign )
! driver routine for 3d complex fft of lengths nx, ny, nz
! input : f(ldx*ldy*ldz) complex, transform is in-place
! ldx >= nx, ldy >= ny, ldz >= nz are the physical dimensions
! of the equivalent 3d array: f3d(ldx,ldy,ldz)
! (ldx>nx, ldy>ny, ldz>nz may be used on some architectures
! to reduce memory conflicts - not implemented for FFTW)
! isign > 0 : f(G) => f(R) ; isign < 0 : f(R) => f(G)
!
! Up to "ndims" initializations (for different combinations of input
! parameters nx,ny,nz) are stored and re-used if available
IMPLICIT NONE
INTEGER, INTENT(IN) :: nx, ny, nz, ldx, ldy, ldz, isign
COMPLEX (DP) :: f(:)
INTEGER :: i, k, j, err, idir, ip
REAL(DP) :: tscale
INTEGER, SAVE :: icurrent = 1
INTEGER, SAVE :: dims(3,ndims) = -1
#if defined __FFTW || defined __FFTW3
C_POINTER, save :: fw_plan(ndims) = 0
C_POINTER, save :: bw_plan(ndims) = 0
#elif defined __SCSL
INTEGER, PARAMETER :: ltabl = (2 * nfftx + 256)*3
REAL (DP), SAVE :: table (ltabl, ndims)
REAL (DP) :: DUMMY
INTEGER, SAVE :: isys(0:1) = (/ 1, 1 /)
#elif defined __COMPLIB
! SGI scientific library complib
INTEGER, PARAMETER :: ltabl = (4 * nfftx)*3
REAL (DP), SAVE :: table (ltabl, ndims)
#elif defined __SUN
INTEGER, PARAMETER :: ltabl = (4 * nfftx + 15)*3
REAL (DP), SAVE :: table (ltabl, ndims)
#elif defined __FFTMKL8
C_POINTER,SAVE :: Desc_Handle(ndims) = 0
INTEGER Status
INTEGER DimArray(3)
INTEGER StrideArray(4)
#elif defined __SX6
INTEGER, PARAMETER :: ltabl = 60
INTEGER, PARAMETER :: lwork = 195+6*nfftx
INTEGER, SAVE :: iw0(ltabl, ndims)
REAL (DP), SAVE :: auxp (lwork, ndims)
! not sure whether auxp is work space or not
COMPLEX(DP), DIMENSION(:), ALLOCATABLE :: cw2
# if defined ASL && defined MICRO
INTEGER :: nbtasks
COMMON/NEC_ASL_PARA/nbtasks
# endif
#elif defined DXML
STRUCTURE / DXML_Z_FFT_STRUCTURE /
INTEGER :: N
LOGICAL :: STRIDE_1_FLAG
INTEGER :: N_TI (0:16)
INTEGER :: N_K (0:16)
INTEGER :: N_T (0:16)
INTEGER :: TYPE (0:16)
INTEGER :: NUM_STAGES
INTEGER (8) :: ROTATION_VECTOR
INTEGER :: ROTATION_VECTOR_SIZE
INTEGER (8) :: TEMP_AREA
INTEGER :: TEMP_AREA_SIZE
INTEGER :: SET_BLOCK_SIZE
INTEGER :: NUM_NON_SPECIAL_RADIX
INTEGER :: NON_SPECIAL_RADIX (0:16)
INTEGER :: NON_SPEC_RAD_TWIDDLE_SIZE
INTEGER (8) :: NON_SPEC_RAD_TWIDDLE_VEC
INTEGER (8) :: NON_SPECIAL_RADIX_COS (0:16)
INTEGER (8) :: NON_SPECIAL_RADIX_SIN (0:16)
INTEGER :: FUTURE_USE (20)
INTEGER :: GK (0:11)
ENDSTRUCTURE
record / DXML_Z_FFT_STRUCTURE / fft_struct (ndims)
#endif
#if defined __HPM
CALL f_hpmstart( 50 + ABS(isign), 'cfft3d' )
#endif
#if defined __SX6
# if defined ASL
ALLOCATE (cw2(ldx*ldy*ldz))
CALL zfc3cl (f(1), nx, ny, nz, ldx, ldy, ldz, err)
# else
ALLOCATE (cw2(6*ldx*ldy*ldz))
# endif
#endif
!
! Here initialize table only if necessary
!
ip = -1
DO i = 1, ndims
! first check if there is already a table initialized
! for this combination of parameters
IF ( ( nx == dims(1,i) ) .and. &
( ny == dims(2,i) ) .and. &
( nz == dims(3,i) ) ) THEN
ip = i
EXIT
END IF
END DO
IF( ip == -1 ) THEN
! no table exist for these parameters
! initialize a new one
#if defined __FFTW
IF ( nx /= ldx .or. ny /= ldy .or. nz /= ldz ) &
call errore('cfft3','not implemented',1)
IF( fw_plan(icurrent) /= 0 ) CALL DESTROY_PLAN_3D( fw_plan(icurrent) )
IF( bw_plan(icurrent) /= 0 ) CALL DESTROY_PLAN_3D( bw_plan(icurrent) )
idir = -1; CALL CREATE_PLAN_3D( fw_plan(icurrent), nx, ny, nz, idir)
idir = 1; CALL CREATE_PLAN_3D( bw_plan(icurrent), nx, ny, nz, idir)
#elif defined __FFTW3
IF ( nx /= ldx .or. ny /= ldy .or. nz /= ldz ) &
call errore('cfft3','not implemented',3)
IF( fw_plan(icurrent) /= 0 ) CALL dfftw_destroy_plan( fw_plan(icurrent) )
IF( bw_plan(icurrent) /= 0 ) CALL dfftw_destroy_plan( bw_plan(icurrent) )
idir = -1
CALL dfftw_plan_dft_3d ( fw_plan(icurrent), nx, ny, nz, f(1:), &
f(1:), idir, FFTW_ESTIMATE)
idir = 1
CALL dfftw_plan_dft_3d ( bw_plan(icurrent), nx, ny, nz, f(1:), &
f(1:), idir, FFTW_ESTIMATE)
#elif defined __ESSL
! no initialization for 3d FFT's from ESSL
#elif defined __COMPLIB
write (6,*) "Warning: FFTs have been heavily restructured, those using complib are untested"
write (6,*) "Warning: Please locate and remove the following line in Modules/fft_scalar.f90:"
write (6,*) " call errore('cfft3d','complib untested, please test',1)"
write (6,*) "Warning: Please recompile, test, report if it works"
call errore('cfft3d','complib untested, please test',1)
CALL zfft3di( nx, ny, nz, table(1,icurrent) )
#elif defined __SCSL
CALL zzfft3d (0, nx, ny, nz, 0.0D0, DUMMY, 1, 1, DUMMY, 1, 1, &
table(1,icurrent), work(1), isys)
#elif defined __SUN
write (6,*) "Warning: FFTs have been heavily restructured, those using sunperf are untested"
write (6,*) "Warning: Please locate and remove the following line in Modules/fft_scalar.f90:"
write (6,*) " call errore('cfft3d','sunperf untested, please test',1)"
write (6,*) "Warning: Please recompile, test, report if it works"
call errore('cfft3d','sunperf untested, please test',1)
CALL zfft3i ( nx, ny, nz, table (1,icurrent) )
#elif defined __FFTMKL8
IF ( nx /= ldx .or. ny /= ldy .or. nz /= ldz ) &
call errore('cfft3','not implemented',1)
DimArray(1) = nx
DimArray(2) = ny
DimArray(3) = nz
tscale = 1.0d0 / (nx * ny * nz)
Status = DftiCreateDescriptor(Desc_Handle(icurrent) , &
DFTI_DOUBLE,DFTI_COMPLEX,3,DimArray)
Status = DftiSetValue(Desc_Handle(icurrent) , &
DFTI_PLACEMENT,DFTI_INPLACE)
Status = DftiSetValue(Desc_Handle(icurrent), DFTI_FORWARD_SCALE, tscale )
status = DftiCommitDescriptor(Desc_Handle(icurrent))
#elif defined __SX6
# if defined ASL
# if defined MICRO
CALL hfc3fb (nx,ny,nz, f(1) , ldx, ldy, ldz, 0, &
iw0(1,icurrent), auxp(1,icurrent), cw2(1), nbtasks, err)
# else
CALL zfc3fb (nx,ny,nz, f(1), ldx, ldy, ldz, 0, &
iw0(1,icurrent), auxp(1,icurrent), cw2(1), err)
# endif
# else
CALL ZZFFT3D (0, nx,ny,nz, 1.d0, f(1), ldx, ldy, &
& f(1), ldx, ldy, auxp(1,icurrent), cw2(1), err)
# endif
IF (err /= 0) CALL errore('cfft3d','FFT init returned an error ', err)
#elif DXML
write (6,*) "Warning: FFTs have been heavily restructured, those using cxml are untested"
write (6,*) "Warning: Please locate and remove the following line in Modules/fft_scalar.f90:"
write (6,*) " call errore('cfft3d','cxml untested, please test',1)"
write (6,*) "Warning: Please recompile, test, report if it works"
call errore('cfft3d','cxml untested, please test',1)
err = zfft_exit_3d (fft_struct (icurrent) )
! not sure whether the above call is useful or not
err = zfft_init_3d (nx, ny, nz, fft_struct (icurrent), .TRUE.)
#else
CALL errore(' cfft3d ',' no scalar fft driver specified ', 1)
#endif
dims(1,icurrent) = nx; dims(2,icurrent) = ny; dims(3,icurrent) = nz
ip = icurrent
icurrent = MOD( icurrent, ndims ) + 1
END IF
!
! Now perform the 3D FFT using the machine specific driver
!
#if defined __FFTW
IF( isign < 0 ) THEN
call FFTW_INPLACE_DRV_3D( fw_plan(ip), 1, f(1), 1, 1 )
tscale = 1.0d0 / DBLE( nx * ny * nz )
call ZDSCAL( nx * ny * nz, tscale, f(1), 1)
ELSE IF( isign > 0 ) THEN
call FFTW_INPLACE_DRV_3D( bw_plan(ip), 1, f(1), 1, 1 )
END IF
#elif defined __FFTW3
IF( isign < 0 ) THEN
call dfftw_execute_dft( fw_plan(ip), f(1:), f(1:))
tscale = 1.0d0 / DBLE( nx * ny * nz )
call ZDSCAL( nx * ny * nz, tscale, f(1), 1)
ELSE IF( isign > 0 ) THEN
call dfftw_execute_dft( bw_plan(ip), f(1:), f(1:))
END IF
#elif defined __ESSL
IF ( isign < 0 ) THEN
tscale = 1.0d0 / ( nx * ny * nz )
idir = +1
ELSE IF( isign > 0 ) THEN
tscale = 1.0d0
idir = -1
END IF
IF( isign /= 0 ) CALL dcft3( f(1), ldx,ldx*ldy, f(1), ldx,ldx*ldy, &
nx,ny,nz, idir, tscale, work(1), lwork)
#elif defined __COMPLIB
IF( isign /= 0 ) THEN
IF( isign < 0 ) idir = -1
IF( isign > 0 ) idir = +1
CALL zfft3d( idir, nx, ny, nz, f(1), ldx, ldy, table(1,ip) )
IF( isign < 0 ) THEN
tscale = 1.0d0 / DBLE( nx * ny * nz )
call ZDSCAL( ldx * ldy * ldz, tscale, f(1), 1)
END IF
END IF
#elif defined __SCSL
IF ( isign /= 0 ) THEN
IF ( isign < 0 ) THEN
idir = -1
tscale = 1.0D0 / DBLE( nx * ny * nz )
ELSE IF ( isign > 0 ) THEN
idir = 1
tscale = 1.0D0
END IF
CALL ZZFFT3D ( idir, nx, ny, nz, tscale, f(1), ldx, ldy, &
f(1), ldx, ldy, table(1,ip), work(1), isys )
END IF
#elif defined __SUN
IF( isign < 0 ) THEN
CALL zfft3f ( nx, ny, nz, f(1), ldx, ldy, table(1,ip), ltabl )
tscale = 1.0D0 / DBLE( nx * ny * nz )
CALL ZDSCAL ( ldx*ldy*ldz, tscale, f(1), 1 )
ELSE IF( isign > 0 ) THEN
CALL zfft3b ( nx, ny, nz, f(1), ldx, ldy, table(1,ip), ltabl )
ENDIF
#elif defined __FFTMKL8
IF( isign < 0 ) THEN
Status = DftiComputeForWard( Desc_Handle(ip), f(1:), f(1:))
ELSE IF( isign > 0 ) THEN
Status = DftiComputeBackWard( Desc_Handle(ip), f(1:), f(1:))
END IF
#elif defined __SX6
# if defined ASL
# if defined MICRO
CALL hfc3bf (nx,ny,nz, f(1), ldx,ldy, ldz, &
-isign, iw0(1,ip), auxp(1,ip), cw2(1), nbtasks, err)
# else
CALL zfc3bf (nx,ny,nz, f(1), ldx,ldy, ldz, &
-isign, iw0(1,ip), auxp(1,ip), cw2(1), err)
# endif
# else
CALL ZZFFT3D (isign, nx,ny,nz, 1.d0, f(1), ldx,ldy, &
f(1), ldx,ldy, auxp(1,ip), cw2(1), err)
# endif
IF ( isign < 0) THEN
tscale = 1.0d0 / DBLE( nx * ny * nz )
call ZDSCAL( ldx * ldy * ldz, tscale, f(1), 1)
END IF
IF (err /= 0) CALL errore('cfft3d','FFT returned an error ', err)
DEALLOCATE(cw2)
#elif DXML
IF ( isign < 0) THEN
CALL zfft_apply_3d ('C', 'C', 'f', f, f, ldx, ldy, &
fft_struct (ip) , 1, 1, 1)
tscale = 1.0D0 / DBLE( nx * ny * nz )
CALL ZDSCAL ( ldx*ldy*ldz, tscale, f(1), 1 )
ELSE IF ( isign > 0) THEN
CALL zfft_apply_3d ('C', 'C', 'b', f, f, ldx, ldy, &
fft_struct (ip) , 1, 1, 1)
tscale = DBLE( nx * ny * nz )
CALL ZDSCAL ( ldx*ldy*ldz, tscale, f(1), 1 )
END IF
#endif
#if defined __HPM
CALL f_hpmstop( 50 + ABS(isign) )
#endif
RETURN
END SUBROUTINE cfft3d
!
!=----------------------------------------------------------------------=!
!
!
!
! 3D scalar FFTs, but using sticks!
!
!
!
!=----------------------------------------------------------------------=!
!
SUBROUTINE cfft3ds (f, nx, ny, nz, ldx, ldy, ldz, isign, &
do_fft_x, do_fft_y)
!
! driver routine for 3d complex "reduced" fft - see cfft3d
! The 3D fft are computed only on lines and planes which have
! non zero elements. These lines and planes are defined by
! the two integer vectors do_fft_x(ldy*nz) and do_fft_y(nz)
! (1 = perform fft, 0 = do not perform fft)
! The routine is implemented for essl and fftw library only
!
!----------------------------------------------------------------------
!
implicit none
integer :: nx, ny, nz, ldx, ldy, ldz, isign
!
! logical dimensions of the fft
! physical dimensions of the f array
! sign of the transformation
complex(DP) :: f ( ldx * ldy * ldz )
integer :: do_fft_x(:), do_fft_y(:)
!
integer :: m, incx1, incx2
INTEGER :: i, k, j, err, idir, ip, ii, jj
REAL(DP) :: tscale
INTEGER, SAVE :: icurrent = 1
INTEGER, SAVE :: dims(3,ndims) = -1
#if defined __FFTW || __FFTW3
C_POINTER, SAVE :: fw_plan ( 3, ndims ) = 0
C_POINTER, SAVE :: bw_plan ( 3, ndims ) = 0
#elif defined __ESSL
INTEGER, PARAMETER :: ltabl = 20000 + 3 * nfftx
REAL (DP), SAVE :: fw_table( ltabl, 3, ndims )
REAL (DP), SAVE :: bw_table( ltabl, 3, ndims )
#elif __FFTMKL8
C_POINTER,SAVE :: Desc_Handlex(ndims) = 0
C_POINTER,SAVE :: Desc_Handley(ndims) = 0
C_POINTER,SAVE :: Desc_Handlez(ndims) = 0
INTEGER DimArray(3)
INTEGER StrideArray(4)
INTEGER Status
#endif
tscale = 1.d0
!
! ESSL sign convention for fft's is the opposite of the "usual" one
!
! WRITE( stdout, fmt="('DEBUG cfft3ds :',6I6)") nx, ny, nz, ldx, ldy, ldz
! WRITE( stdout, fmt="('DEBUG cfft3ds :',24I2)") do_fft_x
! WRITE( stdout, fmt="('DEBUG cfft3ds :',24I2)") do_fft_y
IF( ny /= ldy ) &
CALL errore(' cfft3ds ', ' wrong dimensions: ny /= ldy ', 1 )
ip = -1
DO i = 1, ndims
! first check if there is already a table initialized
! for this combination of parameters
IF( ( nx == dims(1,i) ) .and. ( ny == dims(2,i) ) .and. &
( nz == dims(3,i) ) ) THEN
ip = i
EXIT
END IF
END DO
IF( ip == -1 ) THEN
! no table exist for these parameters
! initialize a new one
#if defined __FFTW
IF( fw_plan( 1, icurrent) /= 0 ) CALL DESTROY_PLAN_1D( fw_plan( 1, icurrent) )
IF( bw_plan( 1, icurrent) /= 0 ) CALL DESTROY_PLAN_1D( bw_plan( 1, icurrent) )
IF( fw_plan( 2, icurrent) /= 0 ) CALL DESTROY_PLAN_1D( fw_plan( 2, icurrent) )
IF( bw_plan( 2, icurrent) /= 0 ) CALL DESTROY_PLAN_1D( bw_plan( 2, icurrent) )
IF( fw_plan( 3, icurrent) /= 0 ) CALL DESTROY_PLAN_1D( fw_plan( 3, icurrent) )
IF( bw_plan( 3, icurrent) /= 0 ) CALL DESTROY_PLAN_1D( bw_plan( 3, icurrent) )
idir = -1; CALL CREATE_PLAN_1D( fw_plan( 1, icurrent), nx, idir)
idir = 1; CALL CREATE_PLAN_1D( bw_plan( 1, icurrent), nx, idir)
idir = -1; CALL CREATE_PLAN_1D( fw_plan( 2, icurrent), ny, idir)
idir = 1; CALL CREATE_PLAN_1D( bw_plan( 2, icurrent), ny, idir)
idir = -1; CALL CREATE_PLAN_1D( fw_plan( 3, icurrent), nz, idir)
idir = 1; CALL CREATE_PLAN_1D( bw_plan( 3, icurrent), nz, idir)
#elif defined __FFTW3
IF( fw_plan( 1, icurrent) /= 0 ) &
CALL dfftw_destroy_plan( fw_plan( 1, icurrent) )
IF( bw_plan( 1, icurrent) /= 0 ) &
CALL dfftw_destroy_plan( bw_plan( 1, icurrent) )
IF( fw_plan( 2, icurrent) /= 0 ) &
CALL dfftw_destroy_plan( fw_plan( 2, icurrent) )
IF( bw_plan( 2, icurrent) /= 0 ) &
CALL dfftw_destroy_plan( bw_plan( 2, icurrent) )
IF( fw_plan( 3, icurrent) /= 0 ) &
CALL dfftw_destroy_plan( fw_plan( 3, icurrent) )
IF( bw_plan( 3, icurrent) /= 0 ) &
CALL dfftw_destroy_plan( bw_plan( 3, icurrent) )
idir = -1
CALL dfftw_plan_many_dft( fw_plan( 1, icurrent), &
1, nx, 1, f(1:), (/ldx, ldy, ldz/), 1, ldx, &
f(1:), (/ldx, ldy, ldz/), 1, ldx, idir, FFTW_ESTIMATE)
idir = 1
CALL dfftw_plan_many_dft( bw_plan( 1, icurrent), &
1, nx, 1, f(1:), (/ldx, ldy, ldz/), 1, ldx, &
f(1:), (/ldx, ldy, ldz/), 1, ldx, idir, FFTW_ESTIMATE)
idir = -1
CALL dfftw_plan_many_dft( fw_plan( 2, icurrent), &
1, ny, nx, f(1:), (/ldx, ldy, ldz/), ldx, 1, &
f(1:), (/ldx, ldy, ldz/), ldx, 1, idir, FFTW_ESTIMATE)
idir = 1
CALL dfftw_plan_many_dft( bw_plan( 2, icurrent), &
1, ny, nx, f(1:), (/ldx, ldy, ldz/), ldx, 1, &
f(1:), (/ldx, ldy, ldz/), ldx, 1, idir, FFTW_ESTIMATE)
idir = -1
CALL dfftw_plan_many_dft( fw_plan( 3, icurrent), &
1, nz, nx*ny, f(1:), (/ldx, ldy, ldz/), ldx*ldy, 1, &
f(1:), (/ldx, ldy, ldz/), ldx*ldy, 1, idir, FFTW_ESTIMATE)
idir = 1
CALL dfftw_plan_many_dft( bw_plan( 3, icurrent), &
1, nz, nx*ny, f(1:), (/ldx, ldy, ldz/), ldx*ldy, 1, &
f(1:), (/ldx, ldy, ldz/), ldx*ldy, 1, idir, FFTW_ESTIMATE)
#elif defined __ESSL
tscale = 1.0d0
! x - direction
incx1 = 1; incx2 = ldx; m = 1
CALL DCFT ( 1, f(1), incx1, incx2, f(1), incx1, incx2, nx, m, 1, 1.0d0, &
fw_table( 1, 1, icurrent), ltabl, work(1), lwork )
CALL DCFT ( 1, f(1), incx1, incx2, f(1), incx1, incx2, nx, m, -1, 1.0d0, &
bw_table(1, 1, icurrent), ltabl, work(1), lwork )
! y - direction
incx1 = ldx; incx2 = 1; m = nx;
CALL DCFT ( 1, f(1), incx1, incx2, f(1), incx1, incx2, ny, m, 1, 1.0d0, &
fw_table( 1, 2, icurrent), ltabl, work(1), lwork )
CALL DCFT ( 1, f(1), incx1, incx2, f(1), incx1, incx2, ny, m, -1, 1.0d0, &
bw_table(1, 2, icurrent), ltabl, work(1), lwork )
! z - direction
incx1 = ldx * ldy; incx2 = 1; m = ldx * ny
CALL DCFT ( 1, f(1), incx1, incx2, f(1), incx1, incx2, nz, m, 1, 1.0d0, &
fw_table(1, 3, icurrent), ltabl, work(1), lwork )
CALL DCFT ( 1, f(1), incx1, incx2, f(1), incx1, incx2, nz, m, -1, 1.0d0, &
bw_table(1, 3, icurrent), ltabl, work(1), lwork )
#elif defined __FFTMKL8
! IF(ASSOCIATED(Desc_Handlex(icurrent))) then
IF(Desc_Handlex(icurrent)/=0) then
Status = DftiFreeDescriptor(Desc_Handlex(icurrent))
ENDIF
! IF(ASSOCIATED(Desc_Handley(icurrent))) then
IF(Desc_Handley(icurrent)/=0) then
Status = DftiFreeDescriptor(Desc_Handley(icurrent))
ENDIF
! IF(ASSOCIATED(Desc_Handlez(icurrent))) then
IF(Desc_Handlez(icurrent)/=0) then
Status = DftiFreeDescriptor(Desc_Handlez(icurrent))
ENDIF
tscale = 1.0d0 / ( nx * ny * nz)
Status = DftiCreateDescriptor(Desc_Handlex(icurrent), DFTI_DOUBLE,DFTI_COMPLEX,1,nx)
Status = DftiCreateDescriptor(Desc_Handley(icurrent), DFTI_DOUBLE,DFTI_COMPLEX,1,ny)
Status = DftiCreateDescriptor(Desc_Handlez(icurrent), DFTI_DOUBLE,DFTI_COMPLEX,1,nz)
StrideArray(1) = 0
StrideArray(2) = 1
Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_INPUT_STRIDES,StrideArray)
StrideArray(2) = ldx
Status = DftiSetValue(Desc_Handley(icurrent),DFTI_INPUT_STRIDES,StrideArray)
StrideArray(2) = ldx*ldy
Status = DftiSetValue(Desc_Handlez(icurrent),DFTI_INPUT_STRIDES,StrideArray)
! Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_BACKWARD_SCALE, tscale)
! Status = DftiSetValue(Desc_Handley(icurrent),DFTI_BACKWARD_SCALE, tscale)
Status = DftiSetValue(Desc_Handley(icurrent),DFTI_NUMBER_OF_TRANSFORMS,nx)
Status = DftiSetValue(Desc_Handlez(icurrent),DFTI_NUMBER_OF_TRANSFORMS,nx*ny)
Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_INPUT_DISTANCE,ldx)
Status = DftiCommitDescriptor(Desc_Handlex(icurrent))
Status = DftiCommitDescriptor(Desc_Handley(icurrent))
Status = DftiCommitDescriptor(Desc_Handlez(icurrent))
#else
CALL errore(' cfft3ds ',' no scalar fft driver specified ', 1)
#endif
dims(1,icurrent) = nx; dims(2,icurrent) = ny; dims(3,icurrent) = nz
ip = icurrent
icurrent = MOD( icurrent, ndims ) + 1
END IF
IF ( isign > 0 ) THEN
!
! i - direction ...
!
incx1 = 1; incx2 = ldx; m = 1
do k = 1, nz
do j = 1, ny
jj = j + ( k - 1 ) * ldy
ii = 1 + ldx * ( jj - 1 )
if ( do_fft_x( jj ) == 1 ) THEN
#if defined __FFTW
call FFTW_INPLACE_DRV_1D( bw_plan( 1, ip), m, f( ii ), incx1, incx2 )
#elif defined __FFTW3
call dfftw_execute_dft( bw_plan( 1, ip), f( ii: ), f( ii: ) )
#elif defined __ESSL
call dcft (0, f ( ii ), incx1, incx2, f ( ii ), incx1, incx2, nx, m, &
-isign, 1.0d0, bw_table ( 1, 1, ip ), ltabl, work( 1 ), lwork)
#elif defined __FFTMKL8
Status = DftiComputeForward(Desc_Handlex(ip) , f( ii: ) , f( ii: ))
#else
call errore(' cfft3ds ',' no scalar fft driver specified ', 1)
#endif
endif
enddo
enddo
!
! ... j-direction ...
!
incx1 = ldx; incx2 = 1; m = nx
do k = 1, nz
ii = 1 + ldx * ldy * ( k - 1 )
if ( do_fft_y( k ) == 1 ) then
#if defined __FFTW
call FFTW_INPLACE_DRV_1D( bw_plan( 2, ip), m, f( ii ), incx1, incx2 )
#elif defined __FFTW3
call dfftw_execute_dft( bw_plan( 2, ip), f( ii: ), f( ii: ) )
#elif defined __ESSL
call dcft (0, f ( ii ), incx1, incx2, f ( ii ), incx1, incx2, ny, m, &
-isign, 1.0d0, bw_table ( 1, 2, ip ), ltabl, work( 1 ), lwork)
#elif defined __FFTMKL8
Status = DftiComputeBackWard(Desc_Handley(ip) , f( ii: ) , f( ii: ))
#else
call errore(' cfft3ds ',' no scalar fft driver specified ', 1)
#endif
endif
enddo
!
! ... k-direction
!
incx1 = ldx * ldy; incx2 = 1; m = ldx * ny
#if defined __FFTW
call FFTW_INPLACE_DRV_1D( bw_plan( 3, ip), m, f( 1 ), incx1, incx2 )
#elif defined __FFTW3
call dfftw_execute_dft( bw_plan( 3, ip), f(1:), f(1:) )
#elif defined __ESSL
call dcft (0, f( 1 ), incx1, incx2, f( 1 ), incx1, incx2, nz, m, &
-isign, 1.0d0, bw_table ( 1, 3, ip ), ltabl, work( 1 ), lwork)
#elif defined __FFTMKL8
Status = DftiComputeBackWard(Desc_Handlez(ip) , f( 1: ) , f( 1: ))
#endif
ELSE
!
! ... k-direction
!
incx1 = ldx * ny; incx2 = 1; m = ldx * ny
#if defined __FFTW
call FFTW_INPLACE_DRV_1D( fw_plan( 3, ip), m, f( 1 ), incx1, incx2 )
#elif defined __FFTW3
call dfftw_execute_dft( fw_plan( 3, ip), f(1:), f(1:) )
#elif defined __ESSL
call dcft (0, f( 1 ), incx1, incx2, f( 1 ), incx1, incx2, nz, m, &
-isign, 1.0d0, fw_table ( 1, 3, ip ), ltabl, work( 1 ), lwork)
#elif defined __FFTMKL8
Status = DftiComputeForWard(Desc_Handlez(ip) , f( 1: ) , f( 1: ))
#endif
!
! ... j-direction ...
!
incx1 = ldx; incx2 = 1; m = nx
do k = 1, nz
ii = 1 + ldx * ldy * ( k - 1 )
if ( do_fft_y ( k ) == 1 ) then
#if defined __FFTW
call FFTW_INPLACE_DRV_1D( fw_plan( 2, ip), m, f( ii ), incx1, incx2 )
#elif defined __FFTW3
call dfftw_execute_dft( fw_plan( 2, ip), f( ii: ), f( ii: ) )
#elif defined __ESSL
call dcft (0, f ( ii ), incx1, incx2, f ( ii ), incx1, incx2, ny, m, &
-isign, 1.0d0, fw_table ( 1, 2, ip ), ltabl, work( 1 ), lwork)
#elif defined __FFTMKL8
Status = DftiComputeForWard(Desc_Handley(ip) , f( ii: ) , f( ii: ))
#else
call errore(' cfft3ds ',' no scalar fft driver specified ', 1)
#endif
endif
enddo
!
! i - direction ...
!
incx1 = 1; incx2 = ldx; m = 1
do k = 1, nz
do j = 1, ny
jj = j + ( k - 1 ) * ldy
ii = 1 + ldx * ( jj - 1 )
if ( do_fft_x( jj ) == 1 ) then
#if defined __FFTW
call FFTW_INPLACE_DRV_1D( fw_plan( 1, ip), m, f( ii ), incx1, incx2 )
#elif defined __FFTW3
call dfftw_execute_dft( fw_plan( 1, ip), f( ii: ), f( ii: ) )
#elif defined __ESSL
call dcft (0, f ( ii ), incx1, incx2, f ( ii ), incx1, incx2, nx, m, &
-isign, 1.0d0, fw_table ( 1, 1, ip ), ltabl, work( 1 ), lwork)
#elif defined __FFTMKL8
Status = DftiComputeForWard(Desc_Handlex(ip) , f( ii: ) , f( ii: ))
#else
call errore(' cfft3ds ',' no scalar fft driver specified ', 1)
#endif
endif
enddo
enddo
call DSCAL (2 * ldx * ldy * nz, 1.0d0/(nx * ny * nz), f(1), 1)
END IF
RETURN
END SUBROUTINE cfft3ds
!
!=----------------------------------------------------------------------=!
!
!
!
! 3D parallel FFT on sub-grids
!
!
!
!=----------------------------------------------------------------------=!
!
SUBROUTINE cft_b ( f, nx, ny, nz, ldx, ldy, ldz, imin3, imax3, sgn )
! driver routine for 3d complex fft's on box grid, parallel case
! fft along xy is done only on planes that correspond to dense grid
! planes on the current processor, i.e. planes with imin3 <= nz <= imax3
! implemented for essl, fftw, scsl, complib, only for sgn=1 (f(R) => f(G))
! (beware: here the "essl" convention for the sign of the fft is used!)
!
implicit none
integer nx,ny,nz,ldx,ldy,ldz,imin3,imax3,sgn
complex(8) :: f(:)
integer isign, naux, ibid, nplanes, nstart, k
real(DP) :: tscale
integer :: ip, i
integer, save :: icurrent = 1
integer, save :: dims( 4, ndims ) = -1
#if defined __FFTW || __FFTW3
C_POINTER, save :: bw_planz( ndims ) = 0
C_POINTER, save :: bw_planxy( ndims ) = 0
#elif defined __ESSL
INTEGER, PARAMETER :: ltabl = 20000 + 3 * nfftx
real(8), save :: aux3( ltabl, ndims )
real(8), save :: aux2( ltabl, ndims )
real(8), save :: aux1( ltabl, ndims )
#elif defined __COMPLIB
INTEGER, PARAMETER :: ltabl = 4 * nfftx
real(8), save :: bw_coeffz( ltabl, ndims )
real(8), save :: bw_coeffy( ltabl, ndims )
real(8), save :: bw_coeffx( ltabl, ndims )
#elif defined __SCSL
INTEGER, PARAMETER :: ltabl = 2 * nfftx + 256
real(8), save :: bw_coeffz( ltabl, ndims )
real(8), save :: bw_coeffy( ltabl, ndims )
real(8), save :: bw_coeffx( ltabl, ndims )
REAL (DP) :: DUMMY
INTEGER, SAVE :: isys(0:1) = (/ 1, 1 /)
#elif __FFTMKL8
C_POINTER,SAVE :: Desc_Handlexy(ndims) = 0
C_POINTER,SAVE :: Desc_Handlez(ndims) = 0
INTEGER Status
INTEGER DimArray(3)
INTEGER StrideArray(4)
#endif
isign = -sgn
tscale = 1.d0
if ( isign > 0 ) then
call errore('cft_b','not implemented',isign)
end if
!
! 2d fft on xy planes - only needed planes are transformed
! note that all others are left in an unusable state
!
nplanes = imax3 - imin3 + 1
nstart = ( imin3 - 1 ) * ldx * ldy + 1
!
! Here initialize table only if necessary
!
ip = -1
DO i = 1, ndims
! first check if there is already a table initialized
! for this combination of parameters
IF ( ( nx == dims(1,i) ) .and. ( ny == dims(2,i) ) .and. &
( nz == dims(3,i) ) .and. ( nplanes == dims(4,i) ) ) THEN
ip = i
EXIT
END IF
END DO
IF( ip == -1 ) THEN
! no table exist for these parameters
! initialize a new one
#if defined __FFTW
if ( bw_planz(icurrent) /= 0 ) &
call DESTROY_PLAN_1D( bw_planz(icurrent) )
call CREATE_PLAN_1D( bw_planz(icurrent), nz, 1 )
if ( bw_planxy(icurrent) /= 0 ) &
call DESTROY_PLAN_2D( bw_planxy(icurrent) )
call CREATE_PLAN_2D( bw_planxy(icurrent), nx, ny, 1 )
!
#elif defined __FFTW3
if ( bw_planz(icurrent) /= 0 ) &
call dfftw_destroy_plan(bw_planz(icurrent))
call dfftw_plan_many_dft( bw_planz(icurrent), 1, nz, ldx*ldy, &
f(1:), (/SIZE(f)/), ldx*ldy, 1, f(1:), (/SIZE(f)/), ldx*ldy, 1, &
1, FFTW_ESTIMATE )
if ( bw_planxy(icurrent) /= 0 ) &
call dfftw_destroy_plan(bw_planxy(icurrent))
call dfftw_plan_many_dft( bw_planxy(icurrent), 2, (/nx, ny/), nplanes,&
f(nstart:), (/ldx, ldy/), 1, ldx*ldy, f(nstart:), (/ldx, ldy/), &
1, ldx*ldy, 1, FFTW_ESTIMATE )
#elif defined __ESSL
if( nz /= dims(3,icurrent) ) then
call dcft( 1, f(1), ldx*ldy, 1, f(1), ldx*ldy, 1, nz, ldx*ldy, &
isign, tscale, aux3(1,icurrent), ltabl, work(1), lwork)
end if
call dcft( 1, f(1), 1, ldx, f(1), 1, ldx, nx, ldy*nplanes, isign, &
tscale, aux1(1,icurrent), ltabl, work(1), lwork)
if( ny /= dims(2,icurrent) ) then
call dcft( 1, f(1), ldx, 1, f(1), ldx, 1, ny, ldx, isign, &
tscale, aux2(1,icurrent), ltabl, work(1), lwork)
end if
#elif __FFTMKL8
StrideArray(1) = 0
! IF(ASSOCIATED(Desc_Handlexy(icurrent))) then
IF(Desc_Handlexy(icurrent)/=0) then
Status = DftiFreeDescriptor(Desc_Handlexy(icurrent))
ENDIF
! IF(ASSOCIATED(Desc_Handlez(icurrent))) then
IF(Desc_Handlez(icurrent)/=0) then
Status = DftiFreeDescriptor(Desc_Handlez(icurrent))
ENDIF
DimArray(1) = nx
DimArray(2) = ny
Status = DftiCreateDescriptor(Desc_Handlexy(icurrent), DFTI_DOUBLE,DFTI_COMPLEX,2,DimArray)
Status = DftiCreateDescriptor(Desc_Handlez(icurrent), DFTI_DOUBLE,DFTI_COMPLEX,1,nz)
StrideArray = 1
Status = DftiSetValue(Desc_Handlexy(icurrent),DFTI_INPUT_STRIDES,StrideArray)
StrideArray = ldx*ldy
Status = DftiSetValue(Desc_Handlez(icurrent),DFTI_INPUT_STRIDES,StrideArray)
! Status = DftiSetValue(Desc_Handlex(icurrent),DFTI_BACKWARD_SCALE, tscale)
! Status = DftiSetValue(Desc_Handley(icurrent),DFTI_BACKWARD_SCALE, tscale)
Status = DftiSetValue(Desc_Handlexy(icurrent),DFTI_NUMBER_OF_TRANSFORMS,nplanes)
Status = DftiSetValue(Desc_Handlez(icurrent),DFTI_NUMBER_OF_TRANSFORMS,ldx*ldy)
Status = DftiSetValue(Desc_Handlexy(icurrent),DFTI_INPUT_DISTANCE,ldx*ldy)
Status = DftiSetValue(Desc_Handlez(icurrent),DFTI_INPUT_DISTANCE,1)
Status = DftiCommitDescriptor(Desc_Handlexy(icurrent))
Status = DftiCommitDescriptor(Desc_Handlez(icurrent))
#elif defined __COMPLIB
call zfft1di( nz, bw_coeffz( 1, icurrent ) )
call zfft1di( ny, bw_coeffy( 1, icurrent ) )
call zfft1di( nx, bw_coeffx( 1, icurrent ) )
#elif defined __SCSL
CALL ZZFFT (0, nz, 0.0D0, DUMMY, 1, bw_coeffz(1, icurrent), &
work(1), isys)
CALL ZZFFT (0, ny, 0.0D0, DUMMY, 1, bw_coeffy(1, icurrent), &
work(1), isys)
CALL ZZFFT (0, nx, 0.0D0, DUMMY, 1, bw_coeffx(1, icurrent), &
work(1), isys)
#else
CALL errore(' cft_b ',' no scalar fft driver specified ', 1)
#endif
dims(1,icurrent) = nx; dims(2,icurrent) = ny
dims(3,icurrent) = nz; dims(4,icurrent) = nplanes
ip = icurrent
icurrent = MOD( icurrent, ndims ) + 1
END IF
#if defined __FFTW
call FFTW_INPLACE_DRV_1D( bw_planz(ip), ldx*ldy, f(1), ldx*ldy, 1 )
call FFTW_INPLACE_DRV_2D( bw_planxy(ip), nplanes, f(nstart), 1, ldx*ldy )
#elif defined __FFTW3
call dfftw_execute_dft(bw_planz(ip), f(1:), f(1:))
call dfftw_execute_dft(bw_planxy(ip), f(nstart:), f(nstart:))
#elif defined __FFTMKL8
Status = DftiComputeBackWard(Desc_Handlez(ip), f(1:), f(1:))
Status = DftiComputeBackWard(Desc_Handlexy(ip), f(nstart:), f(nstart:))
#elif defined __ESSL
! fft in the z-direction...
call dcft( 0, f(1), ldx*ldy, 1, f(1), ldx*ldy, 1, nz, ldx*ldy, isign, &
tscale, aux3(1,ip), ltabl, work(1), lwork)
! x-direction
call dcft( 0, f(nstart), 1, ldx, f(nstart), 1, ldx, nx, ldy*nplanes, &
isign, tscale, aux1(1,ip), ltabl, work(1), lwork)
! y-direction
DO K = imin3, imax3
nstart = ( k - 1 ) * ldx * ldy + 1
call dcft( 0, f(nstart), ldx, 1, f(nstart), ldx, 1, ny, ldx, isign, &
tscale, aux2(1,ip), ltabl, work(1), lwork)
END DO
#elif defined __COMPLIB
call zfftm1d( 1, nz, ldx*ldy, f(1), ldx*ldy, 1, bw_coeffz(1, ip) )
call zfftm1d( 1, nx, ldy*nplanes, f(nstart), 1, ldx, bw_coeffx(1, ip) )
DO K = imin3, imax3
nstart = ( k - 1 ) * ldx * ldy + 1
call zfftm1d( 1, ny, ldx, f(nstart), ldx, 1, bw_coeffy(1, ip) )
END DO
#elif defined __SCSL
CALL ZZFFTMR (1, nz, ldx*ldy, tscale, f(1), ldx*ldy, f(1), &
ldx*ldy, bw_coeffz(1, ip), work(1), isys)
CALL ZZFFTM (1, nx, ldy*nplanes, tscale, f(nstart), ldx, &
f(nstart), ldx, bw_coeffx(1, ip), work(1), isys)
DO k = imin3, imax3
nstart = ( k - 1 ) * ldx * ldy + 1
CALL ZZFFTMR (1, ny, ldx, tscale, f(nstart), ldx, f(nstart), &
ldx, bw_coeffy(1, ip), work(1), isys)
END DO
#endif
RETURN
END SUBROUTINE cft_b
!
!=----------------------------------------------------------------------=!
!
!
!
! FFT support Functions/Subroutines
!
!
!
!=----------------------------------------------------------------------=!
!
!
integer function good_fft_dimension (n)
!
! Determines the optimal maximum dimensions of fft arrays
! Useful on some machines to avoid memory conflicts
!
USE kinds, only : DP
IMPLICIT NONE
INTEGER :: n, nx
REAL(DP) :: log2n
!
! this is the default: max dimension = fft dimension
nx = n
!
#if defined(__ESSL) || defined(DXML)
log2n = LOG ( dble (n) ) / LOG ( 2.0_DP )
! log2n is the logarithm of n in base 2
IF ( ABS (NINT(log2n) - log2n) < 1.0d-8 ) nx = n + 1
! if n is a power of 2 (log2n is integer) increase dimension by 1
#elif defined(__SX6)
!
if (mod (n, 2) ==0) nx = n + 1
! for nec vector machines: if n is even increase dimension by 1
#endif
!
good_fft_dimension = nx
return
end function good_fft_dimension
!=----------------------------------------------------------------------=!
function allowed (nr)
! find if the fft dimension is a good one
! a "bad one" is either not implemented (as on IBM with ESSL)
! or implemented but with awful performances (most other cases)
USE kinds
implicit none
integer :: nr
logical :: allowed
integer :: pwr (5)
integer :: mr, i, fac, p, maxpwr
integer :: factors( 5 ) = (/ 2, 3, 5, 7, 11 /)
! find the factors of the fft dimension
mr = nr
pwr = 0
factors_loop: do i = 1, 5
fac = factors (i)
maxpwr = NINT ( LOG( DBLE (mr) ) / LOG( DBLE (fac) ) ) + 1
do p = 1, maxpwr
if ( mr == 1 ) EXIT factors_loop
if ( MOD (mr, fac) == 0 ) then
mr = mr / fac
pwr (i) = pwr (i) + 1
endif
enddo
end do factors_loop
IF ( nr /= ( mr * 2**pwr (1) * 3**pwr (2) * 5**pwr (3) * 7**pwr (4) * 11**pwr (5) ) ) &
CALL errore (' allowed ', ' what ?!? ', 1 )
if ( mr /= 1 ) then
! fft dimension contains factors > 11 : no good in any case
allowed = .false.
else
#if defined __ESSL
! IBM machines with essl libraries
allowed = ( pwr(1) >= 1 ) .and. ( pwr(2) <= 2 ) .and. ( pwr(3) <= 1 ) .and. &
( pwr(4) <= 1 ) .and. ( pwr(5) <= 1 ) .and. &
( ( (pwr(2) == 0 ) .and. ( pwr(3) + pwr(4) + pwr(5) ) <= 2 ) .or. &
( (pwr(2) /= 0 ) .and. ( pwr(3) + pwr(4) + pwr(5) ) <= 1 ) )
#else
! fftw and all other cases: no factors 7 and 11
allowed = ( ( pwr(4) == 0 ) .and. ( pwr(5) == 0 ) )
#endif
endif
return
end function allowed
!=----------------------------------------------------------------------=!
INTEGER FUNCTION good_fft_order( nr, np )
!
! This function find a "good" fft order value grather or equal to "nr"
!
! nr (input) tentative order n of a fft
!
! np (optional input) if present restrict the search of the order
! in the ensamble of multiples of np
!
! Output: the same if n is a good number
! the closest higher number that is good
! an fft order is not good if not implemented (as on IBM with ESSL)
! or implemented but with awful performances (most other cases)
!
IMPLICIT NONE
INTEGER, INTENT(IN) :: nr
INTEGER, OPTIONAL, INTENT(IN) :: np
INTEGER :: new
new = nr
IF( PRESENT( np ) ) THEN
DO WHILE( ( ( .NOT. allowed( new ) ) .OR. ( MOD( new, np ) /= 0 ) ) .AND. ( new <= nfftx ) )
new = new + 1
END DO
ELSE
DO WHILE( ( .NOT. allowed( new ) ) .AND. ( new <= nfftx ) )
new = new + 1
END DO
END IF
IF( new > nfftx ) &
CALL errore( ' good_fft_order ', ' fft order too large ', new )
good_fft_order = new
RETURN
END FUNCTION good_fft_order
!=----------------------------------------------------------------------=!
END MODULE fft_scalar
!=----------------------------------------------------------------------=!