elpa_impl.F90 72.2 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

Andreas Marek's avatar
Andreas Marek committed
120 121 122 123 124 125 126 127 128
     procedure, public :: elpa_skew_eigenvectors_d             !< public methods to implement the solve step for real skew-symmetric
                                                               !< double/single matrices
     procedure, public :: elpa_skew_eigenvectors_f

     procedure, public :: elpa_skew_eigenvalues_d              !< public methods to implement the solve step for real skew-symmetric
                                                               !< double/single matrices; only the eigenvalues are computed
     procedure, public :: elpa_skew_eigenvalues_f


Pavel Kus's avatar
Pavel Kus committed
129 130 131 132 133 134
     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

135 136 137 138 139 140
     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
141
     procedure, public :: elpa_hermitian_multiply_d      !< public methods to implement a "hermitian" multiplication of matrices a and b
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
     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
162

Pavel Kus's avatar
Pavel Kus committed
163
     procedure, private :: elpa_transform_generalized_d
164
     procedure, private :: elpa_transform_back_generalized_d
Pavel Kus's avatar
Pavel Kus committed
165
     procedure, private :: elpa_transform_generalized_dc
166
     procedure, private :: elpa_transform_back_generalized_dc
Pavel Kus's avatar
Pavel Kus committed
167 168
#ifdef WANT_SINGLE_PRECISION_REAL
     procedure, private :: elpa_transform_generalized_f
169
     procedure, private :: elpa_transform_back_generalized_f
Pavel Kus's avatar
Pavel Kus committed
170 171 172
#endif
#ifdef WANT_SINGLE_PRECISION_COMPLEX
     procedure, private :: elpa_transform_generalized_fc
173
     procedure, private :: elpa_transform_back_generalized_fc
Pavel Kus's avatar
Pavel Kus committed
174
#endif
175

176 177
     procedure, public :: print_settings => elpa_print_settings
     procedure, public :: store_settings => elpa_store_settings
Andreas Marek's avatar
Andreas Marek committed
178
     procedure, public :: load_settings => elpa_load_settings
Andreas Marek's avatar
Andreas Marek committed
179
#ifdef ENABLE_AUTOTUNING
180
     procedure, public :: autotune_setup => elpa_autotune_setup
181 182
     procedure, public :: autotune_step => elpa_autotune_step
     procedure, public :: autotune_set_best => elpa_autotune_set_best
183
     procedure, public :: autotune_print_best => elpa_autotune_print_best
Pavel Kus's avatar
Pavel Kus committed
184
     procedure, public :: autotune_print_state => elpa_autotune_print_state
185
     procedure, public :: autotune_save_state => elpa_autotune_save_state
186
     procedure, public :: autotune_load_state => elpa_autotune_load_state
Andreas Marek's avatar
Andreas Marek committed
187
#endif
188
     procedure, private :: construct_scalapack_descriptor => elpa_construct_scalapack_descriptor
189
  end type elpa_impl_t
190 191

  !> \brief the implementation of the generic methods
192
  contains
193 194


195 196 197 198
    !> \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
199
    function elpa_impl_allocate(error) result(obj)
200 201 202 203 204 205
      type(elpa_impl_t), pointer     :: obj
#ifdef USE_FORTRAN2008
      integer, optional, intent(out) :: error
#else
      integer, intent(out)           :: error
#endif
206
      integer                        :: error2, output_build_config
207

208 209 210
      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
211 212 213
      endif

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

Andreas Marek's avatar
Andreas Marek committed
215
      ! check whether init has ever been called
216
      if ( elpa_initialized() .ne. ELPA_OK) then
217
        write(error_unit, *) "elpa_allocate(): you must call elpa_init() once before creating instances of ELPA"
Andreas Marek's avatar
Andreas Marek committed
218
#ifdef USE_FORTRAN2008
219
        if (present(error)) then
220
          error = ELPA_ERROR_API_VERSION
221
        endif
Andreas Marek's avatar
Andreas Marek committed
222 223 224
#else
        error = ELPA_ERROR_API_VERSION
#endif
Andreas Marek's avatar
Andreas Marek committed
225 226
        return
      endif
Andreas Marek's avatar
Andreas Marek committed
227

228
      obj%index = elpa_index_instance_c()
229 230

      ! Associate some important integer pointers for convenience
231 232 233 234 235 236
      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
237
#ifdef USE_FORTRAN2008
238
      if (present(error)) then
