elpa_impl.F90 65.5 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
Andreas Marek's avatar
Andreas Marek committed
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

Andreas Marek's avatar
Andreas Marek committed
123
     procedure, public :: elpa_hermitian_multiply_d      !< public methods to implement a "hermitian" multiplication of matrices a and b
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_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"
Andreas Marek's avatar
Andreas Marek committed
198
#ifdef USE_FORTRAN2008
199
        if (present(error)) then
200
          error = ELPA_ERROR_API_VERSION
201
        endif
Andreas Marek's avatar
Andreas Marek committed
202 203 204
#else
        error = ELPA_ERROR_API_VERSION
#endif
Andreas Marek's avatar
Andreas Marek committed
205 206
        return
      endif
Andreas Marek's avatar
Andreas Marek committed
207

208
      obj%index = elpa_index_instance_c()
209 210

      ! Associate some important integer pointers for convenience
211 212 213 214 215 216
      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")

Andreas Marek's avatar
Andreas Marek committed
217
#ifdef USE_FORTRAN2008
218
      if (present(error)) then
219
        error = ELPA_OK
220
      endif
Andreas Marek's avatar
Andreas Marek committed
221 222 223
#else
      error = ELPA_OK
#endif
224
    end function
Andreas Marek's avatar
Andreas Marek committed
225

Andreas Marek's avatar
Andreas Marek committed
226

227 228 229 230 231
    !c> /*! \brief C interface for the implementation of the elpa_allocate method
    !c> *
    !c> *  \param  none
    !c> *  \result elpa_t handle
    !c> */
232
    !c> elpa_t elpa_allocate(int *error);
233
    function elpa_impl_allocate_c(error) result(ptr) bind(C, name="elpa_allocate")
234 235 236 237 238 239 240 241
      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
242

243 244 245
    !c> /*! \brief C interface for the implementation of the elpa_deallocate method
    !c> *
    !c> *  \param  elpa_t  handle of ELPA object to be deallocated
246
    !c> *  \param  int*    error code
247 248
    !c> *  \result void
    !c> */
249 250 251
    !c> void elpa_deallocate(elpa_t handle, int *error);
    subroutine elpa_impl_deallocate_c(handle, error) bind(C, name="elpa_deallocate")
      type(c_ptr), value         :: handle
252
      type(elpa_impl_t), pointer :: self
253
      integer(kind=c_int)        :: error
254 255

      call c_f_pointer(handle, self)
256
      call self%destroy(error)
257 258 259
      deallocate(self)
    end subroutine

260 261 262 263 264 265 266 267 268 269 270 271 272 273
    !> \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
Andreas Marek's avatar
Andreas Marek committed
274 275

#ifdef USE_FORTRAN2008
276 277 278
      if (present(error)) then
        error = ELPA_OK
      endif
Andreas Marek's avatar
Andreas Marek committed
279 280 281
#else
      error = ELPA_OK
#endif
282 283
      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())"
Andreas Marek's avatar
Andreas Marek committed
284 285

#ifdef USE_FORTRAN2008
286 287 288
        if (present(error)) then
          error = ELPA_ERROR_CANNOT_OPEN_FILE
        endif
Andreas Marek's avatar
Andreas Marek committed
289 290 291
#else
        error = ELPA_ERROR_CANNOT_OPEN_FILE
#endif
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
      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
Andreas Marek's avatar
Andreas Marek committed
327 328

#ifdef USE_FORTRAN2008
329 330 331
      if (present(error)) then
        error = ELPA_OK
      endif
Andreas Marek's avatar
Andreas Marek committed
332 333 334
#else
      error = ELPA_OK
#endif
335 336
      if (elpa_index_print_settings_c(self%index, c_null_char) /= 1) then
        write(error_unit, *) "This should not happen (in elpa_print_settings())"
Andreas Marek's avatar
Andreas Marek committed
337 338

#ifdef USE_FORTRAN2008
339
        if (present(error)) then
Andreas Marek's avatar
Andreas Marek committed
340
          error = ELPA_ERROR_CRITICAL
341
        endif
Andreas Marek's avatar
Andreas Marek committed
342 343 344
#else
        error = ELPA_ERROR_CRITICAL
#endif
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
      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

