test_complex2_api.F90 15.6 KB
Newer Older
Andreas Marek's avatar
Andreas Marek committed
1
2
!    This file is part of ELPA.
!
3
!    The ELPA library was originally created by the ELPA consortium,
Andreas Marek's avatar
Andreas Marek committed
4
5
!    consisting of the following organizations:
!
6
7
!    - Max Planck Computing and Data Facility (MPCDF), formerly known as
!      Rechenzentrum Garching der Max-Planck-Gesellschaft (RZG),
Andreas Marek's avatar
Andreas Marek committed
8
9
10
!    - Bergische Universität Wuppertal, Lehrstuhl für angewandte
!      Informatik,
!    - Technische Universität München, Lehrstuhl für Informatik mit
11
12
13
14
15
!      Schwerpunkt Wissenschaftliches Rechnen ,
!    - Fritz-Haber-Institut, Berlin, Abt. Theorie,
!    - Max-Plack-Institut für Mathematik in den Naturwissenschaften,
!      Leipzig, Abt. Komplexe Strukutren in Biologie und Kognition,
!      and
Andreas Marek's avatar
Andreas Marek committed
16
17
18
19
!    - IBM Deutschland GmbH
!
!
!    More information can be found here:
20
!    http://elpa.mpcdf.mpg.de/
Andreas Marek's avatar
Andreas Marek committed
21
22
!
!    ELPA is free software: you can redistribute it and/or modify
23
24
!    it under the terms of the version 3 of the license of the
!    GNU Lesser General Public License as published by the Free
Andreas Marek's avatar
Andreas Marek committed
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
!    Software Foundation.
!
!    ELPA is distributed in the hope that it will be useful,
!    but WITHOUT ANY WARRANTY; without even the implied warranty of
!    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
!    GNU Lesser General Public License for more details.
!
!    You should have received a copy of the GNU Lesser General Public License
!    along with ELPA.  If not, see <http://www.gnu.org/licenses/>
!
!    ELPA reflects a substantial effort on the part of the original
!    ELPA consortium, and we ask you to respect the spirit of the
!    license that we chose: i.e., please contribute any changes you
!    may have back to the original ELPA library distribution, and keep
!    any derivatives of ELPA under the same license that we chose for
!    the original distribution, the GNU Lesser General Public License.
!
!
#include "config-f90.h"
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
!>
!> Fortran test programm to demonstrates the use of
!> ELPA 2 complex case library.
!> If "HAVE_REDIRECT" was defined at build time
!> the stdout and stderr output of each MPI task
!> can be redirected to files if the environment
!> variable "REDIRECT_ELPA_TEST_OUTPUT" is set
!> to "true".
!>
!> By calling executable [arg1] [arg2] [arg3] [arg4]
!> one can define the size (arg1), the number of
!> Eigenvectors to compute (arg2), and the blocking (arg3).
!> If these values are not set default values (4000, 1500, 16)
!> are choosen.
!> If these values are set the 4th argument can be
!> "output", which specifies that the EV's are written to
!> an ascii file.
!>
!> The complex ELPA 2 kernel is set in this program via
!> the API call. However, this can be overriden by setting
!> the environment variable "COMPLEX_ELPA_KERNEL" to an
!> appropiate value.
!>
67
program test_complex2_choose_kernel_with_api_double_precision
Andreas Marek's avatar
Andreas Marek committed
68
69
70
71
72
73

!-------------------------------------------------------------------------------
! Standard eigenvalue problem - COMPLEX version
!
! This program demonstrates the use of the ELPA module
! together with standard scalapack routines
74
!
Andreas Marek's avatar
Andreas Marek committed
75
76
77
78
79
80
! Copyright of the original code rests with the authors inside the ELPA
! consortium. The copyright of any additional modifications shall rest
! with their original authors, but shall adhere to the licensing terms
! distributed along with the original code in the file "COPYING".
!-------------------------------------------------------------------------------