239
        error = ELPA_OK
240
      endif
Andreas Marek's avatar
Andreas Marek committed
241 242 243
#else
      error = ELPA_OK
#endif
244
    end function
Andreas Marek's avatar
Andreas Marek committed
245

Andreas Marek's avatar
Andreas Marek committed
246 247 248 249 250
#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
251 252 253 254 255
    !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
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
#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
272 273 274 275 276
      type(elpa_impl_t), pointer :: obj

      obj => elpa_impl_allocate(error)
      ptr = c_loc(obj)
    end function
Andreas Marek's avatar
Andreas Marek committed
277 278 279 280 281 282 283 284
#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
285

Andreas Marek's avatar
Andreas Marek committed
286 287 288 289
      obj => elpa_impl_allocate(error)
      ptr = c_loc(obj)
    end function
#endif
Andreas Marek's avatar
Andreas Marek committed
290

Andreas Marek's avatar
Andreas Marek committed
291 292 293 294 295 296 297 298 299
#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
300 301 302
    !c> /*! \brief C interface for the implementation of the elpa_deallocate method
    !c> *
    !c> *  \param  elpa_t  handle of ELPA object to be deallocated
303
    !c> *  \param  int*    error code
304 305
    !c> *  \result void
    !c> */
Andreas Marek's avatar
Andreas Marek committed
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
#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
333 334
    subroutine elpa_impl_deallocate_c(handle, error) bind(C, name="elpa_deallocate")
      type(c_ptr), value         :: handle
335
      type(elpa_impl_t), pointer :: self
336
      integer(kind=c_int)        :: error
337 338

      call c_f_pointer(handle, self)
339
      call self%destroy(error)
340 341 342
      deallocate(self)
    end subroutine

Andreas Marek's avatar
Andreas Marek committed
343 344
#endif

345 346 347 348 349 350 351 352 353 354 355 356 357 358
    !> \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
359 360

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

#ifdef USE_FORTRAN2008
371 372 373
        if (present(error)) then
          error = ELPA_ERROR_CANNOT_OPEN_FILE
        endif
Andreas Marek's avatar
Andreas Marek committed
374 375 376
#else
        error = ELPA_ERROR_CANNOT_OPEN_FILE
#endif
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
      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
412 413

#ifdef USE_FORTRAN2008
414 415 416
      if (present(error)) then
        error = ELPA_OK
      endif
Andreas Marek's avatar
Andreas Marek committed
417 418 419
#else
      error = ELPA_OK
#endif
420 421
      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
422 423

#ifdef USE_FORTRAN2008
424
        if (present(error)) then
Andreas Marek's avatar
Andreas Marek committed
425
          error = ELPA_ERROR_CRITICAL
426
        endif
Andreas Marek's avatar
Andreas Marek committed
427 428 429
#else
        error = ELPA_ERROR_CRITICAL
#endif
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 457 458 459 460 461 462 463 464 465
      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
466
#ifdef USE_FORTRAN2008
467 468 469
      if (present(error)) then
        error = ELPA_OK
      endif
Andreas Marek's avatar
Andreas Marek committed
470 471 472
#else
      error = ELPA_OK
#endif
473 474
      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
475 476

#ifdef USE_FORTRAN2008
477 478 479
        if (present(error)) then
          error = ELPA_ERROR_CANNOT_OPEN_FILE
        endif
Andreas Marek's avatar
Andreas Marek committed
480 481 482
#else
        error = ELPA_ERROR_CANNOT_OPEN_FILE
#endif
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
      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
507
#ifdef ENABLE_AUTOTUNING
Andreas Marek's avatar
Andreas Marek committed
508 509 510 511 512
#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
513 514 515 516 517
    !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
518 519 520 521 522 523
#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")
524
      type(c_ptr), value                  :: autotune_handle
525

526
      type(elpa_autotune_impl_t), pointer :: self
527
      integer(kind=c_int)                 :: error
528 529

      call c_f_pointer(autotune_handle, self)
530
      call self%destroy(error)
531 532
      deallocate(self)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
533 534

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

537
      type(elpa_autotune_impl_t), pointer :: self
Andreas Marek's avatar
Andreas Marek committed
538
      integer(kind=c_int)                 :: error
Andreas Marek's avatar
Andreas Marek committed
539 540 541 542 543 544 545 546 547 548
      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
549