Andreas Marek's avatar
Andreas Marek committed
381
#ifdef USE_FORTRAN2008
382 383 384
      if (present(error)) then
        error = ELPA_OK
      endif
Andreas Marek's avatar
Andreas Marek committed
385 386 387
#else
      error = ELPA_OK
#endif
388 389
      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())"
Andreas Marek's avatar
Andreas Marek committed
390 391

#ifdef USE_FORTRAN2008
392 393 394
        if (present(error)) then
          error = ELPA_ERROR_CANNOT_OPEN_FILE
        endif
Andreas Marek's avatar
Andreas Marek committed
395 396 397
#else
        error = ELPA_ERROR_CANNOT_OPEN_FILE
#endif
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
      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
424

Andreas Marek's avatar
Andreas Marek committed
425
#ifdef ENABLE_AUTOTUNING
426 427 428 429 430
    !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> */
431
    !c> void elpa_autotune_deallocate(elpa_autotune_t handle, int *error);
432 433
    subroutine elpa_autotune_impl_deallocate_c( autotune_handle) bind(C, name="elpa_autotune_deallocate")
      type(c_ptr), value                  :: autotune_handle
434

435
      type(elpa_autotune_impl_t), pointer :: self
Andreas Marek's avatar
Andreas Marek committed
436
      integer(kind=c_int)                 :: error
437 438

      call c_f_pointer(autotune_handle, self)
Andreas Marek's avatar
Andreas Marek committed
439
      call self%destroy(error)
440 441
      deallocate(self)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
442
#endif
443

444 445 446 447
    !> \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
448
    function elpa_setup(self) result(error)
449 450
      class(elpa_impl_t), intent(inout)   :: self
      integer                             :: error, timings
451

452
#ifdef WITH_MPI
453 454 455
      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
456
      character(len=MPI_MAX_ERROR_STRING) :: mpierr_string
457 458 459
      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..."

460
#endif
461

462
#ifdef HAVE_DETAILED_TIMINGS
Andreas Marek's avatar
Andreas Marek committed
463
      call self%get("timings",timings, error)
464
      if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
465 466 467 468 469 470
      if (timings == 1) then
        call self%timer%enable()
      endif
#endif

      error = ELPA_OK
471

472 473 474 475 476 477 478 479
      ! 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

480
#ifdef WITH_MPI
481
      if (self%is_set("legacy_api") == 1) then
482
        call self%get("legacy_api", legacy_api, error)
483
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
484
      endif
485

486
      if (self%is_set("mpi_comm_parent") == 1) then
Andreas Marek's avatar
Andreas Marek committed
487
        call self%get("mpi_comm_parent", mpi_comm_parent, error)
488
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
489 490 491

        call mpi_comm_rank(mpi_comm_parent, my_id, mpierr)
        call self%set("process_id", my_id, error)
492
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
493 494 495

        call mpi_comm_size(mpi_comm_parent, np_total, mpierr)
        call self%set("num_processes", np_total, error)
496
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
497 498

        is_process_id_zero = 0
499
        if (my_id == 0) &
500 501
          is_process_id_zero = 1
        call self%set("is_process_id_zero", is_process_id_zero, error)
502
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
503 504

      else
505
        if (legacy_api .ne. 1) then
506 507 508 509 510 511 512 513 514
          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

515
        if (self%is_set("mpi_comm_rows") == 1 .or. self%is_set("mpi_comm_cols") == 1) then
516 517 518 519 520
          write(error_unit,*) MPI_CONSISTENCY_MSG
          error = ELPA_ERROR
          return
        endif

Andreas Marek's avatar
Andreas Marek committed
521
        call self%get("process_row", process_row, error)
522
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
523

Andreas Marek's avatar
Andreas Marek committed
524
        call self%get("process_col", process_col, error)
525
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

        ! 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
545

Andreas Marek's avatar
Andreas Marek committed
546
        call self%set("mpi_comm_rows", mpi_comm_rows,error)
547
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
548

549
        call self%set("mpi_comm_cols", mpi_comm_cols,error)
550
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
551

552 553 554
        ! remember that we created those communicators and we need to free them later
        self%communicators_owned = 1

555
      ! Externally supplied communicators
