There is a maintenance of MPCDF Gitlab on Thursday, April 22st 2020, 9:00 am CEST - Expect some service interruptions during this time

elpa_impl.F90 71.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
  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
Pavel Kus's avatar
Pavel Kus committed
59 60 61
#ifdef HAVE_LIKWID
  use likwid
#endif
62

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

71 72
  private
  public :: elpa_impl_allocate
73

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

Pavel Kus's avatar
Pavel Kus committed
79 80 81
   !This object has been created through the legacy api.
   integer :: from_legacy_api

82
   !> \brief methods available with the elpa_impl_t type
83
   contains
84
     !> \brief the puplic methods
85
     ! con-/destructor
86 87
     procedure, public :: setup => elpa_setup                   !< a setup method: implemented in elpa_setup
     procedure, public :: destroy => elpa_destroy               !< a destroy method: implemented in elpa_destroy
88

89
     ! KV store
Andreas Marek's avatar
Andreas Marek committed
90 91 92 93
     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
94

Pavel Kus's avatar
Pavel Kus committed
95 96 97
     ! call before setup if created from the legacy api
     ! remove this function completely after the legacy api is dropped
     procedure, public :: creating_from_legacy_api => elpa_creating_from_legacy_api
98 99 100 101

     ! timer
     procedure, public :: get_time => elpa_get_time
     procedure, public :: print_times => elpa_print_times
102 103
     procedure, public :: timer_start => elpa_timer_start
     procedure, public :: timer_stop => elpa_timer_stop
104 105


106 107 108 109 110 111 112 113 114 115 116 117 118 119
     !> \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
120 121 122 123 124 125
     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

126 127 128 129 130 131
     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
132
     procedure, public :: elpa_hermitian_multiply_d      !< public methods to implement a "hermitian" multiplication of matrices a and b
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
     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
153

Pavel Kus's avatar
Pavel Kus committed
154
     procedure, private :: elpa_transform_generalized_d
155
     procedure, private :: elpa_transform_back_generalized_d
Pavel Kus's avatar
Pavel Kus committed
156
     procedure, private :: elpa_transform_generalized_dc
157
     procedure, private :: elpa_transform_back_generalized_dc
Pavel Kus's avatar
Pavel Kus committed
158 159
#ifdef WANT_SINGLE_PRECISION_REAL
     procedure, private :: elpa_transform_generalized_f
160
     procedure, private :: elpa_transform_back_generalized_f
Pavel Kus's avatar
Pavel Kus committed
161 162 163
#endif
#ifdef WANT_SINGLE_PRECISION_COMPLEX
     procedure, private :: elpa_transform_generalized_fc
164
     procedure, private :: elpa_transform_back_generalized_fc
Pavel Kus's avatar
Pavel Kus committed
165
#endif
166

167 168
     procedure, public :: print_settings => elpa_print_settings
     procedure, public :: store_settings => elpa_store_settings
Andreas Marek's avatar
Andreas Marek committed
169
     procedure, public :: load_settings => elpa_load_settings
Andreas Marek's avatar
Andreas Marek committed
170
#ifdef ENABLE_AUTOTUNING
171
     procedure, public :: autotune_setup => elpa_autotune_setup
172 173
     procedure, public :: autotune_step => elpa_autotune_step
     procedure, public :: autotune_set_best => elpa_autotune_set_best
174
     procedure, public :: autotune_print_best => elpa_autotune_print_best
Pavel Kus's avatar
Pavel Kus committed
175
     procedure, public :: autotune_print_state => elpa_autotune_print_state
176
     procedure, public :: autotune_save_state => elpa_autotune_save_state
177
     procedure, public :: autotune_load_state => elpa_autotune_load_state
Andreas Marek's avatar
Andreas Marek committed
178
#endif
179
     procedure, private :: construct_scalapack_descriptor => elpa_construct_scalapack_descriptor
180
  end type elpa_impl_t
181 182

  !> \brief the implementation of the generic methods
183
  contains
184 185


186 187 188 189
    !> \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
190
    function elpa_impl_allocate(error) result(obj)
191 192 193 194 195 196
      type(elpa_impl_t), pointer     :: obj
#ifdef USE_FORTRAN2008
      integer, optional, intent(out) :: error
#else
      integer, intent(out)           :: error
#endif
197
      integer                        :: error2, output_build_config
198