Andreas Marek's avatar
Andreas Marek committed
550 551
      type(elpa_autotune_impl_t), pointer :: self
      integer(kind=c_int)                 :: error
552
      call c_f_pointer(autotune_handle, self)
Andreas Marek's avatar
Andreas Marek committed
553
      call self%destroy(error)
554 555
      deallocate(self)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
556

Andreas Marek's avatar
Andreas Marek committed
557
#endif
Andreas Marek's avatar
Andreas Marek committed
558
#endif /* ENABLE_AUTOTUNING */
559

560 561 562 563
    !> \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
564
    function elpa_setup(self) result(error)
565
      class(elpa_impl_t), intent(inout)   :: self
566
      integer                             :: error, timings, performance, build_config
567

568
#ifdef WITH_MPI
569
      integer                             :: mpi_comm_parent, mpi_comm_rows, mpi_comm_cols, np_rows, np_cols, my_id, &
570
                                             process_row, process_col, mpi_string_length, &
Pavel Kus's avatar
Pavel Kus committed
571
                                             present_np_rows, present_np_cols, np_total
572
      integer(kind=MPI_KIND)              :: mpierr, mpierr2, my_idMPI, np_totalMPI, process_rowMPI, process_colMPI
573 574
      integer(kind=MPI_KIND)              :: mpi_comm_rowsMPI, mpi_comm_colsMPI, np_rowsMPI, np_colsMPI, &
                                             mpi_string_lengthMPI
575
      character(len=MPI_MAX_ERROR_STRING) :: mpierr_string
576 577 578
      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..."

579
#endif
580

581

Pavel Kus's avatar
Pavel Kus committed
582 583 584 585 586 587 588
#ifdef HAVE_LIKWID
      !initialize likwid
      call likwid_markerInit()
      call likwid_markerThreadInit()
      call likwid_markerStartRegion("TOTAL")
#endif

589
#ifdef HAVE_DETAILED_TIMINGS
Andreas Marek's avatar
Andreas Marek committed
590
      call self%get("timings",timings, error)
Andreas Marek's avatar
Andreas Marek committed
591
      call self%get("measure_performance",performance, error)
592
      if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
593 594
      if (timings == 1) then
        call self%timer%enable()
Andreas Marek's avatar
Andreas Marek committed
595 596
        if (performance == 1) then
          call self%timer%measure_flops(.true.)
Andreas Marek's avatar
Andreas Marek committed
597
          call self%timer%set_print_options(print_flop_count=.true.,print_flop_rate=.true.)
Andreas Marek's avatar
Andreas Marek committed
598
        endif
599 600 601 602
      endif
#endif

      error = ELPA_OK
603

604 605 606 607 608 609 610 611
      ! 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

612
#ifdef WITH_MPI
613
      if (self%is_set("mpi_comm_parent") == 1) then
Andreas Marek's avatar
Andreas Marek committed
614
        call self%get("mpi_comm_parent", mpi_comm_parent, error)
615
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
616

617 618
        call mpi_comm_rank(int(mpi_comm_parent,kind=MPI_KIND), my_idMPI, mpierr)
        my_id = int(my_idMPI, kind=c_int)
619
        call self%set("process_id", my_id, error)
620
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
621

622 623
        call mpi_comm_size(int(mpi_comm_parent,kind=MPI_KIND), np_totalMPI, mpierr)
        np_total = int(np_totalMPI,kind=c_int)
624
        call self%set("num_processes", np_total, error)
625
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
626
      else
Pavel Kus's avatar
Pavel Kus committed
627
        if (self%from_legacy_api .ne. 1) then
628 629 630 631 632 633 634 635 636
          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

637
        if (self%is_set("mpi_comm_rows") == 1 .or. self%is_set("mpi_comm_cols") == 1) then
638 639 640 641 642
          write(error_unit,*) MPI_CONSISTENCY_MSG
          error = ELPA_ERROR
          return
        endif

Andreas Marek's avatar
Andreas Marek committed
643
        call self%get("process_row", process_row, error)
644
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
645

Andreas Marek's avatar
Andreas Marek committed
646
        call self%get("process_col", process_col, error)
647
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
648 649 650 651 652 653

        ! 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

654 655 656
        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)
657
        if (mpierr .ne. MPI_SUCCESS) then
658 659
          call MPI_ERROR_STRING(mpierr, mpierr_string, mpi_string_lengthMPI, mpierr2)
          mpi_string_length = int(mpi_string_lengthMPI, kind=c_int)
