-
Notifications
You must be signed in to change notification settings - Fork 19
/
decomp_2d_fft.F90
447 lines (309 loc) · 13.1 KB
/
decomp_2d_fft.F90
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
!=======================================================================
! This is part of the 2DECOMP&FFT library
!
! 2DECOMP&FFT is a software framework for general-purpose 2D (pencil)
! decomposition. It also implements a highly scalable distributed
! three-dimensional Fast Fourier Transform (FFT).
!
! Copyright (C) 2009-2012 Ning Li, the Numerical Algorithms Group (NAG)
!
!=======================================================================
! This is the FFTW (version 3.x) implementation of the FFT library
module decomp_2d_fft
use decomp_2d ! 2D decomposition module
implicit none
INTEGER FFTW_ESTIMATE
PARAMETER (FFTW_ESTIMATE=64)
INTEGER FFTW_MEASURE
PARAMETER (FFTW_MEASURE=0)
INTEGER FFTW_FORWARD
PARAMETER (FFTW_FORWARD=-1)
INTEGER FFTW_BACKWARD
PARAMETER (FFTW_BACKWARD=+1)
private ! Make everything private unless declared public
! engine-specific global variables
! integer, save :: plan_type = FFTW_EXHAUSTIVE
integer, save :: plan_type = FFTW_ESTIMATE
! integer, save :: plan_type = FFTW_MEASURE
! FFTW plans
! j=1,2,3 corresponds to the 1D FFTs in X,Y,Z direction, respectively
! For c2c transforms:
! use plan(-1,j) for forward transform;
! use plan( 1,j) for backward transform;
! For r2c/c2r transforms:
! use plan(0,j) for r2c transforms;
! use plan(2,j) for c2r transforms;
integer*8, save, public :: plan(-1:2,3)
! common code used for all engines, including global variables,
! generic interface definitions and several subroutines
#include "fft_common.F90"
! Return a FFTW3 plan for multiple 1D c2c FFTs in X direction
subroutine c2c_1m_x_plan(plan1, decomp, isign)
implicit none
integer*8, intent(OUT) :: plan1
TYPE(DECOMP_INFO), intent(IN) :: decomp
integer, intent(IN) :: isign
complex(mytype), allocatable, dimension(:,:,:) :: a1
allocate(a1(decomp%xsz(1),decomp%xsz(2),decomp%xsz(3)))
call dfftw_plan_many_dft(plan1, 1, decomp%xsz(1), &
decomp%xsz(2)*decomp%xsz(3), a1, decomp%xsz(1), 1, &
decomp%xsz(1), a1, decomp%xsz(1), 1, decomp%xsz(1), &
isign, plan_type)
deallocate(a1)
return
end subroutine c2c_1m_x_plan
! Return a FFTW3 plan for multiple 1D c2c FFTs in Y direction
subroutine c2c_1m_y_plan(plan1, decomp, isign)
implicit none
integer*8, intent(OUT) :: plan1
TYPE(DECOMP_INFO), intent(IN) :: decomp
integer, intent(IN) :: isign
complex(mytype), allocatable, dimension(:,:) :: a1
! Due to memory pattern of 3D arrays, 1D FFTs along Y have to be
! done one Z-plane at a time. So plan for 2D data sets here.
allocate(a1(decomp%ysz(1),decomp%ysz(2)))
call dfftw_plan_many_dft(plan1, 1, decomp%ysz(2), decomp%ysz(1), &
a1, decomp%ysz(2), decomp%ysz(1), 1, a1, decomp%ysz(2), &
decomp%ysz(1), 1, isign, plan_type)
deallocate(a1)
return
end subroutine c2c_1m_y_plan
! Return a FFTW3 plan for multiple 1D c2c FFTs in Z direction
subroutine c2c_1m_z_plan(plan1, decomp, isign)
implicit none
integer*8, intent(OUT) :: plan1
TYPE(DECOMP_INFO), intent(IN) :: decomp
integer, intent(IN) :: isign
complex(mytype), allocatable, dimension(:,:,:) :: a1
allocate(a1(decomp%zsz(1),decomp%zsz(2),decomp%zsz(3)))
call dfftw_plan_many_dft(plan1, 1, decomp%zsz(3), &
decomp%zsz(1)*decomp%zsz(2), a1, decomp%zsz(3), &
decomp%zsz(1)*decomp%zsz(2), 1, a1, decomp%zsz(3), &
decomp%zsz(1)*decomp%zsz(2), 1, isign, plan_type)
deallocate(a1)
return
end subroutine c2c_1m_z_plan
! Return a FFTW3 plan for multiple 1D c2r FFTs in X direction
subroutine c2r_1m_x_plan(plan1, decomp_sp, decomp_ph)
implicit none
integer*8, intent(OUT) :: plan1
TYPE(DECOMP_INFO), intent(IN) :: decomp_sp
TYPE(DECOMP_INFO), intent(IN) :: decomp_ph
complex(mytype), allocatable, dimension(:,:,:) :: a1
real(mytype), allocatable, dimension(:,:,:) :: a2
allocate(a1(decomp_sp%xsz(1),decomp_sp%xsz(2),decomp_sp%xsz(3)))
allocate(a2(decomp_ph%xsz(1),decomp_ph%xsz(2),decomp_ph%xsz(3)))
call dfftw_plan_many_dft_c2r(plan1, 1, decomp_ph%xsz(1), &
decomp_ph%xsz(2)*decomp_ph%xsz(3), a1, decomp_sp%xsz(1), 1, &
decomp_sp%xsz(1), a2, decomp_ph%xsz(1), 1, decomp_ph%xsz(1), &
plan_type)
deallocate(a1,a2)
return
end subroutine c2r_1m_x_plan
! Return a FFTW3 plan for multiple 1D r2c FFTs in Z direction
subroutine r2c_1m_z_plan(plan1, decomp_ph, decomp_sp)
implicit none
integer*8, intent(OUT) :: plan1
TYPE(DECOMP_INFO), intent(IN) :: decomp_ph
TYPE(DECOMP_INFO), intent(IN) :: decomp_sp
real(mytype), allocatable, dimension(:,:,:) :: a1
complex(mytype), allocatable, dimension(:,:,:) :: a2
allocate(a1(decomp_ph%zsz(1),decomp_ph%zsz(2),decomp_ph%zsz(3)))
allocate(a2(decomp_sp%zsz(1),decomp_sp%zsz(2),decomp_sp%zsz(3)))
call dfftw_plan_many_dft_r2c(plan1, 1, decomp_ph%zsz(3), &
decomp_ph%zsz(1)*decomp_ph%zsz(2), a1, decomp_ph%zsz(3), &
decomp_ph%zsz(1)*decomp_ph%zsz(2), 1, a2, decomp_sp%zsz(3), &
decomp_sp%zsz(1)*decomp_sp%zsz(2), 1, plan_type)
deallocate(a1,a2)
return
end subroutine r2c_1m_z_plan
! Return a FFTW3 plan for multiple 1D c2r FFTs in Z direction
subroutine c2r_1m_z_plan(plan1, decomp_sp, decomp_ph)
implicit none
integer*8, intent(OUT) :: plan1
TYPE(DECOMP_INFO), intent(IN) :: decomp_sp
TYPE(DECOMP_INFO), intent(IN) :: decomp_ph
complex(mytype), allocatable, dimension(:,:,:) :: a1
real(mytype), allocatable, dimension(:,:,:) :: a2
allocate(a1(decomp_sp%zsz(1),decomp_sp%zsz(2),decomp_sp%zsz(3)))
allocate(a2(decomp_ph%zsz(1),decomp_ph%zsz(2),decomp_ph%zsz(3)))
call dfftw_plan_many_dft_c2r(plan1, 1, decomp_ph%zsz(3), &
decomp_ph%zsz(1)*decomp_ph%zsz(2), a1, decomp_sp%zsz(3), &
decomp_sp%zsz(1)*decomp_sp%zsz(2), 1, a2, decomp_ph%zsz(3), &
decomp_ph%zsz(1)*decomp_ph%zsz(2), 1, plan_type)
deallocate(a1,a2)
return
end subroutine c2r_1m_z_plan
! Return a FFTW3 plan for multiple 1D r2c FFTs in X direction
subroutine r2c_1m_x_plan(plan1, decomp_ph, decomp_sp)
implicit none
integer*8, intent(OUT) :: plan1
TYPE(DECOMP_INFO), intent(IN) :: decomp_ph
TYPE(DECOMP_INFO), intent(IN) :: decomp_sp
real(mytype), allocatable, dimension(:,:,:) :: a1
complex(mytype), allocatable, dimension(:,:,:) :: a2
allocate(a1(decomp_ph%xsz(1),decomp_ph%xsz(2),decomp_ph%xsz(3)))
allocate(a2(decomp_sp%xsz(1),decomp_sp%xsz(2),decomp_sp%xsz(3)))
call dfftw_plan_many_dft_r2c(plan1, 1, decomp_ph%xsz(1), &
decomp_ph%xsz(2)*decomp_ph%xsz(3), a1, decomp_ph%xsz(1), 1, &
decomp_ph%xsz(1), a2, decomp_sp%xsz(1), 1, decomp_sp%xsz(1), &
plan_type)
deallocate(a1,a2)
return
end subroutine r2c_1m_x_plan
! Return a FFTW3 plan for multiple 1D r2c FFTs in Y direction
subroutine r2c_1m_y_plan(plan1, decomp_ph, decomp_sp)
implicit none
integer*8, intent(OUT) :: plan1
TYPE(DECOMP_INFO), intent(IN) :: decomp_ph
TYPE(DECOMP_INFO), intent(IN) :: decomp_sp
real(mytype), allocatable, dimension(:,:,:) :: a1
complex(mytype), allocatable, dimension(:,:,:) :: a2
allocate(a1(decomp_ph%ysz(1),decomp_ph%ysz(2),decomp_ph%ysz(3)))
allocate(a2(decomp_sp%ysz(1),decomp_sp%ysz(2),decomp_sp%ysz(3)))
call dfftw_plan_many_dft_r2c(plan1, 1, decomp_ph%ysz(1), &
decomp_ph%ysz(2)*decomp_ph%ysz(3), a1, decomp_ph%ysz(1), 1, &
decomp_ph%ysz(1), a2, decomp_sp%ysz(1), 1, decomp_sp%ysz(1), &
plan_type)
deallocate(a1,a2)
return
end subroutine r2c_1m_y_plan
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! This routine performs one-time initialisations for the FFT engine
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
subroutine init_fft_engine
!$ use omp_lib
implicit none
!$ integer ierr
if (nrank==0) then
write(*,*) ' '
write(*,*) '***** Using the FFTW (version 3.x) engine *****'
write(*,*) ' '
end if
!$ call dfftw_init_threads(ierr)
!$
!$ call dfftw_plan_with_nthreads(omp_get_max_threads())
if (format == PHYSICAL_IN_X) then
! For C2C transforms
! call c2c_1m_x_plan(plan(-1,1), ph, FFTW_FORWARD )
! call c2c_1m_y_plan(plan(-1,2), ph, FFTW_FORWARD )
! call c2c_1m_z_plan(plan(-1,3), ph, FFTW_FORWARD )
! call c2c_1m_z_plan(plan( 1,3), ph, FFTW_BACKWARD)
! call c2c_1m_y_plan(plan( 1,2), ph, FFTW_BACKWARD)
! call c2c_1m_x_plan(plan( 1,1), ph, FFTW_BACKWARD)
!
! ! For R2C/C2R tranforms
! call r2c_1m_x_plan(plan(0,1), ph, sp)
! call c2c_1m_y_plan(plan(0,2), sp, FFTW_FORWARD )
! call c2c_1m_z_plan(plan(0,3), sp, FFTW_FORWARD )
! call c2c_1m_z_plan(plan(2,3), sp, FFTW_BACKWARD)
! call c2c_1m_y_plan(plan(2,2), sp, FFTW_BACKWARD)
! call c2r_1m_x_plan(plan(2,1), sp, ph)
! For R2C/C2R tranforms
call r2c_1m_y_plan(plan(1,1), ph, sp)
call c2c_1m_y_plan(plan(1,2), sp, FFTW_BACKWARD)
call c2r_1m_z_plan(plan(2,1), ph, sp)
call c2c_1m_z_plan(plan(2,2), ph, FFTW_FORWARD)
else if (format == PHYSICAL_IN_Z) then
! For C2C transforms
call c2c_1m_z_plan(plan(-1,3), ph, FFTW_FORWARD )
call c2c_1m_y_plan(plan(-1,2), ph, FFTW_FORWARD )
call c2c_1m_x_plan(plan(-1,1), ph, FFTW_FORWARD )
call c2c_1m_x_plan(plan( 1,1), ph, FFTW_BACKWARD)
call c2c_1m_y_plan(plan( 1,2), ph, FFTW_BACKWARD)
call c2c_1m_z_plan(plan( 1,3), ph, FFTW_BACKWARD)
! For R2C/C2R tranforms
call r2c_1m_z_plan(plan(0,3), ph, sp)
call c2c_1m_y_plan(plan(0,2), sp, FFTW_FORWARD )
call c2c_1m_x_plan(plan(0,1), sp, FFTW_FORWARD )
call c2c_1m_x_plan(plan(2,1), sp, FFTW_BACKWARD)
call c2c_1m_y_plan(plan(2,2), sp, FFTW_BACKWARD)
call c2r_1m_z_plan(plan(2,3), sp, ph)
end if
return
end subroutine init_fft_engine
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! This routine performs one-time finalisations for the FFT engine
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
subroutine finalize_fft_engine
implicit none
integer :: i,j
do j=1,3
do i=-1,2
call dfftw_destroy_plan(plan(i,j))
end do
end do
return
end subroutine finalize_fft_engine
! Following routines calculate multiple one-dimensional FFTs to form
! the basis of three-dimensional FFTs.
! c2c transform, multiple 1D FFTs in x direction
subroutine c2c_1m_x(inout, plan1)
implicit none
complex(mytype), dimension(:,:,:), intent(INOUT) :: inout
integer*8, intent(IN) :: plan1
call dfftw_execute_dft(plan1, inout, inout)
return
end subroutine c2c_1m_x
! c2c transform, multiple 1D FFTs in y direction
subroutine c2c_1m_y(inout, plan1)
implicit none
complex(mytype), dimension(:,:,:), intent(INOUT) :: inout
integer*8, intent(IN) :: plan1
integer :: k, s3
! transform on one Z-plane at a time
s3 = size(inout,3)
do k=1,s3
call dfftw_execute_dft(plan1, inout(:,:,k), inout(:,:,k))
end do
return
end subroutine c2c_1m_y
! c2c transform, multiple 1D FFTs in z direction
subroutine c2c_1m_z(inout, plan1)
implicit none
complex(mytype), dimension(:,:,:), intent(INOUT) :: inout
integer*8, intent(IN) :: plan1
call dfftw_execute_dft(plan1, inout, inout)
return
end subroutine c2c_1m_z
! r2c transform, multiple 1D FFTs in x direction
subroutine r2c_1m_x(input, output)
implicit none
real(mytype), dimension(:,:,:), intent(IN) :: input
complex(mytype), dimension(:,:,:), intent(OUT) :: output
call dfftw_execute_dft_r2c(plan(0,1), input, output)
return
end subroutine r2c_1m_x
! r2c transform, multiple 1D FFTs in x direction
subroutine r2c_1m_y(input, output)
implicit none
real(mytype), dimension(:,:,:), intent(IN) :: input
complex(mytype), dimension(:,:,:), intent(OUT) :: output
call dfftw_execute_dft_r2c(plan(1,1), input, output)
return
end subroutine r2c_1m_y
! r2c transform, multiple 1D FFTs in z direction
subroutine r2c_1m_z(input, output)
implicit none
real(mytype), dimension(:,:,:), intent(IN) :: input
complex(mytype), dimension(:,:,:), intent(OUT) :: output
call dfftw_execute_dft_r2c(plan(0,3), input, output)
return
end subroutine r2c_1m_z
! c2r transform, multiple 1D FFTs in x direction
subroutine c2r_1m_x(input, output)
implicit none
complex(mytype), dimension(:,:,:), intent(IN) :: input
real(mytype), dimension(:,:,:), intent(OUT) :: output
call dfftw_execute_dft_c2r(plan(2,1), input, output)
return
end subroutine c2r_1m_x
! c2r transform, multiple 1D FFTs in z direction
subroutine c2r_1m_z(input, output)
implicit none
complex(mytype), dimension(:,:,:), intent(IN) :: input
real(mytype), dimension(:,:,:), intent(OUT) :: output
call dfftw_execute_dft_c2r(plan(2,1), input, output)
return
end subroutine c2r_1m_z
end module decomp_2d_fft