elpa_impl.F90 59.8 KB
Newer Older
1 2 3
!
!    Copyright 2017, L. Hüdepohl and A. Marek, MPCDF
!
Andreas Marek's avatar
Andreas Marek committed
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
!    This file is part of ELPA.
!
!    The ELPA library was originally created by the ELPA consortium,
!    consisting of the following organizations:
!
!    - Max Planck Computing and Data Facility (MPCDF), formerly known as
!      Rechenzentrum Garching der Max-Planck-Gesellschaft (RZG),
!    - Bergische Universität Wuppertal, Lehrstuhl für angewandte
!      Informatik,
!    - Technische Universität München, Lehrstuhl für Informatik mit
!      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
!    - IBM Deutschland GmbH
!
!    This particular source code file contains additions, changes and
!    enhancements authored by Intel Corporation which is not part of
!    the ELPA consortium.
!
!    More information can be found here:
!    http://elpa.mpcdf.mpg.de/
!
!    ELPA is free software: you can redistribute it and/or modify
!    it under the terms of the version 3 of the license of the
!    GNU Lesser General Public License as published by the Free
!    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.
!
48
#include "config-f90.h"
49

50
!> \brief Fortran module which provides the actual implementation of the API. Do not use directly! Use the module "elpa"
51
module elpa_impl
52 53 54 55 56 57 58 59
  use precision
  use elpa2_impl
  use elpa1_impl
  use elpa1_auxiliary_impl
  use elpa_mpi
  use elpa_generated_fortran_interfaces
  use elpa_utilities, only : error_unit

60
  use elpa_abstract_impl
Andreas Marek's avatar
Andreas Marek committed
61
#ifdef ENABLE_AUTOTUNING
62
  use elpa_autotune_impl
Andreas Marek's avatar
Andreas Marek committed
63
#endif
64
  use, intrinsic :: iso_c_binding
Pavel Kus's avatar
Pavel Kus committed
65
  use iso_fortran_env
66
  implicit none
67

68 69
  private
  public :: elpa_impl_allocate
70

71
!> \brief Definition of the extended elpa_impl_t type
72
  type, extends(elpa_abstract_impl_t) :: elpa_impl_t
Andreas Marek's avatar
Andreas Marek committed
73
   private
74
   integer :: communicators_owned
75

76
   !> \brief methods available with the elpa_impl_t type
77
   contains
78
     !> \brief the puplic methods
79
     ! con-/destructor
80 81
     procedure, public :: setup => elpa_setup                   !< a setup method: implemented in elpa_setup
     procedure, public :: destroy => elpa_destroy               !< a destroy method: implemented in elpa_destroy
82

83
     ! KV store
84 85 86 87
     procedure, public :: is_set => elpa_is_set                 !< a method to check whether a key/value pair has been set : implemented
                                                                !< in elpa_is_set
     procedure, public :: can_set => elpa_can_set               !< a method to check whether a key/value pair can be set : implemented
                                                                !< in elpa_can_set
88

89 90 91 92

     ! timer
     procedure, public :: get_time => elpa_get_time
     procedure, public :: print_times => elpa_print_times
93 94
     procedure, public :: timer_start => elpa_timer_start
     procedure, public :: timer_stop => elpa_timer_stop
95 96


97 98 99 100 101 102 103 104 105 106 107 108 109 110
     !> \brief the implemenation methods

     procedure, public :: elpa_eigenvectors_d                  !< public methods to implement the solve step for real/complex
                                                               !< double/single matrices
     procedure, public :: elpa_eigenvectors_f
     procedure, public :: elpa_eigenvectors_dc
     procedure, public :: elpa_eigenvectors_fc

     procedure, public :: elpa_eigenvalues_d                   !< public methods to implement the solve step for real/complex
                                                               !< double/single matrices; only the eigenvalues are computed
     procedure, public :: elpa_eigenvalues_f
     procedure, public :: elpa_eigenvalues_dc
     procedure, public :: elpa_eigenvalues_fc

Pavel Kus's avatar
Pavel Kus committed
111 112 113 114 115 116
     procedure, public :: elpa_generalized_eigenvectors_d      !< public methods to implement the solve step for generalized 
                                                               !< eigenproblem and real/complex double/single matrices
     procedure, public :: elpa_generalized_eigenvectors_f
     procedure, public :: elpa_generalized_eigenvectors_dc
     procedure, public :: elpa_generalized_eigenvectors_fc

117 118 119 120 121 122
     procedure, public :: elpa_generalized_eigenvalues_d      !< public methods to implement the solve step for generalized 
                                                              !< eigenproblem and real/complex double/single matrices
     procedure, public :: elpa_generalized_eigenvalues_f
     procedure, public :: elpa_generalized_eigenvalues_dc
     procedure, public :: elpa_generalized_eigenvalues_fc

123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
     procedure, public :: elpa_hermitian_multiply_d            !< public methods to implement a "hermitian" multiplication of matrices a and b
     procedure, public :: elpa_hermitian_multiply_f            !< for real valued matrices:   a**T * b
     procedure, public :: elpa_hermitian_multiply_dc           !< for complex valued matrices:   a**H * b
     procedure, public :: elpa_hermitian_multiply_fc

     procedure, public :: elpa_cholesky_d                      !< public methods to implement the cholesky factorisation of
                                                               !< real/complex double/single matrices
     procedure, public :: elpa_cholesky_f
     procedure, public :: elpa_cholesky_dc
     procedure, public :: elpa_cholesky_fc

     procedure, public :: elpa_invert_trm_d                    !< public methods to implement the inversion of a triangular
                                                               !< real/complex double/single matrix
     procedure, public :: elpa_invert_trm_f
     procedure, public :: elpa_invert_trm_dc
     procedure, public :: elpa_invert_trm_fc

     procedure, public :: elpa_solve_tridiagonal_d             !< public methods to implement the solve step for a real valued
     procedure, public :: elpa_solve_tridiagonal_f             !< double/single tridiagonal matrix

     procedure, public :: associate_int => elpa_associate_int  !< public method to set some pointers