81
   use precision
82
   use elpa1_legacy
Andreas Marek's avatar
Andreas Marek committed
83
   use ELPA2
84

85
   use mod_check_for_gpu, only : check_for_gpu
86
   use elpa_utilities, only : error_unit
87
   use elpa2_utilities
Andreas Marek's avatar
Andreas Marek committed
88
89
90
91
92
   use mod_read_input_parameters
   use mod_check_correctness
   use mod_setup_mpi
   use mod_blacs_infrastructure
   use mod_prepare_matrix
93
   use elpa_mpi
94
95
96
#ifdef WITH_OPENMP
   use test_util
#endif
Andreas Marek's avatar
Andreas Marek committed
97

98
99
100
101
#ifdef HAVE_REDIRECT
  use redirect
#endif

102
103
104
#ifdef HAVE_DETAILED_TIMINGS
 use timings
#endif
105
 use output_types
106

Andreas Marek's avatar
Andreas Marek committed
107
108
109
110
111
112
113
114
115
   implicit none

   !-------------------------------------------------------------------------------
   ! Please set system size parameters below!
   ! na:   System size
   ! nev:  Number of eigenvectors to be calculated
   ! nblk: Blocking factor in block cyclic distribution
   !-------------------------------------------------------------------------------

116
117
118
   integer(kind=ik)              :: nblk
   integer(kind=ik)              :: na, nev
   integer(kind=ik)              :: np_rows, np_cols, na_rows, na_cols
Andreas Marek's avatar
Andreas Marek committed
119

120
121
   integer(kind=ik)              :: myid, nprocs, my_prow, my_pcol, mpi_comm_rows, mpi_comm_cols
   integer(kind=ik)              :: i, mpierr, my_blacs_ctxt, sc_desc(9), info, nprow, npcol
Andreas Marek's avatar
Andreas Marek committed
122

123
   integer(kind=ik), external    :: numroc
Andreas Marek's avatar
Andreas Marek committed
124

125
   real(kind=rk8), allocatable    :: ev(:)
Andreas Marek's avatar
Andreas Marek committed
126

127
   complex(kind=ck8), allocatable :: a(:,:), z(:,:), as(:,:)
Andreas Marek's avatar
Andreas Marek committed
128

129
   complex(kind=ck8), parameter   :: CZERO = (0._rk8,0._rk8), CONE = (1._rk8,0._rk8)
Andreas Marek's avatar
Andreas Marek committed
130

131
   integer(kind=ik)              :: STATUS
Andreas Marek's avatar
Andreas Marek committed
132
#ifdef WITH_OPENMP
133
   integer(kind=ik)              :: omp_get_max_threads,  required_mpi_thread_level, provided_mpi_thread_level
Andreas Marek's avatar
Andreas Marek committed
134
#endif
135
136
137
   logical                       :: successELPA, success
   integer(kind=ik)              :: numberOfDevices
   logical                       :: gpuAvailable
138
   type(output_t)                :: write_to_file
139
140
   character(len=8)              :: task_suffix
   integer(kind=ik)              :: j
141

142
143
#define DOUBLE_PRECISION_COMPLEX 1

144
145
   successELPA   = .true.
   gpuAvailable  = .false.
Andreas Marek's avatar
Andreas Marek committed
146

Andreas Marek's avatar
Andreas Marek committed
147
   call read_input_parameters(na, nev, nblk, write_to_file)
148

Andreas Marek's avatar
Andreas Marek committed
149
150
   !-------------------------------------------------------------------------------
   !  MPI Initialization
Andreas Marek's avatar
Andreas Marek committed
151
   call setup_mpi(myid, nprocs)
152

153
   gpuAvailable = check_for_gpu(myid, numberOfDevices)
Andreas Marek's avatar
Andreas Marek committed
154
155
   STATUS = 0