660 661 662 663
          write(error_unit,*) "MPI ERROR occured during mpi_comm_split for row communicator: ", trim(mpierr_string)
          return
        endif

664 665 666
        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)
667
        if (mpierr .ne. MPI_SUCCESS) then
668 669
          call MPI_ERROR_STRING(mpierr, mpierr_string, mpi_string_lengthMPI, mpierr2)
          mpi_string_length = int(mpi_string_lengthMPI, kind=c_int)
670 671 672
          write(error_unit,*) "MPI ERROR occured during mpi_comm_split for col communicator: ", trim(mpierr_string)
          return
        endif
673

Andreas Marek's avatar
Andreas Marek committed
674
        call self%set("mpi_comm_rows", mpi_comm_rows,error)
675
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
676

677
        call self%set("mpi_comm_cols", mpi_comm_cols,error)
678
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
679

680 681 682
        ! remember that we created those communicators and we need to free them later
        self%communicators_owned = 1

683
      ! Externally supplied communicators
684 685
      else if ( self%is_set("mpi_comm_rows") == 1 .and.  self%is_set("mpi_comm_cols") == 1) then

686
        if (self%is_set("process_row") == 1 .or. self%is_set("process_col") == 1) then
687 688 689
          write(error_unit,*) MPI_CONSISTENCY_MSG
          error = ELPA_ERROR
          return
690
        endif
691 692

        call self%get("mpi_comm_rows", mpi_comm_rows,error)
693
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
694

695
        call self%get("mpi_comm_cols", mpi_comm_cols,error)
696
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
697

698
        call mpi_comm_rank(int(mpi_comm_rows,kind=MPI_KIND), process_rowMPI, mpierr)
699
        process_row = int(process_rowMPI,kind=c_int)
700
        call self%set("process_row", process_row, error)
701
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
702

703
        call mpi_comm_rank(int(mpi_comm_cols,kind=MPI_KIND), process_colMPI, mpierr)
704
        process_col = int(process_colMPI,kind=c_int)
705
        call self%set("process_col", process_col, error)
706
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
707 708

        ! remember that we DID NOT created those communicators and we WILL NOT free them later
709
        self%communicators_owned = 0
710 711 712 713 714 715
      else
        ! Otherwise parameters are missing
        write(error_unit,*) MPI_CONSISTENCY_MSG
        error = ELPA_ERROR
        return
      endif
716

717 718 719
      ! 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?
720 721
      call mpi_comm_size(int(mpi_comm_rows,kind=MPI_KIND), np_rowsMPI, mpierr)
      np_rows = int(np_rowsMPI, kind=c_int)
722
      if (self%is_set("num_process_rows") == 1) then
723
        call self%get("num_process_rows", present_np_rows, error)
724
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
725

726
        if (np_rows .ne. present_np_rows) then
727
          print *,"MPI row communicator not set correctly. Aborting..."
728 729
          stop
        endif
730 731
      else
        call self%set("num_process_rows", np_rows, error)
732
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
733 734
      endif

735 736
      call mpi_comm_size(int(mpi_comm_cols,kind=MPI_KIND), np_colsMPI, mpierr)
      np_cols = int(np_colsMPI, kind=c_int)
737
      if (self%is_set("num_process_cols") == 1) then
738
        call self%get("num_process_cols", present_np_cols, error)
739
        if (check_elpa_get(error, ELPA_ERROR_SETUP)) return
740

741
        if (np_cols .ne. present_np_cols) then
742
          print *,"MPI column communicator not set correctly. Aborting..."
743 744
          stop
        endif
745 746
      else
        call self%set("num_process_cols", np_cols, error)
747
        if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
748
      endif
749

Pavel Kus's avatar
Pavel Kus committed
750
      if (self%from_legacy_api .ne. 1) then
751
        if (np_total .ne. np_rows * np_cols) then
752 753 754
          print *,"MPI parent communicator and row/col communicators do not match. Aborting..."
          stop
        endif
755
      endif
756

757
#else
758
      call self%set("process_row", 0, error)
759
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
760
      call self%set("process_col", 0, error)
761
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
762
      call self%set("process_id", 0, error)
763
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
764
      call self%set("num_process_rows", 1, error)
765
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
766
      call self%set("num_process_cols", 1, error)
767
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
768
      call self%set("num_processes", 1, error)