144

Pavel Kus's avatar
Pavel Kus committed
145
     procedure, private :: elpa_transform_generalized_d
146
     procedure, private :: elpa_transform_back_generalized_d
Pavel Kus's avatar
Pavel Kus committed
147
     procedure, private :: elpa_transform_generalized_dc
148
     procedure, private :: elpa_transform_back_generalized_dc
Pavel Kus's avatar
Pavel Kus committed
149 150
#ifdef WANT_SINGLE_PRECISION_REAL
     procedure, private :: elpa_transform_generalized_f
151
     procedure, private :: elpa_transform_back_generalized_f
Pavel Kus's avatar
Pavel Kus committed
152 153 154
#endif
#ifdef WANT_SINGLE_PRECISION_COMPLEX
     procedure, private :: elpa_transform_generalized_fc
155
     procedure, private :: elpa_transform_back_generalized_fc
Pavel Kus's avatar
Pavel Kus committed
156
#endif
157

158 159
     procedure, public :: print_settings => elpa_print_settings
     procedure, public :: store_settings => elpa_store_settings
Andreas Marek's avatar
Andreas Marek committed
160
     procedure, public :: load_settings => elpa_load_settings
Andreas Marek's avatar
Andreas Marek committed
161
#ifdef ENABLE_AUTOTUNING
162
     procedure, public :: autotune_setup => elpa_autotune_setup
163 164
     procedure, public :: autotune_step => elpa_autotune_step
     procedure, public :: autotune_set_best => elpa_autotune_set_best
165
     procedure, public :: autotune_print_best => elpa_autotune_print_best
Pavel Kus's avatar
Pavel Kus committed
166
     procedure, public :: autotune_print_state => elpa_autotune_print_state
167
     procedure, public :: autotune_save_state => elpa_autotune_save_state
168
     procedure, public :: autotune_load_state => elpa_autotune_load_state
Andreas Marek's avatar
Andreas Marek committed
169
#endif
170
     procedure, private :: construct_scalapack_descriptor => elpa_construct_scalapack_descriptor
171
  end type elpa_impl_t
172 173

  !> \brief the implementation of the generic methods
174
  contains
175 176


177 178 179 180
    !> \brief function to allocate an ELPA object
    !> Parameters
    !> \param   error      integer, optional to get an error code
    !> \result  obj        class(elpa_impl_t) allocated ELPA object
181 182 183 184 185
    function elpa_impl_allocate(error) result(obj)
      type(elpa_impl_t), pointer   :: obj
      integer, optional            :: error

      allocate(obj)
Andreas Marek's avatar
Andreas Marek committed
186

Andreas Marek's avatar
Andreas Marek committed
187
      ! check whether init has ever been called
188
      if ( elpa_initialized() .ne. ELPA_OK) then
189
        write(error_unit, *) "elpa_allocate(): you must call elpa_init() once before creating instances of ELPA"
190 191
        if(present(error)) then
          error = ELPA_ERROR
192
        endif
Andreas Marek's avatar
Andreas Marek committed
193 194
        return
      endif
Andreas Marek's avatar
Andreas Marek committed
195

196
      obj%index = elpa_index_instance_c()
197 198

      ! Associate some important integer pointers for convenience
199 200 201 202 203 204 205 206
      obj%na => obj%associate_int("na")
      obj%nev => obj%associate_int("nev")
      obj%local_nrows => obj%associate_int("local_nrows")
      obj%local_ncols => obj%associate_int("local_ncols")
      obj%nblk => obj%associate_int("nblk")

      if(present(error)) then
        error = ELPA_OK
207 208
      endif
    end function
Andreas Marek's avatar
Andreas Marek committed
209

Andreas Marek's avatar
Andreas Marek committed
210

211 212 213 214 215
    !c> /*! \brief C interface for the implementation of the elpa_allocate method
    !c> *
    !c> *  \param  none
    !c> *  \result elpa_t handle
    !c> */
216
    !c> elpa_t elpa_allocate(int *error);
217
    function elpa_impl_allocate_c(error) result(ptr) bind(C, name="elpa_allocate")
218 219 220 221 222 223 224 225
      integer(kind=c_int) :: error
      type(c_ptr) :: ptr
      type(elpa_impl_t), pointer :: obj

      obj => elpa_impl_allocate(error)
      ptr = c_loc(obj)
    end function

Andreas Marek's avatar
Andreas Marek committed
226

227 228 229 230 231
    !c> /*! \brief C interface for the implementation of the elpa_deallocate method
    !c> *
    !c> *  \param  elpa_t  handle of ELPA object to be deallocated
    !c> *  \result void
    !c> */
232
    !c> void elpa_deallocate(elpa_t handle);
233
    subroutine elpa_impl_deallocate_c(handle) bind(C, name="elpa_deallocate")
234 235 236 237 238 239 240 241
      type(c_ptr), value :: handle
      type(elpa_impl_t), pointer :: self

      call c_f_pointer(handle, self)
      call self%destroy()
      deallocate(self)
    end subroutine

Andreas Marek's avatar
Andreas Marek committed
242

Andreas Marek's avatar
Andreas Marek committed
243
#ifdef ENABLE_AUTOTUNING
244 245 246 247 248
    !c> /*! \brief C interface for the implementation of the elpa_autotune_deallocate method
    !c> *
    !c> *  \param  elpa_autotune_impl_t  handle of ELPA autotune object to be deallocated
    !c> *  \result void
    !c> */
249 250 251
    !c> void elpa_autotune_deallocate(elpa_autotune_t handle);
    subroutine elpa_autotune_impl_deallocate_c( autotune_handle) bind(C, name="elpa_autotune_deallocate")
      type(c_ptr), value                  :: autotune_handle