Andreas Marek's avatar
Andreas Marek committed
156
#define COMPLEXCASE
157
#include "elpa_print_headers.X90"
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
#ifdef HAVE_DETAILED_TIMINGS

   ! initialise the timing functionality

#ifdef HAVE_LIBPAPI
   call timer%measure_flops(.true.)
#endif

   call timer%measure_allocated_memory(.true.)
   call timer%measure_virtual_memory(.true.)
   call timer%measure_max_allocated_memory(.true.)

   call timer%set_print_options(&
#ifdef HAVE_LIBPAPI
                print_flop_count=.true., &
                print_flop_rate=.true., &
#endif
                print_allocated_memory = .true. , &
                print_virtual_memory=.true., &
                print_max_allocated_memory=.true.)


  call timer%enable()

183
  call timer%start("program: test_complex2_choose_kernel_with_api_double_precision")
184
185
#endif

Andreas Marek's avatar
Andreas Marek committed
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
   !-------------------------------------------------------------------------------
   ! Selection of number of processor rows/columns
   ! We try to set up the grid square-like, i.e. start the search for possible
   ! divisors of nprocs with a number next to the square root of nprocs
   ! and decrement it until a divisor is found.

   do np_cols = NINT(SQRT(REAL(nprocs))),2,-1
      if(mod(nprocs,np_cols) == 0 ) exit
   enddo
   ! at the end of the above loop, nprocs is always divisible by np_cols

   np_rows = nprocs/np_cols

   if(myid==0) then
      print *
      print '(a)','Standard eigenvalue problem - COMPLEX version'
202
203
204
      if (gpuAvailable) then
        print *," with GPU version"
      endif
Andreas Marek's avatar
Andreas Marek committed
205
206
207
208
209
210
211
212
      print *
      print '(3(a,i0))','Matrix size=',na,', Number of eigenvectors=',nev,', Block size=',nblk
      print '(3(a,i0))','Number of processor rows=',np_rows,', cols=',np_cols,', total=',nprocs
      print *
      print *, "This is an example how to determine the ELPA2 kernel with"
      print *, "an api call. Note, however, that setting the kernel via"
      print *, "an environment variable will always take precedence over"
      print *, "everything else! "
213
214
215
216
217
#ifdef WITH_ONE_SPECIFIC_COMPLEX_KERNEL
      print *," However, this version of ELPA was build with only one of all the available"
      print *," kernels, thus it will not be successful to call ELPA with another "
      print *," kernel than the one specified at compile time!"
#endif
Andreas Marek's avatar
Andreas Marek committed
218
      print *
219
#ifndef HAVE_ENVIRONMENT_CHECKING
Andreas Marek's avatar
Andreas Marek committed
220
221
222
223
      print *, " Notice that it is not possible with this build to set the "
      print *, " kernel via an environment variable! To change this re-install"
      print *, " the library and have a look at the log files"
#endif
224
225
226
227
228
229
230
231
232
#ifndef WITH_ONE_SPECIFIC_COMPLEX_KERNEL
      print *, " The settings are: COMPLEX_ELPA_KERNEL_GENERIC_SIMPLE"
#else /* WITH_ONE_SPECIFIC_COMPLEX_KERNEL */

#ifdef WITH_COMPLEX_GENERIC_KERNEL
      print *, " The settings are: COMPLEX_ELPA_KERNEL_GENERIC"
#endif

#ifdef WITH_COMPLEX_GENERIC_SIMPLE_KERNEL
Andreas Marek's avatar
Andreas Marek committed
233
      print *, " The settings are: COMPLEX_ELPA_KERNEL_GENERIC_SIMPLE"
234
235
#endif

236
#ifdef WITH_COMPLEX_SSE_ASSEMBLY_KERNEL
237
238
      print *, " The settings are: COMPLEX_ELPA_KERNEL_SSE"