199 200 201
      allocate(obj, stat=error2)
      if (error2 .ne. 0) then
        write(error_unit, *) "elpa_allocate(): could not allocate object"
Pavel Kus's avatar
Pavel Kus committed
202 203 204
      endif

      obj%from_legacy_api = 0
Andreas Marek's avatar
Andreas Marek committed
205

Andreas Marek's avatar
Andreas Marek committed
206
      ! check whether init has ever been called
207
      if ( elpa_initialized() .ne. ELPA_OK) then
208
        write(error_unit, *) "elpa_allocate(): you must call elpa_init() once before creating instances of ELPA"
Andreas Marek's avatar
Andreas Marek committed
209
#ifdef USE_FORTRAN2008
210
        if (present(error)) then
211
          error = ELPA_ERROR_API_VERSION
212
        endif
Andreas Marek's avatar
Andreas Marek committed
213 214 215
#else
        error = ELPA_ERROR_API_VERSION
#endif
Andreas Marek's avatar
Andreas Marek committed
216 217
        return
      endif
Andreas Marek's avatar
Andreas Marek committed
218

219
      obj%index = elpa_index_instance_c()
220 221

      ! Associate some important integer pointers for convenience
222 223 224 225 226 227
      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
228
#ifdef USE_FORTRAN2008
229
      if (present(error)) then
230
        error = ELPA_OK
231
      endif
Andreas Marek's avatar
Andreas Marek committed
232 233 234
#else
      error = ELPA_OK
#endif
235
    end function
Andreas Marek's avatar
Andreas Marek committed
236

Andreas Marek's avatar
Andreas Marek committed
237 238 239 240 241
#ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c_o> #ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c_o> #define elpa_allocate(...) CONC(elpa_allocate, NARGS(__VA_ARGS__))(__VA_ARGS__)
    !c_o> #endif
#endif
242 243 244 245 246
    !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
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
#ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c_o> #ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c_o> elpa_t elpa_allocate2(int *error);
    !c_o> elpa_t elpa_allocate1();
    !c_o> #endif
    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
263 264 265 266 267
      type(elpa_impl_t), pointer :: obj

      obj => elpa_impl_allocate(error)
      ptr = c_loc(obj)
    end function
Andreas Marek's avatar
Andreas Marek committed
268 269 270 271 272 273 274 275
#else
    !c_no> #ifndef OPTIONAL_C_ERROR_ARGUMENT
    !c_no> elpa_t elpa_allocate(int *error);
    !c_no> #endif
    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
276

Andreas Marek's avatar
Andreas Marek committed
277 278 279 280
      obj => elpa_impl_allocate(error)
      ptr = c_loc(obj)
    end function
#endif
Andreas Marek's avatar
Andreas Marek committed
281

Andreas Marek's avatar
Andreas Marek committed
282 283 284 285 286 287 288 289 290
#ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c_o> #ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c_o> #define NARGS(...) NARGS_(__VA_ARGS__, 5, 4, 3, 2, 1, 0)
    !c_o> #define NARGS_(_5, _4, _3, _2, _1, N, ...) N
    !c_o> #define CONC(A, B) CONC_(A, B)
    !c_o> #define CONC_(A, B) A##B
    !c_o> #define elpa_deallocate(...) CONC(elpa_deallocate, NARGS(__VA_ARGS__))(__VA_ARGS__)
    !c_o> #endif
#endif
291 292 293
    !c> /*! \brief C interface for the implementation of the elpa_deallocate method
    !c> *
    !c> *  \param  elpa_t  handle of ELPA object to be deallocated
294
    !c> *  \param  int*    error code
295 296
    !c> *  \result void
    !c> */
Andreas Marek's avatar
Andreas Marek committed
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
#ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c_o> #ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c_o> void elpa_deallocate2(elpa_t handle, int *error);
    !c_o> void elpa_deallocate1(elpa_t handle);
    !c_o> #endif
    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
    !c_no> #ifndef OPTIONAL_C_ERROR_ARGUMENT
    !c_no> void elpa_deallocate(elpa_t handle, int *error);
    !c_no> #endif
324 325
    subroutine elpa_impl_deallocate_c(handle, error) bind(C, name="elpa_deallocate")
      type(c_ptr), value         :: handle
326
      type(elpa_impl_t), pointer :: self
327
      integer(kind=c_int)        :: error