252

253 254 255
      type(elpa_autotune_impl_t), pointer :: self

      call c_f_pointer(autotune_handle, self)
256 257 258
      call self%destroy()
      deallocate(self)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
259
#endif
260

Andreas Marek's avatar
Andreas Marek committed
261

262 263 264 265 266 267
    ! we want to ensure, that my_prow(col) and np_rows(cols) values are allways accessible trhough
    ! the elpa object, no matter whether the user provides communicators or communicators are created
    ! by elpa. If the walues are present already, they are checked for consistency with the communicators.
    subroutine set_or_check_missing_comm_params(self)
      implicit none
      class(elpa_impl_t), intent(inout)   :: self
268 269 270
      integer                             :: mpi_comm_parent, mpi_comm_rows, mpi_comm_cols, mpierr, error, &
                                             my_prow, my_pcol, my_id, present_my_prow, present_my_pcol, present_my_id, &
                                             np_rows, np_cols, np_total, present_np_rows, present_np_cols, present_np_total, &
271
                                             is_process_id_zero, gpu
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
      if (.not. (self%is_set("mpi_comm_rows") == 1 .and. self%is_set("mpi_comm_cols") == 1) ) then
        print *,"MPI row and column communicators not set correctly. Aborting..."
        stop
      endif
      call self%get("mpi_comm_rows", mpi_comm_rows, error)
      call self%get("mpi_comm_cols", mpi_comm_cols, error)

      call mpi_comm_size(mpi_comm_rows, np_rows, mpierr)
      if(self%is_set("num_process_rows") == 1) then
        call self%get("num_process_rows", present_np_rows, error)
        if(np_rows .ne. present_np_rows) then
          print *,"MPI row communicator not set correctly. Aborting..."
          stop
        endif
      else
        call self%set("num_process_rows", np_rows, error)
      endif

      call mpi_comm_size(mpi_comm_cols, np_cols, mpierr)
      if(self%is_set("num_process_cols") == 1) then
        call self%get("num_process_cols", present_np_cols, error)
        if(np_cols .ne. present_np_cols) then
          print *,"MPI column communicator not set correctly. Aborting..."
          stop
        endif
      else
        call self%set("num_process_cols", np_cols, error)
      endif

      call mpi_comm_rank(mpi_comm_rows, my_prow, mpierr)
      if(self%is_set("process_row") == 1) then
        call self%get("process_row", present_my_prow, error)
        if(my_prow .ne. present_my_prow) then
          print *,"MPI row communicator not set correctly. Aborting..."
          stop
        endif
      else
        call self%set("process_row", my_prow, error)
      endif

      call mpi_comm_rank(mpi_comm_cols, my_pcol, mpierr)
      if(self%is_set("process_col") == 1) then
        call self%get("process_col", present_my_pcol, error)
        if(my_pcol .ne. present_my_pcol) then
          print *,"MPI column communicator not set correctly. Aborting..."
          stop
        endif
      else
        call self%set("process_col", my_pcol, error)
      endif
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


      ! sadly, at the moment, the parent mpi communicator is not required to be set, e.g. in legacy tests
      ! we thus cannot obtain process_id
      ! we can, however, determine the number of prcesses and determine, whether the given process has id 0, 
      ! assuming, that that is the wan with row and column ids == 0
      is_process_id_zero = 0
      if (self%is_set("mpi_comm_parent") == 1) then
        call self%get("mpi_comm_parent", mpi_comm_parent, error)

        call mpi_comm_size(mpi_comm_parent, np_total, mpierr)
        if(self%is_set("num_processes") == 1) then
          call self%get("num_processes", present_np_total, error)
          if(np_total .ne. present_np_total) then
            print *,"MPI parent communicator not set correctly. Aborting..."
            stop
          endif
        else
          call self%set("num_processes", np_total, error)
        endif

        if(np_total .ne. np_rows * np_cols) then
          print *,"MPI parent communicator and row/col communicators do not match. Aborting..."
          stop
        endif

        call mpi_comm_rank(mpi_comm_parent, my_id, mpierr)
        if(self%is_set("process_id") == 1) then
          call self%get("process_id", present_my_id, error)
          if(my_id .ne. present_my_id) then
            print *,"MPI parent communicator not set correctly. Aborting..."
            stop
          endif
        else
          call self%set("process_id", my_id, error)
        endif

        if(my_id == 0) &
          is_process_id_zero = 1
      else
362 363 364 365 366 367 368 369 370 371
        ! for the GPU calculation, the parent communicator has to be set
        call self%get("gpu",gpu,error)
        if (error .ne. ELPA_OK) then
          print *,"Problem getting option. Aborting..."
          stop
        endif
        if(gpu == 1) then
          print *,"MPI parent communicator has to be set for GPU calculation. Aborting..."
          stop
        endif
372 373 374 375 376 377 378 379
        ! we can set number of processes and whether process id is zero, but not the process id.
        ! we assume, that my_pcol == 0 && my_prow == 0  <==> my_id == 0
        call self%set("num_process", np_rows * np_cols, error)
        if((my_prow == 0) .and. (my_pcol == 0)) &
          is_process_id_zero = 1
      endif
        call self%set("is_process_id_zero", is_process_id_zero, error)

380 381
    end subroutine

Andreas Marek's avatar
Andreas Marek committed
382

383 384 385 386
    !> \brief function to setup an ELPA object and to store the MPI communicators internally
    !> Parameters
    !> \param   self       class(elpa_impl_t), the allocated ELPA object
    !> \result  error      integer, the error code
387
    function elpa_setup(self) result(error)
388 389
      class(elpa_impl_t), intent(inout)   :: self
      integer                             :: error, timings
390

391
#ifdef WITH_MPI
392 393 394
      integer                             :: mpi_comm_parent, mpi_comm_rows, mpi_comm_cols, &
                                             mpierr, mpierr2, process_row, process_col, mpi_string_length
      character(len=MPI_MAX_ERROR_STRING) :: mpierr_string