#endif
239
240
241
242
243
244
245
246
#ifdef WITH_COMPLEX_SSE_BLOCK1_KERNEL
      print *, " The settings are: COMPLEX_ELPA_KERNEL_SSE_BLOCK1"
#endif

#ifdef WITH_COMPLEX_SSE_BLOCK2_KERNEL
      print *, " The settings are: COMPLEX_ELPA_KERNEL_SSE_BLOCK2"
#endif

247
248
249
250
251
252
253
254
255

#ifdef WITH_COMPLEX_AVX_BLOCK1_KERNEL
      print *, " The settings are: COMPLEX_ELPA_KERNEL_AVX_BLOCK1"
#endif

#ifdef WITH_COMPLEX_AVX_BLOCK2_KERNEL
      print *, " The settings are: COMPLEX_ELPA_KERNEL_AVX_BLOCK2"
#endif

256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
#ifdef WITH_COMPLEX_AVX2_BLOCK1_KERNEL
      print *, " The settings are: COMPLEX_ELPA_KERNEL_AVX2_BLOCK1"
#endif

#ifdef WITH_COMPLEX_AVX2_BLOCK2_KERNEL
      print *, " The settings are: COMPLEX_ELPA_KERNEL_AVX2_BLOCK2"
#endif

#ifdef WITH_COMPLEX_AVX512_BLOCK1_KERNEL
      print *, " The settings are: COMPLEX_ELPA_KERNEL_AVX512_BLOCK1"
#endif

#ifdef WITH_COMPLEX_AVX512_BLOCK2_KERNEL
      print *, " The settings are: COMPLEX_ELPA_KERNEL_AVX512_BLOCK2"
#endif

272
273
274
275
276
277
278
279
#ifdef WITH_GPU_VERSION
      print *, " The settings are: COMPLEX_ELPA_KERNEL_GPU"
#endif

#endif /* WITH_ONE_SPECIFIC_COMPLEX_KERNEL */



Andreas Marek's avatar
Andreas Marek committed
280
281
282
283
284
285
286
287
288
289
290
291
292
      print *
   endif

   !-------------------------------------------------------------------------------
   ! Set up BLACS context and MPI communicators
   !
   ! The BLACS context is only necessary for using Scalapack.
   !
   ! For ELPA, the MPI communicators along rows/cols are sufficient,
   ! and the grid setup may be done in an arbitrary way as long as it is
   ! consistent (i.e. 0<=my_prow<np_rows, 0<=my_pcol<np_cols and every
   ! process has a unique (my_prow,my_pcol) pair).

Andreas Marek's avatar
Andreas Marek committed
293
294
   call set_up_blacsgrid(mpi_comm_world, my_blacs_ctxt, np_rows, np_cols, &
                         nprow, npcol, my_prow, my_pcol)
Andreas Marek's avatar
Andreas Marek committed
295
296
297
298
299
300

   if (myid==0) then
     print '(a)','| Past BLACS_Gridinfo.'
   end if

   ! All ELPA routines need MPI communicators for communicating within
301
   ! rows or columns of processes, these are set in elpa_get_communicators
Andreas Marek's avatar
Andreas Marek committed
302

303
   mpierr = elpa_get_communicators(mpi_comm_world, my_prow, my_pcol, &
304
                                   mpi_comm_rows, mpi_comm_cols)
Andreas Marek's avatar
Andreas Marek committed
305
306
307
308
309
310
311
312

   if (myid==0) then
     print '(a)','| Past split communicator setup for rows and columns.'
   end if

   ! Determine the necessary size of the distributed matrices,
   ! we use the Scalapack tools routine NUMROC for that.

Andreas Marek's avatar
Andreas Marek committed
313
314
   call set_up_blacs_descriptor(na ,nblk, my_prow, my_pcol, np_rows, np_cols, &
                                na_rows, na_cols, sc_desc, my_blacs_ctxt, info)