328 329

      call c_f_pointer(handle, self)
330
      call self%destroy(error)
331 332 333
      deallocate(self)
    end subroutine

Andreas Marek's avatar
Andreas Marek committed
334 335
#endif

336 337 338 339 340 341 342 343 344 345 346 347 348 349
    !> \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
350 351

#ifdef USE_FORTRAN2008
352 353 354
      if (present(error)) then
        error = ELPA_OK
      endif
Andreas Marek's avatar
Andreas Marek committed
355 356 357
#else
      error = ELPA_OK
#endif
358 359
      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
360 361

#ifdef USE_FORTRAN2008
362 363 364
        if (present(error)) then
          error = ELPA_ERROR_CANNOT_OPEN_FILE
        endif
Andreas Marek's avatar
Andreas Marek committed
365 366 367
#else
        error = ELPA_ERROR_CANNOT_OPEN_FILE
#endif
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
      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
403 404

#ifdef USE_FORTRAN2008
405 406 407
      if (present(error)) then
        error = ELPA_OK
      endif
Andreas Marek's avatar
Andreas Marek committed
408 409 410
#else
      error = ELPA_OK
#endif
411 412
      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
413 414

#ifdef USE_FORTRAN2008
415
        if (present(error)) then
Andreas Marek's avatar
Andreas Marek committed
416
          error = ELPA_ERROR_CRITICAL
417
        endif
Andreas Marek's avatar
Andreas Marek committed
418 419 420
#else
        error = ELPA_ERROR_CRITICAL
#endif
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
      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
457
#ifdef USE_FORTRAN2008
458 459 460
      if (present(error)) then
        error = ELPA_OK
      endif
Andreas Marek's avatar
Andreas Marek committed
461 462 463
#else
      error = ELPA_OK
#endif
464 465
      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
466 467

#ifdef USE_FORTRAN2008
468 469 470
        if (present(error)) then
          error = ELPA_ERROR_CANNOT_OPEN_FILE
        endif
Andreas Marek's avatar
Andreas Marek committed
471 472 473
#else
        error = ELPA_ERROR_CANNOT_OPEN_FILE
#endif
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
      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
498
#ifdef ENABLE_AUTOTUNING
Andreas Marek's avatar
Andreas Marek committed
499 500 501 502 503
#ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c_o> #ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c_o> #define elpa_autotune_deallocate(...) CONC(elpa_autotune_deallocate, NARGS(__VA_ARGS__))(__VA_ARGS__)
    !c_o> #endif
#endif
504 505 506 507 508
    !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
509 510 511 512 513 514
#ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c_o> #ifdef OPTIONAL_C_ERROR_ARGUMENT
    !c_o> void elpa_autotune_deallocate2(elpa_autotune_t handle, int *error);
    !c_o> void elpa_autotune_deallocate1(elpa_autotune_t handle);
    !c_o> #endif
    subroutine elpa_autotune_impl_deallocate_c1( autotune_handle) bind(C, name="elpa_autotune_deallocate1")
515
      type(c_ptr), value                  :: autotune_handle
516

517
      type(elpa_autotune_impl_t), pointer :: self
518
      integer(kind=c_int)                 :: error
519 520

      call c_f_pointer(autotune_handle, self)
521
      call self%destroy(error)
522 523
      deallocate(self)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
524 525

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

528
      type(elpa_autotune_impl_t), pointer :: self
Andreas Marek's avatar
Andreas Marek committed
529
      integer(kind=c_int)                 :: error
Andreas Marek's avatar
Andreas Marek committed
530 531 532 533 534 535 536 537 538 539
      call c_f_pointer(autotune_handle, self)
      call self%destroy(error)
      deallocate(self)
    end subroutine
#else
    !c_no> #ifndef OPTIONAL_C_ERROR_ARGUMENT
    !c_no> void elpa_autotune_deallocate(elpa_autotune_t handle, int *error);
    !c_no> #endif
    subroutine elpa_autotune_impl_deallocate( autotune_handle, error) bind(C, name="elpa_autotune_deallocate")
      type(c_ptr), value                  :: autotune_handle
540

Andreas Marek's avatar
Andreas Marek committed
541 542
      type(elpa_autotune_impl_t), pointer :: self
      integer(kind=c_int)                 :: error
543
      call c_f_pointer(autotune_handle, self)
Andreas Marek's avatar
Andreas Marek committed
544
      call self%destroy(error)