395
#endif
396

397
#ifdef HAVE_DETAILED_TIMINGS
Andreas Marek's avatar
Andreas Marek committed
398
      call self%get("timings",timings, error)
399 400 401 402 403 404
      if (timings == 1) then
        call self%timer%enable()
      endif
#endif

      error = ELPA_OK
405

406 407
#ifdef WITH_MPI
      ! Create communicators ourselves
408 409 410
      if (self%is_set("mpi_comm_parent") == 1 .and. &
          self%is_set("process_row") == 1 .and. &
          self%is_set("process_col") == 1) then
411

Andreas Marek's avatar
Andreas Marek committed
412 413 414
        call self%get("mpi_comm_parent", mpi_comm_parent, error)
        call self%get("process_row", process_row, error)
        call self%get("process_col", process_col, error)
415 416 417 418 419 420 421

        ! mpi_comm_rows is used for communicating WITHIN rows, i.e. all processes
        ! having the same column coordinate share one mpi_comm_rows.
        ! So the "color" for splitting is process_col and the "key" is my row coordinate.
        ! Analogous for mpi_comm_cols

        call mpi_comm_split(mpi_comm_parent,process_col,process_row,mpi_comm_rows,mpierr)
422

423 424 425 426 427 428 429 430 431 432 433 434
        if (mpierr .ne. MPI_SUCCESS) then
          call MPI_ERROR_STRING(mpierr,mpierr_string, mpi_string_length, mpierr2)
          write(error_unit,*) "MPI ERROR occured during mpi_comm_split for row communicator: ", trim(mpierr_string)
          return
        endif

        call mpi_comm_split(mpi_comm_parent,process_row,process_col,mpi_comm_cols, mpierr)
        if (mpierr .ne. MPI_SUCCESS) then
          call MPI_ERROR_STRING(mpierr,mpierr_string, mpi_string_length, mpierr2)
          write(error_unit,*) "MPI ERROR occured during mpi_comm_split for col communicator: ", trim(mpierr_string)
          return
        endif
435

Andreas Marek's avatar
Andreas Marek committed
436 437 438 439 440 441 442 443 444 445
        call self%set("mpi_comm_rows", mpi_comm_rows,error)
        if (error .ne. ELPA_OK) then
          print *,"Problem setting option. Aborting..."
          stop
        endif
        call self%set("mpi_comm_cols", mpi_comm_cols,error)
        if (error .ne. ELPA_OK) then
          print *,"Problem setting option. Aborting..."
          stop
        endif
446

447 448
        call set_or_check_missing_comm_params(self)

449 450 451
        ! remember that we created those communicators and we need to free them later
        self%communicators_owned = 1

452
        error = ELPA_OK
453
        return
454
      endif
455

456
      ! Externally supplied communicators
457
      if (self%is_set("mpi_comm_rows") == 1 .and. self%is_set("mpi_comm_cols") == 1) then
458 459 460 461 462 463 464 465 466 467 468 469
        call self%get("mpi_comm_rows", mpi_comm_rows,error)
        if (error .ne. ELPA_OK) then
          print *,"Problem getting option. Aborting..."
          stop
        endif
        call self%get("mpi_comm_cols", mpi_comm_cols,error)
        if (error .ne. ELPA_OK) then
          print *,"Problem getting option. Aborting..."
          stop
        endif
        !write(error_unit, '(A,2I15)') "comms provided", mpi_comm_rows, mpi_comm_cols

470
        call set_or_check_missing_comm_params(self)
471
        self%communicators_owned = 0
472
        error = ELPA_OK
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488


        call self%get("mpi_comm_rows", mpi_comm_rows,error)
        if (error .ne. ELPA_OK) then
          print *,"Problem getting option. Aborting..."
          stop
        endif
        call self%get("mpi_comm_cols", mpi_comm_cols,error)
        if (error .ne. ELPA_OK) then
          print *,"Problem getting option. Aborting..."
          stop
        endif
        call self%get("process_row", process_row, error)
        call self%get("process_col", process_col, error)
        !write(error_unit, '(A,2I15,2I4)') "comms provided II ", mpi_comm_rows, mpi_comm_cols, process_row, process_col

489
        return
490
      endif
491

492 493
      ! Otherwise parameters are missing
      error = ELPA_ERROR
494 495 496 497 498 499 500 501
#else
        call self%set("process_row", 0, error)
        call self%set("process_col", 0, error)
        call self%set("process_id", 0, error)
        call self%set("is_process_id_zero", 1, error)
        call self%set("num_process_rows", 1, error)
        call self%set("num_process_cols", 1, error)
        call self%set("num_processes", 1, error)
502
#endif
503

504
    end function
505

Andreas Marek's avatar
Andreas Marek committed
506

507 508 509 510 511 512
    !c> /*! \brief C interface for the implementation of the elpa_setup method
    !c> *
    !c> *  \param  elpa_t  handle of the ELPA object which describes the problem to
    !c> *                  be set up
    !c> *  \result int     error code, which can be queried with elpa_strerr
    !c> */
513
    !c> int elpa_setup(elpa_t handle);
514
    function elpa_setup_c(handle) result(error) bind(C, name="elpa_setup")
515 516 517 518 519 520 521 522
      type(c_ptr), intent(in), value :: handle
      type(elpa_impl_t), pointer :: self
      integer(kind=c_int) :: error

      call c_f_pointer(handle, self)
      error = self%setup()
    end function

523
    function elpa_construct_scalapack_descriptor(self, sc_desc, rectangular_for_ev) result(error)
524
      class(elpa_impl_t), intent(inout)   :: self
525
      logical, intent(in)                 :: rectangular_for_ev