769
      if (check_elpa_set(error, ELPA_ERROR_SETUP)) return
770
#endif
771

772 773 774 775 776 777 778 779 780 781 782 783
#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
784
    end function
785

Andreas Marek's avatar
Andreas Marek committed
786

787 788 789 790 791 792
    !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> */
793
    !c> int elpa_setup(elpa_t handle);
794
    function elpa_setup_c(handle) result(error) bind(C, name="elpa_setup")
795 796 797 798 799 800 801 802
      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

803
    function elpa_construct_scalapack_descriptor(self, sc_desc, rectangular_for_ev) result(error)
804
      class(elpa_impl_t), intent(inout)   :: self
805
      logical, intent(in)                 :: rectangular_for_ev
806 807 808 809 810 811 812 813 814
      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)
815
      if (check_elpa_get(error, ELPA_ERROR_CRITICAL)) return
816 817 818 819

      sc_desc(1) = 1
      sc_desc(2) = blacs_ctx
      sc_desc(3) = self%na
820
      if (rectangular_for_ev) then
821 822 823 824
        sc_desc(4) = self%nev
      else
        sc_desc(4) = self%na
      endif
825 826 827 828 829 830 831 832 833 834
      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
835

Andreas Marek's avatar
Andreas Marek committed
836

837 838 839 840 841 842 843 844 845
    !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> */
846
    !c> void elpa_set_integer(elpa_t handle, const char *name, int value, int *error);
847
    subroutine elpa_set_integer_c(handle, name_p, value, error) bind(C, name="elpa_set_integer")
Andreas Marek's avatar
Andreas Marek committed
848 849 850
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
851
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
852 853
      integer(kind=c_int), intent(in), value        :: value
      integer(kind=c_int) , intent(in)              :: error
854 855 856 857 858 859 860

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


861 862 863 864 865 866 867 868 869
    !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> */
870 871
    !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
872 873 874
      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
875
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
876 877
      integer(kind=c_int)                           :: value
      integer(kind=c_int), intent(inout)            :: error
878
 
Andreas Marek's avatar
Andreas Marek committed
879 880
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
881 882
      call elpa_get_integer(self, name, value, error)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
883 884


885 886 887 888 889
    !> \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
890 891
    function elpa_is_set(self, name) result(state)
      class(elpa_impl_t)       :: self
892
      character(*), intent(in) :: name
893
      integer                  :: state
894

895
      state = elpa_index_value_is_set_c(self%index, name // c_null_char)
896 897
    end function

898 899 900 901 902 903
    !> \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
904 905 906 907 908 909 910 911 912 913
    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


914 915 916 917 918 919
    !> \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   
920
    function elpa_value_to_string(self, option_name, error) result(string)
921 922
      class(elpa_impl_t), intent(in) :: self
      character(kind=c_char, len=*), intent(in) :: option_name
923
      type(c_ptr) :: ptr
Andreas Marek's avatar
Andreas Marek committed
924
#ifdef USE_FORTRAN2008
925
      integer, intent(out), optional :: error
Andreas Marek's avatar
Andreas Marek committed
926 927 928 929
#else
      integer, intent(out)           :: error
#endif

930 931
      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
932

933 934
      nullify(string)

935
      call self%get(option_name, val, actual_error)
936
      if (actual_error /= ELPA_OK) then
Andreas Marek's avatar
Andreas Marek committed
937
#ifdef USE_FORTRAN2008
938 939 940
        if (present(error)) then
          error = actual_error
        endif
Andreas Marek's avatar
Andreas Marek committed
941 942 943
#else
          error = actual_error
#endif
944
        return
945 946
      endif

947 948 949 950
      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
951

Andreas Marek's avatar
Andreas Marek committed
952
#ifdef USE_FORTRAN2008
953 954 955
      if (present(error)) then
        error = actual_error
      endif
Andreas Marek's avatar
Andreas Marek committed
956 957 958
#else
        error = actual_error
#endif
959
    end function
960

Andreas Marek's avatar
Andreas Marek committed
961

962 963 964 965 966 967 968 969 970
    !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> */
971
    !c> void elpa_set_double(elpa_t handle, const char *name, double value, int *error);
972
    subroutine elpa_set_double_c(handle, name_p, value, error) bind(C, name="elpa_set_double")
Andreas Marek's avatar
Andreas Marek committed
973 974 975
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
976
      character(len=elpa_strlen_c(name_p)), poi