test_real2_choose_kernel_with_api.F90 15.7 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 real 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 "REAL_ELPA_KERNEL" to an
!> appropiate value.
!>
67
program test_real2_choose_kernel_with_api_double_precision
Andreas Marek's avatar
Andreas Marek committed
68 69 70 71 72 73

!-------------------------------------------------------------------------------
! Standard eigenvalue problem - REAL 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
Andreas Marek's avatar
Andreas Marek committed
82 83
   use ELPA1
   use ELPA2
84 85

   use mod_check_for_gpu, only : check_for_gpu
86

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

99 100 101
#ifdef HAVE_REDIRECT
  use redirect
#endif
102 103 104 105

#ifdef HAVE_DETAILED_TIMINGS
 use timings
#endif
106
 use output_types
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
   integer(kind=ik)           :: nblk
   integer(kind=ik)           :: na, nev
Andreas Marek's avatar
Andreas Marek committed
118

119
   integer(kind=ik)           :: np_rows, np_cols, na_rows, na_cols
Andreas Marek's avatar
Andreas Marek committed
120

121 122
   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
123

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

126
   real(kind=rk8), allocatable :: a(:,:), z(:,:), tmp1(:,:), tmp2(:,:), as(:,:), ev(:)
Andreas Marek's avatar
Andreas Marek committed
127

128 129
   integer(kind=ik)           :: iseed(4096) ! Random seed, size should be sufficient for every generator
   integer(kind=ik)           :: STATUS
Andreas Marek's avatar
Andreas Marek committed
130
#ifdef WITH_OPENMP
131
   integer(kind=ik)           :: omp_get_max_threads,  required_mpi_thread_level, provided_mpi_thread_level
Andreas Marek's avatar
Andreas Marek committed
132
#endif
133 134 135
   logical                    :: successELPA, success
   integer(kind=ik)           :: numberOfDevices
   logical                    :: gpuAvailable
136
   type(output_t)             :: write_to_file
137 138
   character(len=8)           :: task_suffix
   integer(kind=ik)           :: j
139

140 141
#define DOUBLE_PRECISION_REAL 1

142 143
   successELPA   = .true.
   gpuAvailable  = .false.
Andreas Marek's avatar
Andreas Marek committed
144

Andreas Marek's avatar
Andreas Marek committed
145
   call read_input_parameters(na, nev, nblk, write_to_file)
146

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

151
   gpuAvailable = check_for_gpu(myid, numberOfDevices)
152

Andreas Marek's avatar
Andreas Marek committed
153 154
   STATUS = 0

155 156
#define DATATYPE REAL
#include "elpa_test_programs_print_headers.X90"
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

#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()

182
  call timer%start("program: test_real2_choose_kernel_with_api_double_precision")
183
#endif
Andreas Marek's avatar
Andreas Marek committed
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
   !-------------------------------------------------------------------------------
   ! 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 - REAL version'
200 201 202
      if (gpuAvailable) then
        print *,"with GPU Version"
      endif
Andreas Marek's avatar
Andreas Marek committed
203 204 205 206 207 208 209 210 211
      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! "
      print *
212 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
     print *," "
218
#ifndef HAVE_ENVIRONMENT_CHECKING
Andreas Marek's avatar
Andreas Marek committed
219 220 221 222
      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
223 224 225 226 227 228 229 230 231

#ifndef WITH_ONE_SPECIFIC_REAL_KERNEL
      print *, " The settings are: REAL_ELPA_KERNEL_GENERIC_SIMPLE"
#else /*  WITH_ONE_SPECIFIC_REAL_KERNEL */

#ifdef WITH_REAL_GENERIC_KERNEL
      print *, " The settings are: REAL_ELPA_KERNEL_GENERIC"
#endif
#ifdef WITH_REAL_GENERIC_SIMPLE_KERNEL
Andreas Marek's avatar
Andreas Marek committed
232
      print *, " The settings are: REAL_ELPA_KERNEL_GENERIC_SIMPLE"
233
#endif
234
#ifdef WITH_REAL_GENERIC_SSE_ASSEMBLY_KERNEL
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
      print *, " The settings are: REAL_ELPA_KERNEL_SSE"
#endif
#ifdef WITH_REAL_AVX_BLOCK2_KERNEL
      print *, " The settings are: REAL_ELPA_KERNEL_AVX_BLOCK2"
#endif
#ifdef WITH_REAL_AVX_BLOCK4_KERNEL
      print *, " The settings are: REAL_ELPA_KERNEL_AVX_BLOCK4"
#endif
#ifdef WITH_REAL_AVX_BLOCK6_KERNEL
      print *, " The settings are: REAL_ELPA_KERNEL_AVX_BLOCK6"