526 527 528 529 530 531 532 533 534 535 536 537 538
      integer                             :: error, blacs_ctx
      integer, intent(out)                :: sc_desc(SC_DESC_LEN)

#ifdef WITH_MPI
      if (self%is_set("blacs_context") == 0) then
        print *,"BLACS context has not been set beforehand. Aborting..."
        stop
      endif
      call self%get("blacs_context", blacs_ctx, error)

      sc_desc(1) = 1
      sc_desc(2) = blacs_ctx
      sc_desc(3) = self%na
539 540 541 542 543
      if(rectangular_for_ev) then
        sc_desc(4) = self%nev
      else
        sc_desc(4) = self%na
      endif
544 545 546 547 548 549 550 551 552 553
      sc_desc(5) = self%nblk
      sc_desc(6) = self%nblk
      sc_desc(7) = 0
      sc_desc(8) = 0
      sc_desc(9) = self%local_nrows
#else
      sc_desc = 0
#endif
      error = ELPA_OK
    end function
554

Andreas Marek's avatar
Andreas Marek committed
555

556 557 558 559 560 561 562 563 564
    !c> /*! \brief C interface for the implementation of the elpa_set_integer method
    !c> *  This method is available to the user as C generic elpa_set method
    !c> *
    !c> *  \param  handle  handle of the ELPA object for which a key/value pair should be set
    !c> *  \param  name    the name of the key
    !c> *  \param  value   the value to be set for the key
    !c> *  \param  error   on return the error code, which can be queried with elpa_strerr()
    !c> *  \result void
    !c> */
565
    !c> void elpa_set_integer(elpa_t handle, const char *name, int value, int *error);
566
    subroutine elpa_set_integer_c(handle, name_p, value, error) bind(C, name="elpa_set_integer")
Andreas Marek's avatar
Andreas Marek committed
567 568 569
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
570
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
571 572
      integer(kind=c_int), intent(in), value        :: value
      integer(kind=c_int) , intent(in)              :: error
573 574 575 576 577 578 579

      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
      call elpa_set_integer(self, name, value, error)
    end subroutine


580 581 582 583 584 585 586 587 588
    !c> /*! \brief C interface for the implementation of the elpa_get_integer method
    !c> *  This method is available to the user as C generic elpa_get method
    !c> *
    !c> *  \param  handle  handle of the ELPA object for which a key/value pair should be queried
    !c> *  \param  name    the name of the key
    !c> *  \param  value   the value to be obtain for the key
    !c> *  \param  error   on return the error code, which can be queried with elpa_strerr()
    !c> *  \result void
    !c> */
589 590
    !c> void elpa_get_integer(elpa_t handle, const char *name, int *value, int *error);
    subroutine elpa_get_integer_c(handle, name_p, value, error) bind(C, name="elpa_get_integer")
Andreas Marek's avatar
Andreas Marek committed
591 592 593
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
Andreas Marek's avatar
Andreas Marek committed
594
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
595 596
      integer(kind=c_int)                           :: value
      integer(kind=c_int), intent(inout)            :: error
597
 
Andreas Marek's avatar
Andreas Marek committed
598 599
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
600 601
      call elpa_get_integer(self, name, value, error)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
602 603


604 605 606 607 608
    !> \brief function to check whether a key/value pair is set
    !> Parameters
    !> \param   self       class(elpa_impl_t) the allocated ELPA object
    !> \param   name       string, the key
    !> \result  state      integer, the state of the key/value pair
609 610
    function elpa_is_set(self, name) result(state)
      class(elpa_impl_t)       :: self
611
      character(*), intent(in) :: name
612
      integer                  :: state
613