545 546
      deallocate(self)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
547

Andreas Marek's avatar
Andreas Marek committed
548
#endif
Andreas Marek's avatar
Andreas Marek committed
549
#endif /* ENABLE_AUTOTUNING */
550

551 552 553 554
    !> \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
555
    function elpa_setup(self) result(error)
556
      class(elpa_impl_t), intent(inout)   :: self
557
      integer                             :: error, timings, performance, build_config
558

559
#ifdef WITH_MPI
560
      integer                             :: mpi_comm_parent, mpi_comm_rows, mpi_comm_cols, np_rows, np_cols, my_id, &
561
                                             process_row, process_col, mpi_string_length, &
Pavel Kus's avatar
Pavel Kus committed
562
                                             present_np_rows, present_np_cols, np_total
563 564
      integer(kind=MPI_KIND)              :: mpierr, mpierr2, my_idMPI, np_totalMPI, process_rowMPI, process_colMPI
      integer(kind=MPI_KIND)              :: mpi_comm_rowsMPI, mpi_comm_colsMPI, np_rowsMPI, np_colsMPI
565
      character(len=MPI_MAX_ERROR_STRING) :: mpierr_string
566 567 568
      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..."

569
#endif
570

571

Pavel Kus's avatar
Pavel Kus committed
572 573 574 575 576 577 578
#ifdef HAVE_LIKWID
      !initialize likwid
      call likwid_markerInit()
      call likwid_markerThreadInit()
      call likwid_markerStartRegion("TOTAL")
#endif

579
#ifdef HAVE_DETAILED_TIMINGS
Andreas Marek's avatar
Andreas Marek committed
580
      call self%get("timings",timings, error)
Andreas Marek's avatar
Andreas Marek committed
581
      call self%get("measure_performance",performance, error)
582
      if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
583 584
      if (timings == 1) then
        call self%timer%enable()
Andreas Marek's avatar
Andreas Marek committed
585 586
        if (performance == 1) then
          call self%timer%measure_flops(.true.)
Andreas Marek's avatar
Andreas Marek committed
587
          call self%timer%set_print_options(print_flop_count=.true.,print_flop_rate=.true.)
Andreas Marek's avatar
Andreas Marek committed
588
        endif
589 590 591 592
      endif
#endif

      error = ELPA_OK
593

594 595 596 597 598 599 600 601
      ! 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

602
#ifdef WITH_MPI
603
      if (self%is_set("mpi_comm_parent") == 1) then
Andreas Marek's avatar
Andreas Marek committed
604
        call self%get("mpi_comm_parent", mpi_comm_parent, error)
605
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
606

607 608
        call mpi_comm_rank(int(mpi_comm_parent,kind=MPI_KIND), my_idMPI, mpierr)
        my_id = int(my_idMPI, kind=c_int)
609
        call self%set("process_id", my_id, error)
610
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
611

612 613
        call mpi_comm_size(int(mpi_comm_parent,kind=MPI_KIND), np_totalMPI, mpierr)
        np_total = int(np_totalMPI,kind=c_int)
614
        call self%set("num_processes", np_total, error)
615
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
616
      else
Pavel Kus's avatar
Pavel Kus committed
617
        if (self%from_legacy_api .ne. 1) then
618 619 620 621 622 623 624 625 626
          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

627
        if (self%is_set("mpi_comm_rows") == 1 .or. self%is_set("mpi_comm_cols") == 1) then
628 629 630 631 632
          write(error_unit,*) MPI_CONSISTENCY_MSG
          error = ELPA_ERROR
          return
        endif

Andreas Marek's avatar
Andreas Marek committed
633
        call self%get("process_row", process_row, error)
634
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
635

Andreas Marek's avatar
Andreas Marek committed
636
        call self%get("process_col", process_col, error)
637
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
638 639 640 641 642 643

        ! 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

644 645 646
        call mpi_comm_split(int(mpi_comm_parent,kind=MPI_KIND), int(process_col,kind=MPI_KIND), &
                            int(process_row,kind=MPI_KIND), mpi_comm_rowsMPI, mpierr)
        mpi_comm_rows = int(mpi_comm_rowsMPI,kind=c_int)
647
        if (mpierr .ne. MPI_SUCCESS) then