#endif
#ifdef WITH_REAL_BGP_KERNEL
      print *, " The settings are: REAL_ELPA_KERNEL_BGP"
#endif
#ifdef WITH_REAL_BGQ_KERNEL
      print *, " The settings are: REAL_ELPA_KERNEL_BGQ"
#endif
#ifdef WITH_GPU_VERSION
      print *, " The settings are: REAL_ELPA_GPU"
#endif

#endif  /*  WITH_ONE_SPECIFIC_REAL_KERNEL */

Andreas Marek's avatar
Andreas Marek committed
258
      print *
259

Andreas Marek's avatar
Andreas Marek committed
260 261 262 263 264 265 266 267 268 269 270 271 272

   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
273 274
   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
275 276 277 278 279 280

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

   ! All ELPA routines need MPI communicators for communicating within
281
   ! rows or columns of processes, these are set in get_elpa_communicators.
Andreas Marek's avatar
Andreas Marek committed
282

283
   mpierr = get_elpa_communicators(mpi_comm_world, my_prow, my_pcol, &
284
                                   mpi_comm_rows, mpi_comm_cols)
Andreas Marek's avatar
Andreas Marek committed
285 286 287 288 289

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

Andreas Marek's avatar
Andreas Marek committed
290 291
   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
292 293 294 295 296 297 298

   if (myid==0) then
     print '(a)','| Past scalapack descriptor setup.'
   end if

   !-------------------------------------------------------------------------------
   ! Allocate matrices and set up a test matrix for the eigenvalue problem
299 300 301
#ifdef HAVE_DETAILED_TIMINGS
   call timer%start("set up matrix")
#endif
Andreas Marek's avatar
Andreas Marek committed
302 303 304 305 306 307
   allocate(a (na_rows,na_cols))
   allocate(z (na_rows,na_cols))
   allocate(as(na_rows,na_cols))

   allocate(ev(na))

308
   call prepare_matrix_double(na, myid, sc_desc, iseed,  a, z, as)
Andreas Marek's avatar
Andreas Marek committed
309

310 311 312
#ifdef HAVE_DETAILED_TIMINGS
   call timer%stop("set up matrix")
#endif
Andreas Marek's avatar
Andreas Marek committed
313 314 315 316 317 318 319 320 321 322 323 324 325
   ! 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 with a kernel specification in the API
326
#ifdef WITH_MPI
Andreas Marek's avatar
Andreas Marek committed
327
   call mpi_barrier(mpi_comm_world, mpierr) ! for correct timings only
328
#endif
329
   successELPA = solve_evp_real_2stage_double(na, nev, a, na_rows, ev, z, na_rows, nblk, &
330
                              na_cols, mpi_comm_rows, mpi_comm_cols, mpi_comm_world, &
331
#ifndef WITH_ONE_SPECIFIC_REAL_KERNEL
332 333
                             REAL_ELPA_KERNEL_GENERIC_SIMPLE)
#else /* WITH_ONE_SPECIFIC_COMPLEX_KERNEL */
334

335 336 337
#ifdef WITH_REAL_GENERIC_KERNEL
                              REAL_ELPA_KERNEL_GENERIC)
#endif
338

339
#ifdef WITH_REAL_GENERIC_SIMPLE_KERNEL
Andreas Marek's avatar
Andreas Marek committed
340
                              REAL_ELPA_KERNEL_GENERIC_SIMPLE)
341
#endif
342

343
#ifdef WITH_REAL_SSE_ASSEMBLY_KERNEL
344 345
                              REAL_ELPA_KERNEL_SSE)
#endif
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
#ifdef WITH_ONE_SPECIFIC_REAL_KERNEL

#ifdef WITH_REAL_SSE_BLOCK6_KERNEL
                              REAL_ELPA_KERNEL_SSE_BLOCK6)
#else
#ifdef WITH_REAL_SSE_BLOCK4_KERNEL
                              REAL_ELPA_KERNEL_SSE_BLOCK4)
#else
#ifdef WITH_REAL_SSE_BLOCK2_KERNEL
                              REAL_ELPA_KERNEL_SSE_BLOCK2)
#endif
#endif
#endif
#ifdef WITH_REAL_AVX_BLOCK6_KERNEL
                              REAL_ELPA_KERNEL_AVX_BLOCK6)
#else
#ifdef WITH_REAL_AVX_BLOCK4_KERNEL
                              REAL_ELPA_KERNEL_AVX_BLOCK4)
#else
#ifdef WITH_REAL_AVX_BLOCK2_KERNEL
                              REAL_ELPA_KERNEL_AVX_BLOCK2)