Andreas Marek's avatar
Andreas Marek committed
315
316
317
318
319
320
321


   if (myid==0) then
     print '(a)','| Past scalapack descriptor setup.'
   end if
   !-------------------------------------------------------------------------------
   ! Allocate matrices and set up a test matrix for the eigenvalue problem
322
323
324
#ifdef HAVE_DETAILED_TIMINGS
   call timer%start("set up matrix")
#endif
Andreas Marek's avatar
Andreas Marek committed
325
326
327
328
329
330
   allocate(a (na_rows,na_cols))
   allocate(z (na_rows,na_cols))
   allocate(as(na_rows,na_cols))

   allocate(ev(na))

331
   call prepare_matrix_double(na, myid, sc_desc, a, z, as)
Andreas Marek's avatar
Andreas Marek committed
332

333
334
335
#ifdef HAVE_DETAILED_TIMINGS
   call timer%stop("set up matrix")
#endif
Andreas Marek's avatar
Andreas Marek committed
336
337
338
339
340
341
342
343
344
345
346
347
348
349

   ! set print flag in elpa1
   elpa_print_times = .true.

   !-------------------------------------------------------------------------------
   ! Calculate eigenvalues/eigenvectors

   if (myid==0) then
     print '(a)','| Entering two-stage ELPA solver ... '
     print *
   end if


   ! ELPA is called a kernel specification in the API
350
#ifdef WITH_MPI
Andreas Marek's avatar
Andreas Marek committed
351
   call mpi_barrier(mpi_comm_world, mpierr) ! for correct timings only
352
#endif
353
   successELPA = elpa_solve_evp_complex_2stage_double(na, nev, a, na_rows, ev, z, na_rows, nblk, &
354
                                 na_cols, mpi_comm_rows, mpi_comm_cols, mpi_comm_world, &
355
356
357
358
359
360
361
362
363
#ifndef WITH_ONE_SPECIFIC_COMPLEX_KERNEL
                                 COMPLEX_ELPA_KERNEL_GENERIC_SIMPLE)
#else /* WITH_ONE_SPECIFIC_COMPLEX_KERNEL */

#ifdef  WITH_COMPLEX_GENERIC_KERNEL
                                 COMPLEX_ELPA_KERNEL_GENERIC)
#endif

#ifdef  WITH_COMPLEX_GENERIC_SIMPLE_KERNEL
Andreas Marek's avatar
Andreas Marek committed
364
                                 COMPLEX_ELPA_KERNEL_GENERIC_SIMPLE)
365
366
#endif

367
#ifdef  WITH_COMPLEX_SSE_ASSEMBLY_KERNEL
368
369
370
                                 COMPLEX_ELPA_KERNEL_SSE)
#endif

371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
#ifdef  WITH_COMPLEX_SSE_BLOCK2_KERNEL
                                 COMPLEX_ELPA_KERNEL_SSE_BLOCK2)
#else
#ifdef  WITH_COMPLEX_SSE_BLOCK1_KERNEL
                                 COMPLEX_ELPA_KERNEL_SSE_BLOCK1)
#endif
#endif

#ifdef  WITH_COMPLEX_AVX_BLOCK2_KERNEL
                                 COMPLEX_ELPA_KERNEL_AVX_BLOCK2)
#else
#ifdef  WITH_COMPLEX_AVX_BLOCK1_KERNEL
                                 COMPLEX_ELPA_KERNEL_AVX_BLOCK1)
#endif
#endif

387
388
389
390
391
392
393
394
#ifdef  WITH_COMPLEX_AVX2_BLOCK2_KERNEL
                                 COMPLEX_ELPA_KERNEL_AVX2_BLOCK2)
#else
#ifdef  WITH_COMPLEX_AVX2_BLOCK1_KERNEL
                                 COMPLEX_ELPA_KERNEL_AVX2_BLOCK1)
#endif
#endif