556 557
      else if ( self%is_set("mpi_comm_rows") == 1 .and.  self%is_set("mpi_comm_cols") == 1) then

558
        if (self%is_set("process_row") == 1 .or. self%is_set("process_col") == 1) then
559 560 561
          write(error_unit,*) MPI_CONSISTENCY_MSG
          error = ELPA_ERROR
          return
562
        endif
563 564

        call self%get("mpi_comm_rows", mpi_comm_rows,error)
565
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
566

567
        call self%get("mpi_comm_cols", mpi_comm_cols,error)
568
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
569 570 571

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

574 575
        call mpi_comm_rank(mpi_comm_cols, process_col, mpierr)
        call self%set("process_col", process_col, error)
576
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
577 578

        ! remember that we DID NOT created those communicators and we WILL NOT free them later
579
        self%communicators_owned = 0
580 581 582 583 584 585
      else
        ! Otherwise parameters are missing
        write(error_unit,*) MPI_CONSISTENCY_MSG
        error = ELPA_ERROR
        return
      endif
586

587 588 589 590
      ! 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)
591
      if (self%is_set("num_process_rows") == 1) then
592
        call self%get("num_process_rows", present_np_rows, error)
593
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
594

595
        if (np_rows .ne. present_np_rows) then
596
          print *,"MPI row communicator not set correctly. Aborting..."
597 598
          stop
        endif
599 600
      else
        call self%set("num_process_rows", np_rows, error)
601
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
602 603 604
      endif

      call mpi_comm_size(mpi_comm_cols, np_cols, mpierr)
605
      if (self%is_set("num_process_cols") == 1) then
606
        call self%get("num_process_cols", present_np_cols, error)
607
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
608

609
        if (np_cols .ne. present_np_cols) then
610
          print *,"MPI column communicator not set correctly. Aborting..."
611 612
          stop
        endif
613 614
      else
        call self%set("num_process_cols", np_cols, error)
615
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
616
      endif
617

618 619
      if (legacy_api .ne. 1) then
        if (np_total .ne. np_rows * np_cols) then
620 621 622
          print *,"MPI parent communicator and row/col communicators do not match. Aborting..."
          stop
        endif
623
      endif
624

625
#else
626
      call self%set("process_row", 0, error)
627
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
628
      call self%set("process_col", 0, error)
629
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
630
      call self%set("process_id", 0, error)
631
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
632
      call self%set("is_process_id_zero", 1, error)
633
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
634
      call self%set("num_process_rows", 1, error)
635
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
636
      call self%set("num_process_cols", 1, error)
637
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
638
      call self%set("num_processes", 1, error)
639
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
640
#endif
641

642
    end function
643

Andreas Marek's avatar
Andreas Marek committed
644

645 646 647 648 649 650
    !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> */
651
    !c> int elpa_setup(elpa_t handle);
652
    function elpa_setup_c(handle) result(error) bind(C, name="elpa_setup")
653 654 655 656 657 658 659 660
      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

661
    function elpa_construct_scalapack_descriptor(self, sc_desc, rectangular_for_ev) result(error)
662
      class(elpa_impl_t), intent(inout)   :: self
663
      logical, intent(in)                 :: rectangular_for_ev
664 665 666 667 668 669 670 671 672
      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)
673
      if (check_elpa_get(error, ELPA_ERROR_CRITICAL)) return
674 675 676 677

      sc_desc(1) = 1
      sc_desc(2) = blacs_ctx
      sc_desc(3) = self%na
678
      if (rectangular_for_ev) then
679 680 681 682
        sc_desc(4) = self%nev
      else
        sc_desc(4) = self%na
      endif
683 684 685 686 687 688 689 690 691 692
      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
693

Andreas Marek's avatar
Andreas Marek committed
694

695 696 697 698 699 700 701 702 703
    !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> */
704
    !c> void elpa_set_integer(elpa_t handle, const char *name, int value, int *error);
705
    subroutine elpa_set_integer_c(handle, name_p, value, error) bind(C, name="elpa_set_integer")
Andreas Marek's avatar
Andreas Marek committed
706 707 708
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
709
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
710 711
      integer(kind=c_int), intent(in), value        :: value
      integer(kind=c_int) , intent(in)              :: error