#endif
#endif
#endif

#else /* WITH_ONE_SPECIFIC_REAL_KERNEL */

#ifdef WITH_REAL_SSE_BLOCK2_KERNEL
                              REAL_ELPA_KERNEL_SSE_BLOCK2)
#endif

#ifdef WITH_REAL_SSE_BLOCK4_KERNEL
                              REAL_ELPA_KERNEL_SSE_BLOCK4)
#endif

#ifdef WITH_REAL_SSE_BLOCK6_KERNEL
                              REAL_ELPA_KERNEL_SSE_BLOCK6)
#endif
384

385 386 387
#ifdef WITH_REAL_AVX_BLOCK2_KERNEL
                              REAL_ELPA_KERNEL_AVX_BLOCK2)
#endif
388

389 390 391
#ifdef WITH_REAL_AVX_BLOCK4_KERNEL
                              REAL_ELPA_KERNEL_AVX_BLOCK4)
#endif
392

393 394 395
#ifdef WITH_REAL_AVX_BLOCK6_KERNEL
                              REAL_ELPA_KERNEL_AVX_BLOCK6)
#endif
396

397 398 399

#endif /* WITH_ONE_SPECIFIC_REAL_KERNEL */

400 401 402
#ifdef WITH_REAL_BGP_KERNEL
                              REAL_ELPA_KERNEL_BGP)
#endif
403

404 405 406
#ifdef WITH_REAL_BGQ_KERNEL
                              REAL_ELPA_KERNEL_BGQ)
#endif
407

408 409 410 411
#ifdef WITH_GPU_VERSION
                              REAL_ELPA_KERNEL_GPU)
#endif

412
#endif /* WITH_ONE_SPECIFIC_REAL_KERNEL */
Andreas Marek's avatar
Andreas Marek committed
413

414
   if (.not.(successELPA)) then
415
      write(error_unit,*) "solve_evp_real_2stage produced an error! Aborting..."
416
#ifdef WITH_MPI
Andreas Marek's avatar
Andreas Marek committed
417
      call MPI_ABORT(mpi_comm_world, 1, mpierr)
418
#endif
419 420
   endif

Andreas Marek's avatar
Andreas Marek committed
421 422 423 424 425 426 427 428 429 430
   if (myid==0) then
     print '(a)','| Two-step ELPA solver complete.'
     print *
   end if

   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

431
   if(write_to_file%eigenvectors) then
432 433 434 435 436 437 438 439 440 441
     write(unit = task_suffix, fmt = '(i8.8)') myid
     open(17,file="EVs_real2_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
442
   endif
443 444

   if(write_to_file%eigenvalues) then
Andreas Marek's avatar
Andreas Marek committed
445
      if (myid == 0) then
446
         open(17,file="Eigenvalues_real2_out.txt",form='formatted',status='new')
Andreas Marek's avatar
Andreas Marek committed
447 448 449 450 451 452
         do i=1,na
            write(17,*) i,ev(i)
         enddo
         close(17)
      endif
   endif
453

Andreas Marek's avatar
Andreas Marek committed
454 455 456 457 458 459
   !-------------------------------------------------------------------------------
   ! Test correctness of result (using plain scalapack routines)

   allocate(tmp1(na_rows,na_cols))
   allocate(tmp2(na_rows,na_cols))

460
   status = check_correctness_double(na, nev, as, z, ev, sc_desc, myid, tmp1, tmp2)
Andreas Marek's avatar
Andreas Marek committed
461

Andreas Marek's avatar
Andreas Marek committed
462 463
   deallocate(a)
   deallocate(as)
Andreas Marek's avatar
Andreas Marek committed
464 465 466 467 468

   deallocate(z)
   deallocate(tmp1)
   deallocate(tmp2)
   deallocate(ev)
469 470

#ifdef HAVE_DETAILED_TIMINGS
471
   call timer%stop("program: test_real2_choose_kernel_with_api_double_precision")
472
   print *," "
473 474
   print *,"Timings program: test_real2_choose_kernel_with_api_double_precision"
   call timer%print("program: test_real2_choose_kernel_with_api_double_precision")
475
   print *," "
476
   print *,"End timings program: test_real2_choose_kernel_with_api_double_precision"
477
#endif
478
#ifdef WITH_MPI
Andreas Marek's avatar
Andreas Marek committed
479 480
   call blacs_gridexit(my_blacs_ctxt)
   call mpi_finalize(mpierr)
481
#endif
Andreas Marek's avatar
Andreas Marek committed
482 483 484 485
   call EXIT(STATUS)
end

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