648
          call MPI_ERROR_STRING(mpierr, mpierr_string, int(mpi_string_length,kind=MPI_KIND), mpierr2)
649 650 651 652
          write(error_unit,*) "MPI ERROR occured during mpi_comm_split for row communicator: ", trim(mpierr_string)
          return
        endif

653 654 655
        call mpi_comm_split(int(mpi_comm_parent,kind=MPI_KIND), int(process_row,kind=MPI_KIND), &
                            int(process_col,kind=MPI_KIND), mpi_comm_colsMPI, mpierr)
        mpi_comm_cols = int(mpi_comm_colsMPI,kind=c_int)
656
        if (mpierr .ne. MPI_SUCCESS) then
657
          call MPI_ERROR_STRING(mpierr, mpierr_string, int(mpi_string_length,kind=MPI_KIND), mpierr2)
658 659 660
          write(error_unit,*) "MPI ERROR occured during mpi_comm_split for col communicator: ", trim(mpierr_string)
          return
        endif
661

Andreas Marek's avatar
Andreas Marek committed
662
        call self%set("mpi_comm_rows", mpi_comm_rows,error)
663
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
664

665
        call self%set("mpi_comm_cols", mpi_comm_cols,error)
666
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
667

668 669 670
        ! remember that we created those communicators and we need to free them later
        self%communicators_owned = 1

671
      ! Externally supplied communicators
672 673
      else if ( self%is_set("mpi_comm_rows") == 1 .and.  self%is_set("mpi_comm_cols") == 1) then

674
        if (self%is_set("process_row") == 1 .or. self%is_set("process_col") == 1) then
675 676 677
          write(error_unit,*) MPI_CONSISTENCY_MSG
          error = ELPA_ERROR
          return
678
        endif
679 680

        call self%get("mpi_comm_rows", mpi_comm_rows,error)
681
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
682

683
        call self%get("mpi_comm_cols", mpi_comm_cols,error)
684
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
685

686 687 688
        process_rowMPI = int(process_row,kind=c_int)
        call mpi_comm_rank(int(mpi_comm_rows,kind=MPI_KIND), process_rowMPI, mpierr)
        process_row = int(process_rowMPI,kind=MPI_KIND)
689
        call self%set("process_row", process_row, error)
690
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
691

692 693 694
        process_colMPI = int(process_col,kind=c_int)
        call mpi_comm_rank(int(mpi_comm_cols,kind=MPI_KIND), process_colMPI, mpierr)
        process_col = int(process_colMPI,kind=MPI_KIND)
695
        call self%set("process_col", process_col, error)
696
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
697 698

        ! remember that we DID NOT created those communicators and we WILL NOT free them later
699
        self%communicators_owned = 0
700 701 702 703 704 705
      else
        ! Otherwise parameters are missing
        write(error_unit,*) MPI_CONSISTENCY_MSG
        error = ELPA_ERROR
        return
      endif
706

707 708 709
      ! 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?
710 711
      call mpi_comm_size(int(mpi_comm_rows,kind=MPI_KIND), np_rowsMPI, mpierr)
      np_rows = int(np_rowsMPI, kind=c_int)
712
      if (self%is_set("num_process_rows") == 1) then
713
        call self%get("num_process_rows", present_np_rows, error)
714
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
715

716
        if (np_rows .ne. present_np_rows) then
717
          print *,"MPI row communicator not set correctly. Aborting..."
718 719
          stop
        endif
720 721
      else
        call self%set("num_process_rows", np_rows, error)
722
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
723 724
      endif

725 726
      call mpi_comm_size(int(mpi_comm_cols,kind=MPI_KIND), np_colsMPI, mpierr)
      np_cols = int(np_colsMPI, kind=c_int)
727
      if (self%is_set("num_process_cols") == 1) then
728
        call self%get("num_process_cols", present_np_cols, error)
729
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
730

731
        if (np_cols .ne. present_np_cols) then
732
          print *,"MPI column communicator not set correctly. Aborting..."
733 734
          stop
        endif
735 736
      else
        call self%set("num_process_cols", np_cols, error)
737
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
738
      endif
739

Pavel Kus's avatar
Pavel Kus committed
740
      if (self%from_legacy_api .ne. 1) then
741
        if (np_total .ne. np_rows * np_cols) then
742 743 744
          print *,"MPI parent communicator and row/col communicators do not match. Aborting..."
          stop
        endif
745
      endif