712 713 714 715 716 717 718

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


719 720 721 722 723 724 725 726 727
    !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> */
728 729
    !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
730 731 732
      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
733
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
734 735
      integer(kind=c_int)                           :: value
      integer(kind=c_int), intent(inout)            :: error
736
 
Andreas Marek's avatar
Andreas Marek committed
737 738
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
739 740
      call elpa_get_integer(self, name, value, error)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
741 742


743 744 745 746 747
    !> \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
748 749
    function elpa_is_set(self, name) result(state)
      class(elpa_impl_t)       :: self
750
      character(*), intent(in) :: name
751
      integer                  :: state
752

753
      state = elpa_index_value_is_set_c(self%index, name // c_null_char)
754 755
    end function

756 757 758 759 760 761
    !> \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
762 763 764 765 766 767 768 769 770 771
    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


772 773 774 775 776 777
    !> \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   
778
    function elpa_value_to_string(self, option_name, error) result(string)
779 780
      class(elpa_impl_t), intent(in) :: self
      character(kind=c_char, len=*), intent(in) :: option_name
781 782 783 784
      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
785

786 787
      nullify(string)

788
      call self%get(option_name, val, actual_error)
789 790 791 792 793
      if (actual_error /= ELPA_OK) then
        if (present(error)) then
          error = actual_error
        endif
        return
794 795
      endif

796 797 798 799
      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
800

801 802 803 804
      if (present(error)) then
        error = actual_error
      endif
    end function
805

Andreas Marek's avatar
Andreas Marek committed
806

807 808 809 810 811 812 813 814 815
    !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> */
816
    !c> void elpa_set_double(elpa_t handle, const char *name, double value, int *error);
817
    subroutine elpa_set_double_c(handle, name_p, value, error) bind(C, name="elpa_set_double")
Andreas Marek's avatar
Andreas Marek committed
818 819 820
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
821
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
822 823
      real(kind=c_double), intent(in), value        :: value
      integer(kind=c_int), intent(in)               :: error
824

825 826 827 828 829
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
      call elpa_set_double(self, name, value, error)
    end subroutine

830

831
    !c> /*! \brief C interface for the implementation of the elpa_get_double method
832 833 834 835 836 837 838 839
    !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> */
840 841
    !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
842 843 844
      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
845
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
846 847
      real(kind=c_double)                           :: value
      integer(kind=c_int), intent(inout)            :: error
848

Andreas Marek's avatar
Andreas Marek committed
849 850
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
851 852
      call elpa_get_double(self, name, value, error)
    end subroutine
853
 
Andreas Marek's avatar
Andreas Marek committed
854

855 856 857 858 859
    !> \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
860
    function elpa_associate_int(self, name) result(value)
861
      class(elpa_impl_t)             :: self
862 863
      character(*), intent(in)       :: name
      integer(kind=c_int), pointer   :: value
Andreas Marek's avatar
Andreas Marek committed
864

865 866
      type(c_ptr)                    :: value_p

867
      value_p = elpa_index_get_int_loc_c(self%index, name // c_null_char)
868 869 870
      if (.not. c_associated(value_p)) then
        write(error_unit, '(a,a,a)') "ELPA: Warning, received NULL pointer for entry '", name, "'"
      endif
871 872
      call c_f_pointer(value_p, value)
    end function
Andreas Marek's avatar
Andreas Marek committed
873

874

875 876 877 878 879 880 881
    !> \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
882 883 884 885 886 887
    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

888
#ifdef HAVE_DETAILED_TIMINGS
889
      s = self%timer%get(name1, name2, name3, name4, name5, name6)
890 891 892
#else
      s = -1.0
#endif
893 894 895
    end function


896 897 898 899 900
    !> \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
901
    subroutine elpa_print_times(self, name1, name2, name3, name4)
902
      class(elpa_impl_t), intent(in) :: self
903
      character(len=*), intent(in), optional :: name1, name2, name3, name4
904
#ifdef HAVE_DETAILED_TIMINGS
905
      call self%timer%print(name1, name2, name3, name4)
906
#endif
907 908
    end subroutine

909

910 911 912 913
    !> \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
914 915 916 917 918 919 920 921 922
    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


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