395
396
397
398
399
400
401
402
#ifdef  WITH_COMPLEX_AVX512_BLOCK2_KERNEL
                                 COMPLEX_ELPA_KERNEL_AVX512_BLOCK2)
#else
#ifdef  WITH_COMPLEX_AVX512_BLOCK1_KERNEL
                                 COMPLEX_ELPA_KERNEL_AVX512_BLOCK1)
#endif
#endif

403
404
405
406
407
408
409
#ifdef  WITH_GPU_VERSION
                                 COMPLEX_ELPA_KERNEL_GPU)
#endif

#endif /* WITH_ONE_SPECIFIC_COMPLEX_KERNEL */

   if (.not.(successELPA)) then
410
      write(error_unit,*) "solve_evp_complex_2stage produced an error! Aborting..."
411
#ifdef WITH_MPI
Andreas Marek's avatar
Andreas Marek committed
412
      call MPI_ABORT(mpi_comm_world, 1, mpierr)
413
#endif
414
415
   endif

Andreas Marek's avatar
Andreas Marek committed
416
417
418
419
420
   if(myid == 0) print *,'Time transform to tridi :',time_evp_fwd
   if(myid == 0) print *,'Time solve tridi        :',time_evp_solve
   if(myid == 0) print *,'Time transform back EVs :',time_evp_back
   if(myid == 0) print *,'Total time (sum above)  :',time_evp_back+time_evp_solve+time_evp_fwd

421
   if(write_to_file%eigenvectors) then
422
423
424
425
426
427
428
429
430
431
     write(unit = task_suffix, fmt = '(i8.8)') myid
     open(17,file="EVs_complex2_out_task_"//task_suffix(1:8)//".txt",form='formatted',status='new')
     write(17,*) "Part of eigenvectors: na_rows=",na_rows,"of na=",na," na_cols=",na_cols," of na=",na

     do i=1,na_rows
       do j=1,na_cols
         write(17,*) "row=",i," col=",j," element of eigenvector=",z(i,j)
       enddo
     enddo
     close(17)
Andreas Marek's avatar
Andreas Marek committed
432
   endif
433
434

   if(write_to_file%eigenvalues) then
Andreas Marek's avatar
Andreas Marek committed
435
      if (myid == 0) then
436
         open(17,file="Eigenvalues_complex2_out.txt",form='formatted',status='new')
Andreas Marek's avatar
Andreas Marek committed
437
438
439
440
441
442
         do i=1,na
            write(17,*) i,ev(i)
         enddo
         close(17)
      endif
   endif
443
444


Andreas Marek's avatar
Andreas Marek committed
445
446
   !-------------------------------------------------------------------------------
   ! Test correctness of result (using plain scalapack routines)
447
   status = check_correctness_double(na, nev, as, z, ev, sc_desc, myid)
Andreas Marek's avatar
Andreas Marek committed
448

Andreas Marek's avatar
Andreas Marek committed
449
450
   deallocate(a)
   deallocate(as)
Andreas Marek's avatar
Andreas Marek committed
451
452
453

   deallocate(z)
   deallocate(ev)
454
455

#ifdef HAVE_DETAILED_TIMINGS
456
   call timer%stop("program: test_complex2_choose_kernel_with_api_double_precision")
457
   print *," "
458
459
   print *,"Timings program: test_complex2_choose_kernel_with_api_double_precision"
   call timer%print("program: test_complex2_choose_kernel_with_api_double_precision")
460
   print *," "
461
   print *,"End timings program: test_complex2_choose_kernel_with_api_double_precision"
462
#endif
463
#ifdef WITH_MPI
Andreas Marek's avatar
Andreas Marek committed
464
465
   call blacs_gridexit(my_blacs_ctxt)
   call mpi_finalize(mpierr)
466
#endif
Andreas Marek's avatar
Andreas Marek committed
467
468
469
470
   call EXIT(STATUS)
end

!-------------------------------------------------------------------------------