746

747
#else
748
      call self%set("process_row", 0, error)
749
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
750
      call self%set("process_col", 0, error)
751
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
752
      call self%set("process_id", 0, error)
753
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
754
      call self%set("num_process_rows", 1, error)
755
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
756
      call self%set("num_process_cols", 1, error)
757
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
758
      call self%set("num_processes", 1, error)
759
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
760
#endif
761

762 763 764 765 766 767 768 769 770 771 772 773
#if STORE_BUILD_CONFIG
      call self%get("output_build_config",build_config, error)
      if ( build_config .eq. 1) then
#ifdef WITH_MPI
        if (my_id .eq. 0) then
#endif
          call print_build_config()
#ifdef WITH_MPI
        endif
#endif
      endif
#endif
774
    end function
775

Andreas Marek's avatar
Andreas Marek committed
776

777 778 779 780 781 782
    !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> */
783
    !c> int elpa_setup(elpa_t handle);
784
    function elpa_setup_c(handle) result(error) bind(C, name="elpa_setup")
785 786 787 788 789 790 791 792
      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

793
    function elpa_construct_scalapack_descriptor(self, sc_desc, rectangular_for_ev) result(error)
794
      class(elpa_impl_t), intent(inout)   :: self
795
      logical, intent(in)                 :: rectangular_for_ev
796 797 798 799 800 801 802 803 804
      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)
805
      if (check_elpa_get(error, ELPA_ERROR_CRITICAL)) return
806 807 808 809

      sc_desc(1) = 1
      sc_desc(2) = blacs_ctx
      sc_desc(3) = self%na
810
      if (rectangular_for_ev) then
811 812 813 814
        sc_desc(4) = self%nev
      else
        sc_desc(4) = self%na
      endif
815 816 817 818 819 820 821 822 823 824
      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
825

Andreas Marek's avatar
Andreas Marek committed
826

827 828 829 830 831 832 833 834 835
    !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> */
836
    !c> void elpa_set_integer(elpa_t handle, const char *name, int value, int *error);
837
    subroutine elpa_set_integer_c(handle, name_p, value, error) bind(C, name="elpa_set_integer")
Andreas Marek's avatar
Andreas Marek committed
838 839 840
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
841
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
842 843
      integer(kind=c_int), intent(in), value        :: value
      integer(kind=c_int) , intent(in)              :: error
844 845 846 847 848 849 850

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


851 852 853 854 855 856 857 858 859
    !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> */
860 861
    !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
862 863 864
      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
865
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
866 867
      integer(kind=c_int)                           :: value
      integer(kind=c_int), intent(inout)            :: error
868
 
Andreas Marek's avatar
Andreas Marek committed
869 870
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
871 872
      call elpa_get_integer(self, name, value, error)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
873 874


875 876 877 878 879
    !> \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
880 881
    function elpa_is_set(self, name) result(state)
      class(elpa_impl_t)       :: self
882
      character(*), intent(in) :: name
883
      integer                  :: state
884

885
      state = elpa_index_value_is_set_c(self%index, name // c_null_char)
886 887
    end function

888 889 890 891 892 893
    !> \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
894 895 896 897 898 899 900 901 902 903
    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


904 905 906 907 908 909
    !> \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   
910
    function elpa_value_to_string(self, option_name, error) result(string)
911 912
      class(elpa_impl_t), intent(in) :: self
      character(kind=c_char, len=*), intent(in) :: option_name
913
      type(c_ptr) :: ptr
Andreas Marek's avatar
Andreas Marek committed
914
#ifdef USE_FORTRAN2008
915
      integer, intent(out), optional :: error
Andreas Marek's avatar
Andreas Marek committed
916 917 918 919
#else
      integer, intent(out)           :: error
#endif

920 921
      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
922

923 924
      nullify(string)

925
      call self%get(option_name, val, actual_error)
926
      if (actual_error /= ELPA_OK) then
Andreas Marek's avatar
Andreas Marek committed
927
#ifdef USE_FORTRAN2008
928 929 930
        if (present(error)) then
          error = actual_error
        endif
Andreas Marek's avatar
Andreas Marek committed
931 932 933
#else
          error = actual_error
#endif
934
        return
935 936
      endif

937 938 939 940
      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
941

Andreas Marek's avatar
Andreas Marek committed
942
#ifdef USE_FORTRAN2008