614
      state = elpa_index_value_is_set_c(self%index, name // c_null_char)
615 616
    end function

617 618 619 620 621 622
    !> \brief function to check whether a key/value pair can be set
    !> Parameters
    !> \param   self       class(elpa_impl_t) the allocated ELPA object
    !> \param   name       string, the key
    !> \param   value      integer, value
    !> \result  error      integer, error code
623 624 625 626 627 628 629 630 631 632
    function elpa_can_set(self, name, value) result(error)
      class(elpa_impl_t)       :: self
      character(*), intent(in) :: name
      integer(kind=c_int), intent(in) :: value
      integer                  :: error

      error = elpa_index_int_is_valid_c(self%index, name // c_null_char, value)
    end function


633 634 635 636 637 638
    !> \brief function to convert a value to an human readable string
    !> Parameters
    !> \param   self        class(elpa_impl_t) the allocated ELPA object
    !> \param   option_name string: the name of the options, whose value should be converted
    !> \param   error       integer: errpr code
    !> \result  string      string: the humanreadable string   
639
    function elpa_value_to_string(self, option_name, error) result(string)
640 641
      class(elpa_impl_t), intent(in) :: self
      character(kind=c_char, len=*), intent(in) :: option_name
642 643 644 645
      type(c_ptr) :: ptr
      integer, intent(out), optional :: error
      integer :: val, actual_error
      character(kind=c_char, len=elpa_index_int_value_to_strlen_c(self%index, option_name // C_NULL_CHAR)), pointer :: string
646

647 648
      nullify(string)

649
      call self%get(option_name, val, actual_error)
650 651 652 653 654
      if (actual_error /= ELPA_OK) then
        if (present(error)) then
          error = actual_error
        endif
        return
655 656
      endif

657 658 659 660
      actual_error = elpa_int_value_to_string_c(option_name // C_NULL_CHAR, val, ptr)
      if (c_associated(ptr)) then
        call c_f_pointer(ptr, string)
      endif
661

662 663 664 665
      if (present(error)) then
        error = actual_error
      endif
    end function
666

Andreas Marek's avatar
Andreas Marek committed
667

668 669 670 671 672 673 674 675 676
    !c> /*! \brief C interface for the implementation of the elpa_set_double method
    !c> *  This method is available to the user as C generic elpa_set method
    !c> *
    !c> *  \param  handle  handle of the ELPA object for which a key/value pair should be set
    !c> *  \param  name    the name of the key
    !c> *  \param  value   the value to be set for the key
    !c> *  \param  error   on return the error code, which can be queried with elpa_strerr()
    !c> *  \result void
    !c> */
677
    !c> void elpa_set_double(elpa_t handle, const char *name, double value, int *error);
678
    subroutine elpa_set_double_c(handle, name_p, value, error) bind(C, name="elpa_set_double")
Andreas Marek's avatar
Andreas Marek committed
679 680 681
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
682
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
683 684
      real(kind=c_double), intent(in), value        :: value
      integer(kind=c_int), intent(in)               :: error
685

686 687 688 689 690
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
      call elpa_set_double(self, name, value, error)
    end subroutine

691

692
    !c> /*! \brief C interface for the implementation of the elpa_get_double method
693 694 695 696 697 698 699 700
    !c> *  This method is available to the user as C generic elpa_get method
    !c> *
    !c> *  \param  handle  handle of the ELPA object for which a key/value pair should be queried
    !c> *  \param  name    the name of the key
    !c> *  \param  value   the value to be obtain for the key
    !c> *  \param  error   on return the error code, which can be queried with elpa_strerr()
    !c> *  \result void
    !c> */
701 702
    !c> void elpa_get_double(elpa_t handle, const char *name, double *value, int *error);
    subroutine elpa_get_double_c(handle, name_p, value, error) bind(C, name="elpa_get_double")
Andreas Marek's avatar
Andreas Marek committed
703 704 705
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
Andreas Marek's avatar
Andreas Marek committed
706
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
707 708
      real(kind=c_double)                           :: value
      integer(kind=c_int), intent(inout)            :: error
709

Andreas Marek's avatar
Andreas Marek committed
710 711
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
712 713
      call elpa_get_double(self, name, value, error)
    end subroutine
714
 
Andreas Marek's avatar
Andreas Marek committed
715

716 717 718 719 720
    !> \brief function to associate a pointer with an integer value
    !> Parameters
    !> \param   self        class(elpa_impl_t) the allocated ELPA object
    !> \param   name        string: the name of the entry
    !> \result  value       integer, pointer: the value for the entry
721
    function elpa_associate_int(self, name) result(value)
722
      class(elpa_impl_t)             :: self
723 724
      character(*), intent(in)       :: name
      integer(kind=c_int), pointer   :: value
Andreas Marek's avatar
Andreas Marek committed
725

726 727
      type(c_ptr)                    :: value_p

728
      value_p = elpa_index_get_int_loc_c(self%index, name // c_null_char)
729 730 731
      if (.not. c_associated(value_p)) then
        write(error_unit, '(a,a,a)') "ELPA: Warning, received NULL pointer for entry '", name, "'"
      endif
732 733
      call c_f_pointer(value_p, value)
    end function
Andreas Marek's avatar
Andreas Marek committed
734

735

736 737 738 739 740 741 742
    !> \brief function to querry the timing information at a certain level
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
    !> \param   name1 .. name6  string: the string identifier for the timer region.
    !>                                  at the moment 6 nested levels can be queried
    !> \result  s               double: the timer metric for the region. Might be seconds,
    !>                                  or any other supported metric
743 744 745 746 747 748
    function elpa_get_time(self, name1, name2, name3, name4, name5, name6) result(s)
      class(elpa_impl_t), intent(in) :: self
      ! this is clunky, but what can you do..
      character(len=*), intent(in), optional :: name1, name2, name3, name4, name5, name6
      real(kind=c_double) :: s

749
#ifdef HAVE_DETAILED_TIMINGS
750
      s = self%timer%get(name1, name2, name3, name4, name5, name6)
751 752 753
#else
      s = -1.0
#endif
754 755 756
    end function


757 758 759 760 761
    !> \brief function to print the timing tree below at a certain level
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
    !> \param   name1 .. name6  string: the string identifier for the timer region.
    !>                                  at the moment 4 nested levels can be specified
762
    subroutine elpa_print_times(self, name1, name2, name3, name4)
763
      class(elpa_impl_t), intent(in) :: self
764
      character(len=*), intent(in), optional :: name1, name2, name3, name4
765
#ifdef HAVE_DETAILED_TIMINGS
766
      call self%timer%print(name1, name2, name3, name4)
767
#endif
768 769
    end subroutine

770

771 772 773 774
    !> \brief function to start the timing of a code region
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
    !> \param   name            string: a chosen identifier name for the code region
775 776 777 778 779 780 781 782 783
    subroutine elpa_timer_start(self, name)
      class(elpa_impl_t), intent(inout) :: self
      character(len=*), intent(in) :: name
#ifdef HAVE_DETAILED_TIMINGS
      call self%timer%start(name)
#endif
    end subroutine


784 785 786 787
    !> \brief function to stop the timing of a code region
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
    !> \param   name            string: identifier name for the code region to stop
788 789 790 791 792 793 794 795 796
    subroutine elpa_timer_stop(self, name)
      class(elpa_impl_t), intent(inout) :: self
      character(len=*), intent(in) :: name
#ifdef HAVE_DETAILED_TIMINGS
      call self%timer%stop(name)
#endif
    end subroutine


797 798 799
    !> \brief function to destroy an elpa object
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
800
    subroutine elpa_destroy(self)
801
#ifdef WITH_MPI
Pavel Kus's avatar
Pavel Kus committed
802 803
      integer :: mpi_comm_rows, mpi_comm_cols, mpierr, mpierr2, error, mpi_string_length
      character(len=MPI_MAX_ERROR_STRING) :: mpierr_string
804
#endif
805
      class(elpa_impl_t) :: self
806 807 808

#ifdef WITH_MPI
      if (self%communicators_owned == 1) then
Andreas Marek's avatar
Andreas Marek committed
809 810 811 812 813 814 815 816 817 818
        call self%get("mpi_comm_rows", mpi_comm_rows,error)
        if (error .ne. ELPA_OK) then
           print *,"Problem getting option. Aborting..."
           stop
        endif
        call self%get("mpi_comm_cols", mpi_comm_cols,error)
        if (error .ne. ELPA_OK) then
           print *,"Problem getting option. Aborting..."
           stop
        endif
819

820
        write(error_unit, '(A,2I13)') "FREE comms", mpi_comm_rows, mpi_comm_cols
821
        call mpi_comm_free(mpi_comm_rows, mpierr)
Pavel Kus's avatar
Pavel Kus committed
822 823 824 825 826
        if (mpierr .ne. MPI_SUCCESS) then
          call MPI_ERROR_STRING(mpierr,mpierr_string, mpi_string_length, mpierr2)
          write(error_unit,*) "MPI ERROR occured during mpi_comm_free for row communicator: ", trim(mpierr_string)
          return
        endif
827
        call self%set("mpi_comm_cols", -12345,error)
828
        call mpi_comm_free(mpi_comm_cols, mpierr)
Pavel Kus's avatar
Pavel Kus committed
829 830 831 832 833
        if (mpierr .ne. MPI_SUCCESS) then
          call MPI_ERROR_STRING(mpierr,mpierr_string, mpi_string_length, mpierr2)
          write(error_unit,*) "MPI ERROR occured during mpi_comm_free for col communicator: ", trim(mpierr_string)
          return
        endif
834
        call self%set("mpi_comm_rows", -12345,error)
835 836 837
      endif
#endif

838
      call timer_free(self%timer)
839
      call timer_free(self%autotune_timer)
840 841
      call elpa_index_free_c(self%index)

842
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
843

Pavel Kus's avatar
Pavel Kus committed
844 845
#define REALCASE 1
#define DOUBLE_PRECISION 1
Andreas Marek's avatar
Andreas Marek committed
846
#define INCLUDE_ROUTINES 1
Pavel Kus's avatar
Pavel Kus committed
847
#include "general/precision_macros.h"
Andreas Marek's avatar
Andreas Marek committed
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
#include "elpa_impl_math_template.F90"
#undef REALCASE
#undef DOUBLE_PRECISION
#undef INCLUDE_ROUTINES

#ifdef WANT_SINGLE_PRECISION_REAL
#define INCLUDE_ROUTINES 1
#endif
#define REALCASE 1
#define SINGLE_PRECISION 1
#include "general/precision_macros.h"
#include "elpa_impl_math_template.F90"
#undef REALCASE
#undef SINGLE_PRECISION
#undef INCLUDE_ROUTINES

#define COMPLEXCASE 1
#define DOUBLE_PRECISION 1
#define INCLUDE_ROUTINES 1
#include "general/precision_macros.h"
#include "elpa_impl_math_template.F90"
#undef DOUBLE_PRECISION
#undef COMPLEXCASE
#undef INCLUDE_ROUTINES

#ifdef WANT_SINGLE_PRECISION_COMPLEX
#define INCLUDE_ROUTINES 1
#endif
#define COMPLEXCASE 1
#define SINGLE_PRECISION
#include "general/precision_macros.h"
#include "elpa_impl_math_template.F90"
#undef COMPLEXCASE
#undef SINGLE_PRECISION
#undef INCLUDE_ROUTINES

#define REALCASE 1
#define DOUBLE_PRECISION 1
#include "general/precision_macros.h"
#include "elpa_impl_generalized_transform_template.F90"
Pavel Kus's avatar
Pavel Kus committed
888 889 890 891 892 893 894
#undef REALCASE
#undef DOUBLE_PRECISION

#ifdef WANT_SINGLE_PRECISION_REAL
#define REALCASE 1
#define SINGLE_PRECISION 1
#include "general/precision_macros.h"
Andreas Marek's avatar
Andreas Marek committed
895
#include "elpa_impl_generalized_transform_template.F90"
Pavel Kus's avatar
Pavel Kus committed
896 897
#undef REALCASE
#undef SINGLE_PRECISION
Andreas Marek's avatar
Andreas Marek committed
898
#endif
Pavel Kus's avatar
Pavel Kus committed
899 900

#define COMPLEXCASE 1
Andreas Marek's avatar
Andreas Marek committed
901

Pavel Kus's avatar
Pavel Kus committed
902 903
#define DOUBLE_PRECISION 1
#include "general/precision_macros.h"
Andreas Marek's avatar
Andreas Marek committed
904
#include "elpa_impl_generalized_transform_template.F90"
Pavel Kus's avatar
Pavel Kus committed
905 906 907 908 909 910 911
#undef DOUBLE_PRECISION
#undef COMPLEXCASE

#ifdef WANT_SINGLE_PRECISION_COMPLEX
#define COMPLEXCASE 1
#define SINGLE_PRECISION
#include "general/precision_macros.h"
Andreas Marek's avatar
Andreas Marek committed
912
#include "elpa_impl_generalized_transform_template.F90"
Pavel Kus's avatar
Pavel Kus committed
913 914
#undef COMPLEXCASE
#undef SINGLE_PRECISION
Andreas Marek's avatar
Andreas Marek committed
915 916
#endif

Andreas Marek's avatar
Andreas Marek committed
917

918 919 920 921 922 923
!    function use_cannons_algorithm(self) result(use_cannon, do_print)
!      class(elpa_impl_t), intent(inout), target :: self
!      logical                                   :: use_cannon
!      logical, intent(in)                       :: do_print
!    end function
!
Andreas Marek's avatar
Andreas Marek committed
924
#ifdef ENABLE_AUTOTUNING
925 926
    !> \brief function to setup the ELPA autotuning and create the autotune object
    !> Parameters
927
    !> \param   self            the allocated ELPA object
928 929
    !> \param   level           integer: the "thoroughness" of the planed autotuning
    !> \param   domain          integer: the domain (real/complex) which should be tuned
930
    !> \result  tune_state      the created autotuning object
931
    function elpa_autotune_setup(self, level, domain, error) result(tune_state)
932
      class(elpa_impl_t), intent(inout), target :: self
Andreas Marek's avatar
Andreas Marek committed
933 934 935
      integer, intent(in)                       :: level, domain
      type(elpa_autotune_impl_t), pointer       :: ts_impl
      class(elpa_autotune_t), pointer           :: tune_state
936 937 938 939 940
#ifdef USE_FORTRAN2008
      integer(kind=c_int), optional             :: error
#else
      integer(kind=c_int)                       :: error
#endif
941

942 943 944 945 946 947 948
#ifdef USE_FORTRAN2008
      if (present(error)) then
        error = ELPA_OK
      endif
#else
      error = ELPA_OK
#endif
Andreas Marek's avatar
Andreas Marek committed
949
      if (elpa_get_api_version() < EARLIEST_AUTOTUNE_VERSION) then
950 951 952 953 954 955 956 957 958
        write(error_unit, "(a,i0,a)") "ELPA: Error API version: Autotuning does not support ", elpa_get_api_version()
#ifdef USE_FORTRAN2008
        if (present(error)) then
          error = ELPA_ERROR
        endif
#else
        error = ELPA_ERROR
#endif
        return
Andreas Marek's avatar
Andreas Marek committed
959 960
      endif

961 962 963 964 965
      allocate(ts_impl)
      ts_impl%parent => self
      ts_impl%level = level
      ts_impl%domain = domain

966
      ts_impl%current = -1
967
      ts_impl%min_loc = -1
968
      ts_impl%cardinality = elpa_index_autotune_cardinality_c(self%index, level, domain)
969 970 971 972 973 974 975

      tune_state => ts_impl

      call self%autotune_timer%enable()
    end function


Andreas Marek's avatar
Andreas Marek committed
976

977 978 979 980 981 982 983
    !c> /*! \brief C interface for the implementation of the elpa_autotune_setup method
    !c> *
    !c> *  \param  elpa_t           handle: of the ELPA object which should be tuned
    !c> *  \param  int              level:  "thoroughness" of autotuning
    !c> *  \param  int              domain: real/complex autotuning
    !c> *  \result elpa_autotune_t  handle:  on the autotune object
    !c> */
984 985
    !c> elpa_autotune_t elpa_autotune_setup(elpa_t handle, int level, int domain, int *error);
    function elpa_autotune_setup_c(handle ,level, domain, error) result(ptr) bind(C, name="elpa_autotune_setup")
986 987 988 989 990 991 992
      type(c_ptr), intent(in), value         :: handle
      type(elpa_impl_t), pointer             :: self
      class(elpa_autotune_t), pointer        :: tune_state
      type(elpa_autotune_impl_t), pointer    :: obj        
      integer(kind=c_int), intent(in), value :: level
      integer(kind=c_int), intent(in), value :: domain
      type(c_ptr)                            :: ptr
993
      integer(kind=c_int) , intent(in)       :: error
994 995

      call c_f_pointer(handle, self)
996

997
      tune_state => self%autotune_setup(level, domain, error)
998
      select type(tune_state)
999
        type is (elpa_autotune_impl_t)
1000 1001 1002
          obj => tune_state
        class default
          print *, "This should not happen"
1003
          stop
1004 1005
      end select                
      ptr = c_loc(obj)
1006

1007
    end function
1008 1009


1010 1011 1012 1013 1014
    !> \brief function to do an autotunig step
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
    !> \param   tune_state      class(elpa_autotune_t): the autotuning object
    !> \result  unfinished      logical: describes the state of the autotuning (completed/uncompleted)
1015
    function elpa_autotune_step(self, tune_state, error) result(unfinished)
1016
      implicit none
1017
      class(elpa_impl_t), intent(inout)             :: self
1018
      class(elpa_autotune_t), intent(inout), target :: tune_state
1019
      type(elpa_autotune_impl_t), pointer           :: ts_impl
Andreas Marek's avatar
Andreas Marek committed
1020 1021 1022 1023 1024 1025 1026 1027
#ifdef USE_FORTRAN2008
      integer(kind=c_int), optional, intent(out)    :: error
#else
      integer(kind=c_int),  intent(out)             :: error
#endif
      logical                                       :: unfinished
      integer                                       :: i
      real(kind=C_DOUBLE)                           :: time_spent
1028

1029 1030 1031
      if (present(error)) then
        error = ELPA_OK
      endif
1032
      select type(tune_state)
1033
        type is (elpa_autotune_impl_t)
1034 1035 1036
          ts_impl => tune_state
        class default
          print *, "This should not happen"
1037 1038 1039
          if (present(error)) then
            error = ELPA_OK
          endif
1040 1041 1042 1043
      end select

      unfinished = .false.

1044
      if (ts_impl%current >= 0) then
1045
#ifdef HAVE_DETAILED_TIMINGS
1046
        time_spent = self%autotune_timer%get("accumulator")
1047 1048
#else
        print *, "Cannot do autotuning without detailed timings"
1049 1050 1051 1052 1053

        if (present(error)) then
          error = ELPA_OK
          return
        endif
1054
#endif
1055 1056
        if (ts_impl%min_loc == -1 .or. (time_spent < ts_impl%min_val)) then
          ts_impl%min_val = time_spent
1057
          ts_impl%min_loc = ts_impl%current
1058 1059 1060 1061
        end if
        call self%autotune_timer%free()
      endif

1062 1063 1064
      do while (ts_impl%current < ts_impl%cardinality - 1)
        ts_impl%current = ts_impl%current + 1
        if (elpa_index_set_autotune_parameters_c(self%index, ts_impl%level, ts_impl%domain, ts_impl%current) == 1) then