elpa_impl.F90 66.1 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
    function elpa_impl_allocate(error) result(obj)
182 183 184 185 186 187 188
      type(elpa_impl_t), pointer     :: obj
#ifdef USE_FORTRAN2008
      integer, optional, intent(out) :: error
#else
      integer, intent(out)           :: error
#endif
      integer                        :: error2
189

190 191 192 193
      allocate(obj, stat=error2)
      if (error2 .ne. 0) then
        write(error_unit, *) "elpa_allocate(): could not allocate object"
      endif        
Andreas Marek's avatar
Andreas Marek committed
194

Andreas Marek's avatar
Andreas Marek committed
195
      ! check whether init has ever been called
196
      if ( elpa_initialized() .ne. ELPA_OK) then
197
        write(error_unit, *) "elpa_allocate(): you must call elpa_init() once before creating instances of ELPA"
198
        if (present(error)) then
199
          error = ELPA_ERROR_API_VERSION
200
        endif
Andreas Marek's avatar
Andreas Marek committed
201 202
        return
      endif
Andreas Marek's avatar
Andreas Marek committed
203

204
      obj%index = elpa_index_instance_c()
205 206

      ! Associate some important integer pointers for convenience
207 208 209 210 211 212
      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")

213
      if (present(error)) then
214
        error = ELPA_OK
215 216
      endif
    end function
Andreas Marek's avatar
Andreas Marek committed
217

Andreas Marek's avatar
Andreas Marek committed
218 219 220
#ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c> #define elpa_allocate(...) CONC(elpa_allocate, NARGS(__VA_ARGS__))(__VA_ARGS__)
#endif
221 222 223 224 225
    !c> /*! \brief C interface for the implementation of the elpa_allocate method
    !c> *
    !c> *  \param  none
    !c> *  \result elpa_t handle
    !c> */
Andreas Marek's avatar
Andreas Marek committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239
#ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c> elpa_t elpa_allocate2(int *error);
    !c> elpa_t elpa_allocate1();
    function elpa_impl_allocate_c1() result(ptr) bind(C, name="elpa_allocate1")
      type(c_ptr)                :: ptr
      type(elpa_impl_t), pointer :: obj

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

    function elpa_impl_allocate_c2(error) result(ptr) bind(C, name="elpa_allocate2")
      integer(kind=c_int)        :: error
      type(c_ptr)                :: ptr
240 241 242 243 244
      type(elpa_impl_t), pointer :: obj

      obj => elpa_impl_allocate(error)
      ptr = c_loc(obj)
    end function
Andreas Marek's avatar
Andreas Marek committed
245 246 247 248 249
#else
    function elpa_impl_allocate_c(error) result(ptr) bind(C, name="elpa_allocate")
      integer(kind=c_int)        :: error
      type(c_ptr)                :: ptr
      type(elpa_impl_t), pointer :: obj
250

Andreas Marek's avatar
Andreas Marek committed
251 252 253 254
      obj => elpa_impl_allocate(error)
      ptr = c_loc(obj)
    end function
#endif
Andreas Marek's avatar
Andreas Marek committed
255

Andreas Marek's avatar
Andreas Marek committed
256 257 258 259 260 261 262
#ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c> #define NARGS(...) NARGS_(__VA_ARGS__, 5, 4, 3, 2, 1, 0)
    !c> #define NARGS_(_5, _4, _3, _2, _1, N, ...) N
    !c> #define CONC(A, B) CONC_(A, B)
    !c> #define CONC_(A, B) A##B
    !c> #define elpa_deallocate(...) CONC(elpa_deallocate, NARGS(__VA_ARGS__))(__VA_ARGS__)
#endif
263 264 265
    !c> /*! \brief C interface for the implementation of the elpa_deallocate method
    !c> *
    !c> *  \param  elpa_t  handle of ELPA object to be deallocated
266
    !c> *  \param  int*    error code
267 268
    !c> *  \result void
    !c> */
Andreas Marek's avatar
Andreas Marek committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
#ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c> void elpa_deallocate2(elpa_t handle, int *error);
    !c> void elpa_deallocate1(elpa_t handle);
    subroutine elpa_impl_deallocate_c2(handle, error) bind(C, name="elpa_deallocate2")
      type(c_ptr), value         :: handle
      type(elpa_impl_t), pointer :: self
      integer(kind=c_int)        :: error

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

    subroutine elpa_impl_deallocate_c1(handle) bind(C, name="elpa_deallocate1")
      type(c_ptr), value         :: handle
      type(elpa_impl_t), pointer :: self

      call c_f_pointer(handle, self)
      call self%destroy()
      deallocate(self)
    end subroutine
#else
291 292
    subroutine elpa_impl_deallocate_c(handle, error) bind(C, name="elpa_deallocate")
      type(c_ptr), value         :: handle
293
      type(elpa_impl_t), pointer :: self
294
      integer(kind=c_int)        :: error
295 296

      call c_f_pointer(handle, self)
297
      call self%destroy(error)
298 299 300
      deallocate(self)
    end subroutine

Andreas Marek's avatar
Andreas Marek committed
301 302
#endif

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
    !> \brief function to load all the parameters, which have been saved to a file
    !> Parameters
    !> \param   self        class(elpa_impl_t) the allocated ELPA object
    !> \param   file_name   string, the name of the file from which to load the parameters
    !> \param   error       integer, optional
    subroutine elpa_load_settings(self, file_name, error)
      implicit none
      class(elpa_impl_t), intent(inout) :: self
      character(*), intent(in)          :: file_name
#ifdef USE_FORTRAN2008
      integer(kind=c_int), optional, intent(out)    :: error
#else
      integer(kind=c_int), intent(out)              :: error
#endif
      if (present(error)) then
        error = ELPA_OK
      endif
      if (elpa_index_load_settings_c(self%index, file_name // c_null_char) /= 1) then
        write(error_unit, *) "This should not happen (in elpa_load_settings())"
        if (present(error)) then
          error = ELPA_ERROR_CANNOT_OPEN_FILE
        endif
      endif
    end subroutine

    !c> /*! \brief C interface for the implementation of the elpa_load_settings method
    !c> *
    !c> *  \param elpa_t handle
    !c> *  \param  char* filename
    !c> */
    !c> void elpa_load_settings(elpa_t handle, const char *filename, int *error);
    subroutine elpa_load_settings_c(handle, filename_p, error) bind(C, name="elpa_load_settings")
      type(c_ptr), value         :: handle
      type(elpa_impl_t), pointer :: self

      integer(kind=c_int)        :: error
      type(c_ptr), intent(in), value :: filename_p
      character(len=elpa_strlen_c(filename_p)), pointer :: filename

      call c_f_pointer(handle, self)
      call c_f_pointer(filename_p, filename)
      call elpa_load_settings(self, filename, error)

    end subroutine

    !> \brief function to print all the parameters, that have been set
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
    !> \param   error           optional, integer
    subroutine elpa_print_settings(self, error)
      implicit none
      class(elpa_impl_t), intent(inout) :: self
#ifdef USE_FORTRAN2008
      integer(kind=c_int), optional, intent(out)    :: error
#else
      integer(kind=c_int), intent(out)              :: error
#endif
      if (present(error)) then
        error = ELPA_OK
      endif
      if (elpa_index_print_settings_c(self%index, c_null_char) /= 1) then
        write(error_unit, *) "This should not happen (in elpa_print_settings())"
        if (present(error)) then
          error = ELPA_ERROR
        endif
      endif
    end subroutine

    !c> /*! \brief C interface for the implementation of the elpa_print_settings method
    !c> *
    !c> *  \param elpa_t handle
    !c> *  \param  char* filename
    !c> */
    !c> void elpa_print_settings(elpa_t handle, int *error);
    subroutine elpa_print_settings_c(handle, error) bind(C, name="elpa_print_settings")
      type(c_ptr), value         :: handle
      type(elpa_impl_t), pointer :: self
 
      integer(kind=c_int)        :: error

      call c_f_pointer(handle, self)
      call elpa_print_settings(self, error)

    end subroutine


    !> \brief function to save all the parameters, that have been set
    !> Parameters
    !> \param   self        class(elpa_impl_t) the allocated ELPA object
    !> \param   file_name   string, the name of the file where to save the parameters
    !> \param   error       integer, optional
    subroutine elpa_store_settings(self, file_name, error)
      implicit none
      class(elpa_impl_t), intent(inout) :: self
      character(*), intent(in)          :: file_name
#ifdef USE_FORTRAN2008
      integer(kind=c_int), optional, intent(out)    :: error
#else
      integer(kind=c_int), intent(out)              :: error
#endif

      if (present(error)) then
        error = ELPA_OK
      endif
      if (elpa_index_print_settings_c(self%index, file_name // c_null_char) /= 1) then
        write(error_unit, *) "This should not happen (in elpa_store_settings())"
        if (present(error)) then
          error = ELPA_ERROR_CANNOT_OPEN_FILE
        endif

      endif
    end subroutine


    !c> /*! \brief C interface for the implementation of the elpa_store_settings method
    !c> *
    !c> *  \param elpa_t handle
    !c> *  \param  char* filename
    !c> */
    !c> void elpa_store_settings(elpa_t handle, const char *filename, int *error);
    subroutine elpa_store_settings_c(handle, filename_p, error) bind(C, name="elpa_store_settings")
      type(c_ptr), value         :: handle
      type(elpa_impl_t), pointer :: self
      type(c_ptr), intent(in), value :: filename_p
      character(len=elpa_strlen_c(filename_p)), pointer :: filename
      integer(kind=c_int)        :: error

      call c_f_pointer(handle, self)
      call c_f_pointer(filename_p, filename)
      call elpa_store_settings(self, filename, error)

    end subroutine




Andreas Marek's avatar
Andreas Marek committed
439

Andreas Marek's avatar
Andreas Marek committed
440
#ifdef ENABLE_AUTOTUNING
Andreas Marek's avatar
Andreas Marek committed
441 442 443
#ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c> #define elpa_autotune_deallocate(...) CONC(elpa_autotune_deallocate, NARGS(__VA_ARGS__))(__VA_ARGS__)
#endif
444 445 446 447 448
    !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> */
Andreas Marek's avatar
Andreas Marek committed
449 450 451 452
#ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c> void elpa_autotune_deallocate2(elpa_autotune_t handle, int *error);
    !c> void elpa_autotune_deallocate1(elpa_autotune_t handle);
    subroutine elpa_autotune_impl_deallocate_c1( autotune_handle) bind(C, name="elpa_autotune_deallocate1")
453
      type(c_ptr), value                  :: autotune_handle
454

455 456 457
      type(elpa_autotune_impl_t), pointer :: self

      call c_f_pointer(autotune_handle, self)
458 459 460
      call self%destroy()
      deallocate(self)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481

    subroutine elpa_autotune_impl_deallocate_c2( autotune_handle, error) bind(C, name="elpa_autotune_deallocate2")
      type(c_ptr), value                  :: autotune_handle

      type(elpa_autotune_impl_t), pointer :: self
      integer(kind=c_int)                 :: error
      call c_f_pointer(autotune_handle, self)
      call self%destroy(error)
      deallocate(self)
    end subroutine
#else
    subroutine elpa_autotune_impl_deallocate( autotune_handle, error) bind(C, name="elpa_autotune_deallocate")
      type(c_ptr), value                  :: autotune_handle

      type(elpa_autotune_impl_t), pointer :: self
      integer(kind=c_int)                 :: error
      call c_f_pointer(autotune_handle, self)
      call self%destroy(error)
      deallocate(self)
    end subroutine

Andreas Marek's avatar
Andreas Marek committed
482
#endif
Andreas Marek's avatar
Andreas Marek committed
483
#endif /* ENABLE_AUTOTUNING */
484

485 486 487 488
    !> \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
489
    function elpa_setup(self) result(error)
490
      class(elpa_impl_t), intent(inout)   :: self
Andreas Marek's avatar
Andreas Marek committed
491
      integer                             :: error, timings, performance
492

493
#ifdef WITH_MPI
494 495 496
      integer                             :: mpi_comm_parent, mpi_comm_rows, mpi_comm_cols, np_rows, np_cols, my_id, &
                                             mpierr, mpierr2, process_row, process_col, mpi_string_length, &
                                             present_np_rows, present_np_cols, is_process_id_zero, np_total, legacy_api
497
      character(len=MPI_MAX_ERROR_STRING) :: mpierr_string
498 499 500
      character(*), parameter             :: MPI_CONSISTENCY_MSG = &
        "Provide mpi_comm_parent and EITHER process_row and process_col OR mpi_comm_rows and mpi_comm_cols. Aborting..."

501
#endif
502

503
#ifdef HAVE_DETAILED_TIMINGS
Andreas Marek's avatar
Andreas Marek committed
504
      call self%get("timings",timings, error)
Andreas Marek's avatar
Andreas Marek committed
505 506
      call self%get("measure_performance",performance, error)
      print *,error
507
      if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
508 509
      if (timings == 1) then
        call self%timer%enable()
Andreas Marek's avatar
Andreas Marek committed
510 511
        if (performance == 1) then
          call self%timer%measure_flops(.true.)
Andreas Marek's avatar
Andreas Marek committed
512
          call self%timer%set_print_options(print_flop_count=.true.,print_flop_rate=.true.)
Andreas Marek's avatar
Andreas Marek committed
513
        endif
514 515 516 517
      endif
#endif

      error = ELPA_OK
518

519 520 521 522 523 524 525 526
      ! In most cases, we actually need the parent communicator to be supplied,
      ! ELPA internally requires it when either GPU is enabled or when ELPA2 is
      ! used. It thus seems reasonable that we should ALLWAYS require it. It
      ! should then be accompanied by EITHER process_row and process_col
      ! indices, OR mpi_comm_rows and mpi_comm_cols communicators, but NOT both.
      ! This assumption will significanlty simplify the logic, avoid possible
      ! inconsistencies and is rather natural from the user point of view

527
#ifdef WITH_MPI
528
      if (self%is_set("legacy_api") == 1) then
529
        call self%get("legacy_api", legacy_api, error)
530
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
531
      endif
532

533
      if (self%is_set("mpi_comm_parent") == 1) then
Andreas Marek's avatar
Andreas Marek committed
534
        call self%get("mpi_comm_parent", mpi_comm_parent, error)
535
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
536 537 538

        call mpi_comm_rank(mpi_comm_parent, my_id, mpierr)
        call self%set("process_id", my_id, error)
539
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
540 541 542

        call mpi_comm_size(mpi_comm_parent, np_total, mpierr)
        call self%set("num_processes", np_total, error)
543
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
544 545

        is_process_id_zero = 0
546
        if (my_id == 0) &
547 548
          is_process_id_zero = 1
        call self%set("is_process_id_zero", is_process_id_zero, error)
549
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
550 551

      else
552
        if (legacy_api .ne. 1) then
553 554 555 556 557 558 559 560 561
          write(error_unit,*) MPI_CONSISTENCY_MSG
          error = ELPA_ERROR
          return
        endif
      endif

      ! Create communicators ourselves
      if (self%is_set("process_row") == 1 .and. self%is_set("process_col") == 1) then

562
        if (self%is_set("mpi_comm_rows") == 1 .or. self%is_set("mpi_comm_cols") == 1) then
563 564 565 566 567
          write(error_unit,*) MPI_CONSISTENCY_MSG
          error = ELPA_ERROR
          return
        endif

Andreas Marek's avatar
Andreas Marek committed
568
        call self%get("process_row", process_row, error)
569
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
570

Andreas Marek's avatar
Andreas Marek committed
571
        call self%get("process_col", process_col, error)
572
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591

        ! 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)
        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
592

Andreas Marek's avatar
Andreas Marek committed
593
        call self%set("mpi_comm_rows", mpi_comm_rows,error)
594
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
595

596
        call self%set("mpi_comm_cols", mpi_comm_cols,error)
597
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
598

599 600 601
        ! remember that we created those communicators and we need to free them later
        self%communicators_owned = 1

602
      ! Externally supplied communicators
603 604
      else if ( self%is_set("mpi_comm_rows") == 1 .and.  self%is_set("mpi_comm_cols") == 1) then

605
        if (self%is_set("process_row") == 1 .or. self%is_set("process_col") == 1) then
606 607 608
          write(error_unit,*) MPI_CONSISTENCY_MSG
          error = ELPA_ERROR
          return
609
        endif
610 611

        call self%get("mpi_comm_rows", mpi_comm_rows,error)
612
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
613

614
        call self%get("mpi_comm_cols", mpi_comm_cols,error)
615
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
616 617 618

        call mpi_comm_rank(mpi_comm_rows, process_row, mpierr)
        call self%set("process_row", process_row, error)
619
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
620

621 622
        call mpi_comm_rank(mpi_comm_cols, process_col, mpierr)
        call self%set("process_col", process_col, error)
623
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
624 625

        ! remember that we DID NOT created those communicators and we WILL NOT free them later
626
        self%communicators_owned = 0
627 628 629 630 631 632
      else
        ! Otherwise parameters are missing
        write(error_unit,*) MPI_CONSISTENCY_MSG
        error = ELPA_ERROR
        return
      endif
633

634 635 636 637
      ! set num_process_rows (and cols), if they are not supplied. Check them
      ! for consistency if they are. Maybe we could instead require, that they
      ! are never supplied?
      call mpi_comm_size(mpi_comm_rows, np_rows, mpierr)
638
      if (self%is_set("num_process_rows") == 1) then
639
        call self%get("num_process_rows", present_np_rows, error)
640
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
641

642
        if (np_rows .ne. present_np_rows) then
643
          print *,"MPI row communicator not set correctly. Aborting..."
644 645
          stop
        endif
646 647
      else
        call self%set("num_process_rows", np_rows, error)
648
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
649 650 651
      endif

      call mpi_comm_size(mpi_comm_cols, np_cols, mpierr)
652
      if (self%is_set("num_process_cols") == 1) then
653
        call self%get("num_process_cols", present_np_cols, error)
654
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
655

656
        if (np_cols .ne. present_np_cols) then
657
          print *,"MPI column communicator not set correctly. Aborting..."
658 659
          stop
        endif
660 661
      else
        call self%set("num_process_cols", np_cols, error)
662
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
663
      endif
664

665 666
      if (legacy_api .ne. 1) then
        if (np_total .ne. np_rows * np_cols) then
667 668 669
          print *,"MPI parent communicator and row/col communicators do not match. Aborting..."
          stop
        endif
670
      endif
671

672
#else
673
      call self%set("process_row", 0, error)
674
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
675
      call self%set("process_col", 0, error)
676
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
677
      call self%set("process_id", 0, error)
678
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
679
      call self%set("is_process_id_zero", 1, error)
680
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
681
      call self%set("num_process_rows", 1, error)
682
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
683
      call self%set("num_process_cols", 1, error)
684
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
685
      call self%set("num_processes", 1, error)
686
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
687
#endif
688

689
    end function
690

Andreas Marek's avatar
Andreas Marek committed
691

692 693 694 695 696 697
    !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> */
698
    !c> int elpa_setup(elpa_t handle);
699
    function elpa_setup_c(handle) result(error) bind(C, name="elpa_setup")
700 701 702 703 704 705 706 707
      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

708
    function elpa_construct_scalapack_descriptor(self, sc_desc, rectangular_for_ev) result(error)
709
      class(elpa_impl_t), intent(inout)   :: self
710
      logical, intent(in)                 :: rectangular_for_ev
711 712 713 714 715 716 717 718 719
      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)
720
      if (check_elpa_get(error, ELPA_ERROR_CRITICAL)) return
721 722 723 724

      sc_desc(1) = 1
      sc_desc(2) = blacs_ctx
      sc_desc(3) = self%na
725
      if (rectangular_for_ev) then
726 727 728 729
        sc_desc(4) = self%nev
      else
        sc_desc(4) = self%na
      endif
730 731 732 733 734 735 736 737 738 739
      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
740

Andreas Marek's avatar
Andreas Marek committed
741

742 743 744 745 746 747 748 749 750
    !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> */
751
    !c> void elpa_set_integer(elpa_t handle, const char *name, int value, int *error);
752
    subroutine elpa_set_integer_c(handle, name_p, value, error) bind(C, name="elpa_set_integer")
Andreas Marek's avatar
Andreas Marek committed
753 754 755
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
756
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
757 758
      integer(kind=c_int), intent(in), value        :: value
      integer(kind=c_int) , intent(in)              :: error
759 760 761 762 763 764 765

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


766 767 768 769 770 771 772 773 774
    !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> */
775 776
    !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
777 778 779
      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
780
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
781 782
      integer(kind=c_int)                           :: value
      integer(kind=c_int), intent(inout)            :: error
783
 
Andreas Marek's avatar
Andreas Marek committed
784 785
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
786 787
      call elpa_get_integer(self, name, value, error)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
788 789


790 791 792 793 794
    !> \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
795 796
    function elpa_is_set(self, name) result(state)
      class(elpa_impl_t)       :: self
797
      character(*), intent(in) :: name
798
      integer                  :: state
799

800
      state = elpa_index_value_is_set_c(self%index, name // c_null_char)
801 802
    end function

803 804 805 806 807 808
    !> \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
809 810 811 812 813 814 815 816 817 818
    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


819 820 821 822 823 824
    !> \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   
825
    function elpa_value_to_string(self, option_name, error) result(string)
826 827
      class(elpa_impl_t), intent(in) :: self
      character(kind=c_char, len=*), intent(in) :: option_name
828 829 830 831
      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
832

833 834
      nullify(string)

835
      call self%get(option_name, val, actual_error)
836 837 838 839 840
      if (actual_error /= ELPA_OK) then
        if (present(error)) then
          error = actual_error
        endif
        return
841 842
      endif

843 844 845 846
      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
847

848 849 850 851
      if (present(error)) then
        error = actual_error
      endif
    end function
852

Andreas Marek's avatar
Andreas Marek committed
853

854 855 856 857 858 859 860 861 862
    !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> */
863
    !c> void elpa_set_double(elpa_t handle, const char *name, double value, int *error);
864
    subroutine elpa_set_double_c(handle, name_p, value, error) bind(C, name="elpa_set_double")
Andreas Marek's avatar
Andreas Marek committed
865 866 867
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
868
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
869 870
      real(kind=c_double), intent(in), value        :: value
      integer(kind=c_int), intent(in)               :: error
871

872 873 874 875 876
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
      call elpa_set_double(self, name, value, error)
    end subroutine

877

878
    !c> /*! \brief C interface for the implementation of the elpa_get_double method
879 880 881 882 883 884 885 886
    !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> */
887 888
    !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
889 890 891
      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
892
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
893 894
      real(kind=c_double)                           :: value
      integer(kind=c_int), intent(inout)            :: error
895

Andreas Marek's avatar
Andreas Marek committed
896 897
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
898 899
      call elpa_get_double(self, name, value, error)
    end subroutine
900
 
Andreas Marek's avatar
Andreas Marek committed
901

902 903 904 905 906
    !> \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
907
    function elpa_associate_int(self, name) result(value)
908
      class(elpa_impl_t)             :: self
909 910
      character(*), intent(in)       :: name
      integer(kind=c_int), pointer   :: value
Andreas Marek's avatar
Andreas Marek committed
911

912 913
      type(c_ptr)                    :: value_p

914
      value_p = elpa_index_get_int_loc_c(self%index, name // c_null_char)
915 916 917
      if (.not. c_associated(value_p)) then
        write(error_unit, '(a,a,a)') "ELPA: Warning, received NULL pointer for entry '", name, "'"
      endif
918 919
      call c_f_pointer(value_p, value)
    end function
Andreas Marek's avatar
Andreas Marek committed
920

921

922 923 924 925 926 927 928
    !> \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
929 930 931 932 933 934
    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

935
#ifdef HAVE_DETAILED_TIMINGS
936
      s = self%timer%get(name1, name2, name3, name4, name5, name6)
937 938 939
#else
      s = -1.0
#endif
940 941 942
    end function


943 944 945 946 947
    !> \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
948
    subroutine elpa_print_times(self, name1, name2, name3, name4)
949
      class(elpa_impl_t), intent(in) :: self
950
      character(len=*), intent(in), optional :: name1, name2, name3, name4
951
#ifdef HAVE_DETAILED_TIMINGS
952
      call self%timer%print(name1, name2, name3, name4)
953
#endif
954 955
    end subroutine

956

957 958 959 960
    !> \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
961 962 963 964 965 966 967 968 969
    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


970 971 972 973
    !> \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
974 975 976 977 978 979 980 981 982
    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


983 984 985
    !> \brief function to destroy an elpa object
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
986 987
    !> \param   error           integer, optional error code
    subroutine elpa_destroy(self, error)
988
#ifdef WITH_MPI
989 990 991
      integer                              :: mpi_comm_rows, mpi_comm_cols, &
                                              mpierr, mpierr2, mpi_string_length
      character(len=MPI_MAX_ERROR_STRING)  :: mpierr_string
992
#endif
993 994 995 996 997 998 999 1000 1001 1002 1003
      class(elpa_impl_t)                   :: self
#ifdef USE_FORTRAN2008
      integer, optional, intent(out)       :: error
#else
      integer, intent(out)                 :: error
#endif
      integer                              :: error2

      if (present(error)) then
        error = ELPA_OK
      endif
1004 1005 1006

#ifdef WITH_MPI
      if (self%communicators_owned == 1) then
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
        call self%get("mpi_comm_rows", mpi_comm_rows, error2)
        if (error2 .ne. ELPA_OK) then
          if (present(error)) then
            error = error2
            return
          else
            write(error_unit, *) "Error in elpa_destroy but you do not check the error codes!"
            return
          endif
        endif
        call self%get("mpi_comm_cols", mpi_comm_cols,error2)
        if (error2 .ne. ELPA_OK) then
          if (present(error)) then
            error = error2
            return
          else
            write(error_unit, *) "Error in elpa_destroy but you do not check the error codes!"
            return
          endif
        endif
1027

1028 1029
        ! this is just for debugging ! do not leave in a relase
        !write(error_unit, '(A,2I13)') "FREE comms", mpi_comm_rows, mpi_comm_cols