elpa_impl.F90 37.6 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 60 61
  use precision
  use elpa2_impl
  use elpa1_impl
  use elpa1_auxiliary_impl
#ifdef WITH_MPI
  use elpa_mpi
#endif
  use elpa_generated_fortran_interfaces
  use elpa_utilities, only : error_unit

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

69 70
  private
  public :: elpa_impl_allocate
71

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

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

84
     ! KV store
85 86 87 88
     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
89

90 91 92 93

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


98 99 100 101 102 103 104 105 106 107 108 109 110 111
     !> \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
112 113 114 115 116 117
     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

118 119 120 121 122 123
     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

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

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

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

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

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

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

Andreas Marek's avatar
Andreas Marek committed
159
#ifdef ENABLE_AUTOTUNING
160
     procedure, public :: autotune_setup => elpa_autotune_setup
161 162
     procedure, public :: autotune_step => elpa_autotune_step
     procedure, public :: autotune_set_best => elpa_autotune_set_best
163
     procedure, public :: autotune_print_best => elpa_autotune_print_best
Andreas Marek's avatar
Andreas Marek committed
164
#endif
165
     procedure, private :: construct_scalapack_descriptor => elpa_construct_scalapack_descriptor
166
  end type elpa_impl_t
167 168

  !> \brief the implementation of the generic methods
169
  contains
170 171


172 173 174 175
    !> \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
176 177 178 179 180
    function elpa_impl_allocate(error) result(obj)
      type(elpa_impl_t), pointer   :: obj
      integer, optional            :: error

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

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

191
      obj%index = elpa_index_instance_c()
192 193

      ! Associate some important integer pointers for convenience
194 195 196 197 198 199 200 201
      obj%na => obj%associate_int("na")
      obj%nev => obj%associate_int("nev")
      obj%local_nrows => obj%associate_int("local_nrows")
      obj%local_ncols => obj%associate_int("local_ncols")
      obj%nblk => obj%associate_int("nblk")

      if(present(error)) then
        error = ELPA_OK
202 203
      endif
    end function
Andreas Marek's avatar
Andreas Marek committed
204

205 206 207 208 209
    !c> /*! \brief C interface for the implementation of the elpa_allocate method
    !c> *
    !c> *  \param  none
    !c> *  \result elpa_t handle
    !c> */
210
    !c> elpa_t elpa_allocate();
211
    function elpa_impl_allocate_c(error) result(ptr) bind(C, name="elpa_allocate")
212 213 214 215 216 217 218 219
      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

220 221 222 223 224
    !c> /*! \brief C interface for the implementation of the elpa_deallocate method
    !c> *
    !c> *  \param  elpa_t  handle of ELPA object to be deallocated
    !c> *  \result void
    !c> */
225
    !c> void elpa_deallocate(elpa_t handle);
226
    subroutine elpa_impl_deallocate_c(handle) bind(C, name="elpa_deallocate")
227 228 229 230 231 232 233 234
      type(c_ptr), value :: handle
      type(elpa_impl_t), pointer :: self

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

Andreas Marek's avatar
Andreas Marek committed
235
#ifdef ENABLE_AUTOTUNING
236 237 238 239 240
    !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> */
241 242 243
    !c> void elpa_autotune_deallocate(elpa_autotune_t handle);
    subroutine elpa_autotune_impl_deallocate_c( autotune_handle) bind(C, name="elpa_autotune_deallocate")
      type(c_ptr), value                  :: autotune_handle
244

245 246 247
      type(elpa_autotune_impl_t), pointer :: self

      call c_f_pointer(autotune_handle, self)
248 249 250
      call self%destroy()
      deallocate(self)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
251
#endif
252

253 254 255 256
    !> \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
257
    function elpa_setup(self) result(error)
258 259
      class(elpa_impl_t), intent(inout)   :: self
      integer                             :: error, timings
260

261
#ifdef WITH_MPI
262 263 264
      integer                             :: mpi_comm_parent, mpi_comm_rows, mpi_comm_cols, &
                                             mpierr, mpierr2, process_row, process_col, mpi_string_length
      character(len=MPI_MAX_ERROR_STRING) :: mpierr_string
265
#endif
266

267
#ifdef HAVE_DETAILED_TIMINGS
Andreas Marek's avatar
Andreas Marek committed
268
      call self%get("timings",timings, error)
269 270 271 272 273 274
      if (timings == 1) then
        call self%timer%enable()
      endif
#endif

      error = ELPA_OK
275

276 277
#ifdef WITH_MPI
      ! Create communicators ourselves
278 279 280
      if (self%is_set("mpi_comm_parent") == 1 .and. &
          self%is_set("process_row") == 1 .and. &
          self%is_set("process_col") == 1) then
281

Andreas Marek's avatar
Andreas Marek committed
282 283 284
        call self%get("mpi_comm_parent", mpi_comm_parent, error)
        call self%get("process_row", process_row, error)
        call self%get("process_col", process_col, error)
285 286 287 288 289 290 291

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

293 294 295 296 297 298 299 300 301 302 303 304
        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
305

Andreas Marek's avatar
Andreas Marek committed
306 307 308 309 310 311 312 313 314 315
        call self%set("mpi_comm_rows", mpi_comm_rows,error)
        if (error .ne. ELPA_OK) then
          print *,"Problem setting option. Aborting..."
          stop
        endif
        call self%set("mpi_comm_cols", mpi_comm_cols,error)
        if (error .ne. ELPA_OK) then
          print *,"Problem setting option. Aborting..."
          stop
        endif
316

317 318 319
        ! remember that we created those communicators and we need to free them later
        self%communicators_owned = 1

320
        error = ELPA_OK
321
        return
322
      endif
323

324
      ! Externally supplied communicators
325
      if (self%is_set("mpi_comm_rows") == 1 .and. self%is_set("mpi_comm_cols") == 1) then
326
        self%communicators_owned = 0
327
        error = ELPA_OK
328
        return
329
      endif
330

331 332
      ! Otherwise parameters are missing
      error = ELPA_ERROR
333
#endif
334

335
    end function
336

337 338 339 340 341 342
    !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> */
343
    !c> int elpa_setup(elpa_t handle);
344
    function elpa_setup_c(handle) result(error) bind(C, name="elpa_setup")
345 346 347 348 349 350 351 352
      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

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
    function elpa_construct_scalapack_descriptor(self, sc_desc) result(error)
      class(elpa_impl_t), intent(inout)   :: self
      integer                             :: error, blacs_ctx
      integer, intent(out)                :: sc_desc(SC_DESC_LEN)

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

      sc_desc(1) = 1
      sc_desc(2) = blacs_ctx
      sc_desc(3) = self%na
      sc_desc(4) = self%na
      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
379

380 381 382 383 384 385 386 387 388
    !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> */
389
    !c> void elpa_set_integer(elpa_t handle, const char *name, int value, int *error);
390
    subroutine elpa_set_integer_c(handle, name_p, value, error) bind(C, name="elpa_set_integer")
Andreas Marek's avatar
Andreas Marek committed
391 392 393
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
394
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
395 396 397 398 399 400 401
      integer(kind=c_int), intent(in), value        :: value

#ifdef USE_FORTRAN2008
      integer(kind=c_int) , intent(in), optional    :: error
#else
      integer(kind=c_int) , intent(in)              :: error
#endif
402 403 404 405 406 407 408

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


409 410 411 412 413 414 415 416 417
    !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> */
418 419
    !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
420 421 422
      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
423
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
424 425 426 427 428 429
      integer(kind=c_int)                           :: value
#ifdef ISE_FORTRAN2008
      integer(kind=c_int), intent(inout), optional  :: error
#else
      integer(kind=c_int), intent(inout)            :: error
#endif
Andreas Marek's avatar
Andreas Marek committed
430 431
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
432 433
      call elpa_get_integer(self, name, value, error)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
434 435


436 437 438 439 440
    !> \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
441 442
    function elpa_is_set(self, name) result(state)
      class(elpa_impl_t)       :: self
443
      character(*), intent(in) :: name
444
      integer                  :: state
445

446
      state = elpa_index_value_is_set_c(self%index, name // c_null_char)
447 448
    end function

449 450 451 452 453 454
    !> \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
455 456 457 458 459 460 461 462 463 464
    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


465 466 467 468 469 470
    !> \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   
471
    function elpa_value_to_string(self, option_name, error) result(string)
472 473
      class(elpa_impl_t), intent(in) :: self
      character(kind=c_char, len=*), intent(in) :: option_name
474 475 476 477
      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
478

479 480
      nullify(string)

481
      call self%get(option_name, val, actual_error)
482 483 484 485 486
      if (actual_error /= ELPA_OK) then
        if (present(error)) then
          error = actual_error
        endif
        return
487 488
      endif

489 490 491 492
      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
493

494 495 496 497
      if (present(error)) then
        error = actual_error
      endif
    end function
498

Andreas Marek's avatar
Andreas Marek committed
499

500 501 502 503 504 505 506 507 508
    !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> */
509
    !c> void elpa_set_double(elpa_t handle, const char *name, double value, int *error);
510
    subroutine elpa_set_double_c(handle, name_p, value, error) bind(C, name="elpa_set_double")
Andreas Marek's avatar
Andreas Marek committed
511 512 513
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
514
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
515 516 517 518 519 520
      real(kind=c_double), intent(in), value        :: value
#ifdef USE_FORTRAN2008
      integer(kind=c_int), intent(in), optional     :: error
#else
      integer(kind=c_int), intent(in)               :: error
#endif
521 522 523 524 525
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
      call elpa_set_double(self, name, value, error)
    end subroutine

526

527
    !c> /*! \brief C interface for the implementation of the elpa_get_double method
528 529 530 531 532 533 534 535
    !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> */
536 537
    !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
538 539 540
      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
541
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
542 543 544 545 546 547
      real(kind=c_double)                           :: value
#ifdef USE_FORTRAN2008
      integer(kind=c_int), intent(inout), optional  :: error
#else
      integer(kind=c_int), intent(inout)            :: error
#endif
Andreas Marek's avatar
Andreas Marek committed
548 549
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
550 551
      call elpa_get_double(self, name, value, error)
    end subroutine
552
 
Andreas Marek's avatar
Andreas Marek committed
553

554 555 556 557 558
    !> \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
559
    function elpa_associate_int(self, name) result(value)
560
      class(elpa_impl_t)             :: self
561 562
      character(*), intent(in)       :: name
      integer(kind=c_int), pointer   :: value
Andreas Marek's avatar
Andreas Marek committed
563

564 565
      type(c_ptr)                    :: value_p

566
      value_p = elpa_index_get_int_loc_c(self%index, name // c_null_char)
567 568 569
      if (.not. c_associated(value_p)) then
        write(error_unit, '(a,a,a)') "ELPA: Warning, received NULL pointer for entry '", name, "'"
      endif
570 571
      call c_f_pointer(value_p, value)
    end function
Andreas Marek's avatar
Andreas Marek committed
572

573

574 575 576 577 578 579 580
    !> \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
581 582 583 584 585 586
    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

587
#ifdef HAVE_DETAILED_TIMINGS
588
      s = self%timer%get(name1, name2, name3, name4, name5, name6)
589 590 591
#else
      s = -1.0
#endif
592 593 594
    end function


595 596 597 598 599
    !> \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
600
    subroutine elpa_print_times(self, name1, name2, name3, name4)
601
      class(elpa_impl_t), intent(in) :: self
602
      character(len=*), intent(in), optional :: name1, name2, name3, name4
603
#ifdef HAVE_DETAILED_TIMINGS
604
      call self%timer%print(name1, name2, name3, name4)
605
#endif
606 607
    end subroutine

608

609 610 611 612
    !> \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
613 614 615 616 617 618 619 620 621
    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


622 623 624 625
    !> \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
626 627 628 629 630 631 632 633 634
    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


635 636 637
    !> \brief function to destroy an elpa object
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
638
    subroutine elpa_destroy(self)
639
#ifdef WITH_MPI
Andreas Marek's avatar
Andreas Marek committed
640
      integer :: mpi_comm_rows, mpi_comm_cols, mpierr, error
641
#endif
642
      class(elpa_impl_t) :: self
643 644 645

#ifdef WITH_MPI
      if (self%communicators_owned == 1) then
Andreas Marek's avatar
Andreas Marek committed
646 647 648 649 650 651 652 653 654 655
        call self%get("mpi_comm_rows", mpi_comm_rows,error)
        if (error .ne. ELPA_OK) then
           print *,"Problem getting option. Aborting..."
           stop
        endif
        call self%get("mpi_comm_cols", mpi_comm_cols,error)
        if (error .ne. ELPA_OK) then
           print *,"Problem getting option. Aborting..."
           stop
        endif
656

657 658 659 660 661
        call mpi_comm_free(mpi_comm_rows, mpierr)
        call mpi_comm_free(mpi_comm_cols, mpierr)
      endif
#endif

662
      call timer_free(self%timer)
663
      call timer_free(self%autotune_timer)
664 665
      call elpa_index_free_c(self%index)

666
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
667

Pavel Kus's avatar
Pavel Kus committed
668 669
#define REALCASE 1
#define DOUBLE_PRECISION 1
Andreas Marek's avatar
Andreas Marek committed
670
#define INCLUDE_ROUTINES 1
Pavel Kus's avatar
Pavel Kus committed
671
#include "general/precision_macros.h"
Andreas Marek's avatar
Andreas Marek committed
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
#include "elpa_impl_math_template.F90"
#undef REALCASE
#undef DOUBLE_PRECISION
#undef INCLUDE_ROUTINES

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

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

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

#define REALCASE 1
#define DOUBLE_PRECISION 1
#include "general/precision_macros.h"
#include "elpa_impl_generalized_transform_template.F90"
Pavel Kus's avatar
Pavel Kus committed
712 713 714 715 716 717 718
#undef REALCASE
#undef DOUBLE_PRECISION

#ifdef WANT_SINGLE_PRECISION_REAL
#define REALCASE 1
#define SINGLE_PRECISION 1
#include "general/precision_macros.h"
Andreas Marek's avatar
Andreas Marek committed
719
#include "elpa_impl_generalized_transform_template.F90"
Pavel Kus's avatar
Pavel Kus committed
720 721
#undef REALCASE
#undef SINGLE_PRECISION
Andreas Marek's avatar
Andreas Marek committed
722
#endif
Pavel Kus's avatar
Pavel Kus committed
723 724

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

Pavel Kus's avatar
Pavel Kus committed
726 727
#define DOUBLE_PRECISION 1
#include "general/precision_macros.h"
Andreas Marek's avatar
Andreas Marek committed
728
#include "elpa_impl_generalized_transform_template.F90"
Pavel Kus's avatar
Pavel Kus committed
729 730 731 732 733 734 735
#undef DOUBLE_PRECISION
#undef COMPLEXCASE

#ifdef WANT_SINGLE_PRECISION_COMPLEX
#define COMPLEXCASE 1
#define SINGLE_PRECISION
#include "general/precision_macros.h"
Andreas Marek's avatar
Andreas Marek committed
736
#include "elpa_impl_generalized_transform_template.F90"
Pavel Kus's avatar
Pavel Kus committed
737 738
#undef COMPLEXCASE
#undef SINGLE_PRECISION
Andreas Marek's avatar
Andreas Marek committed
739 740
#endif

Andreas Marek's avatar
Andreas Marek committed
741
#ifdef ENABLE_AUTOTUNING
742 743
    !> \brief function to setup the ELPA autotuning and create the autotune object
    !> Parameters
744
    !> \param   self            the allocated ELPA object
745 746
    !> \param   level           integer: the "thoroughness" of the planed autotuning
    !> \param   domain          integer: the domain (real/complex) which should be tuned
747
    !> \result  tune_state      the created autotuning object
748
    function elpa_autotune_setup(self, level, domain, error) result(tune_state)
749
      class(elpa_impl_t), intent(inout), target :: self
Andreas Marek's avatar
Andreas Marek committed
750 751 752
      integer, intent(in)                       :: level, domain
      type(elpa_autotune_impl_t), pointer       :: ts_impl
      class(elpa_autotune_t), pointer           :: tune_state
753 754 755 756 757
#ifdef USE_FORTRAN2008
      integer(kind=c_int), optional             :: error
#else
      integer(kind=c_int)                       :: error
#endif
758

759 760 761 762 763 764 765
#ifdef USE_FORTRAN2008
      if (present(error)) then
        error = ELPA_OK
      endif
#else
      error = ELPA_OK
#endif
Andreas Marek's avatar
Andreas Marek committed
766
      if (elpa_get_api_version() < EARLIEST_AUTOTUNE_VERSION) then
767 768 769 770 771 772 773 774 775
        write(error_unit, "(a,i0,a)") "ELPA: Error API version: Autotuning does not support ", elpa_get_api_version()
#ifdef USE_FORTRAN2008
        if (present(error)) then
          error = ELPA_ERROR
        endif
#else
        error = ELPA_ERROR
#endif
        return
Andreas Marek's avatar
Andreas Marek committed
776 777
      endif

778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
      allocate(ts_impl)
      ts_impl%parent => self
      ts_impl%level = level
      ts_impl%domain = domain

      ts_impl%i = -1
      ts_impl%min_loc = -1
      ts_impl%N = elpa_index_autotune_cardinality_c(self%index, level, domain)

      tune_state => ts_impl

      call self%autotune_timer%enable()
    end function


Andreas Marek's avatar
Andreas Marek committed
793

794 795 796 797 798 799 800
    !c> /*! \brief C interface for the implementation of the elpa_autotune_setup method
    !c> *
    !c> *  \param  elpa_t           handle: of the ELPA object which should be tuned
    !c> *  \param  int              level:  "thoroughness" of autotuning
    !c> *  \param  int              domain: real/complex autotuning
    !c> *  \result elpa_autotune_t  handle:  on the autotune object
    !c> */
801 802
    !c> elpa_autotune_t elpa_autotune_setup(elpa_t handle, int level, int domain, int *error);
    function elpa_autotune_setup_c(handle ,level, domain, error) result(ptr) bind(C, name="elpa_autotune_setup")
803 804 805 806 807 808 809
      type(c_ptr), intent(in), value         :: handle
      type(elpa_impl_t), pointer             :: self
      class(elpa_autotune_t), pointer        :: tune_state
      type(elpa_autotune_impl_t), pointer    :: obj        
      integer(kind=c_int), intent(in), value :: level
      integer(kind=c_int), intent(in), value :: domain
      type(c_ptr)                            :: ptr
810 811 812 813 814
#ifdef USE_FORTRAN2008
      integer(kind=c_int) , intent(in), optional    :: error
#else
      integer(kind=c_int) , intent(in)              :: error
#endif
815 816

      call c_f_pointer(handle, self)
817

818
      tune_state => self%autotune_setup(level, domain, error)
819
      select type(tune_state)
820
        type is (elpa_autotune_impl_t)
821 822 823
          obj => tune_state
        class default
          print *, "This should not happen"
824
          stop
825 826
      end select                
      ptr = c_loc(obj)
827

828
    end function
829 830


831 832 833 834 835
    !> \brief function to do an autotunig step
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
    !> \param   tune_state      class(elpa_autotune_t): the autotuning object
    !> \result  unfinished      logical: describes the state of the autotuning (completed/uncompleted)
836 837 838 839 840 841 842 843 844 845
    function elpa_autotune_step(self, tune_state) result(unfinished)
      implicit none
      class(elpa_impl_t), intent(inout) :: self
      class(elpa_autotune_t), intent(inout), target :: tune_state
      type(elpa_autotune_impl_t), pointer :: ts_impl
      logical :: unfinished
      integer :: i
      real(kind=C_DOUBLE) :: time_spent

      select type(tune_state)
846
        type is (elpa_autotune_impl_t)
847 848 849 850 851 852 853 854
          ts_impl => tune_state
        class default
          print *, "This should not happen"
      end select

      unfinished = .false.

      if (ts_impl%i >= 0) then
855
#ifdef HAVE_DETAILED_TIMINGS
856
        time_spent = self%autotune_timer%get("accumulator")
857
#endif
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
        if (ts_impl%min_loc == -1 .or. (time_spent < ts_impl%min_val)) then
          ts_impl%min_val = time_spent
          ts_impl%min_loc = ts_impl%i
        end if
        call self%autotune_timer%free()
      endif

      do while (ts_impl%i < ts_impl%N)
        ts_impl%i = ts_impl%i + 1
        if (elpa_index_set_autotune_parameters_c(self%index, ts_impl%level, ts_impl%domain, ts_impl%i) == 1) then
          unfinished = .true.
          return
        end if
      end do

    end function


876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905

    !c> /*! \brief C interface for the implementation of the elpa_autotune_step method
    !c> *
    !c> *  \param  elpa_t           handle: of the ELPA object which should be tuned
    !c> *  \param  elpa_autotune_t  autotune_handle: the autotuning object
    !c> *  \result int              unfinished:  describes whether autotuning finished (0) or not (1)
    !c> */
    !c> int elpa_autotune_step(elpa_t handle, elpa_autotune_t autotune_handle);
    function elpa_autotune_step_c(handle, autotune_handle) result(unfinished) bind(C, name="elpa_autotune_step")
      type(c_ptr), intent(in), value       :: handle
      type(c_ptr), intent(in), value       :: autotune_handle
      type(elpa_impl_t), pointer           :: self
      type(elpa_autotune_impl_t), pointer  :: tune_state
      logical                              :: unfinished_f
      integer(kind=c_int)                  :: unfinished

      call c_f_pointer(handle, self)
      call c_f_pointer(autotune_handle, tune_state)

      unfinished_f = self%autotune_step(tune_state)
      if (unfinished_f) then
        unfinished = 1
      else
        unfinished = 0
      endif

    end function



906 907 908 909
    !> \brief function to set the up-to-know best options of the autotuning
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
    !> \param   tune_state      class(elpa_autotune_t): the autotuning object
910 911 912 913 914 915 916
    subroutine elpa_autotune_set_best(self, tune_state)
      implicit none
      class(elpa_impl_t), intent(inout) :: self
      class(elpa_autotune_t), intent(in), target :: tune_state
      type(elpa_autotune_impl_t), pointer :: ts_impl

      select type(tune_state)
917
        type is (elpa_autotune_impl_t)
918 919 920 921 922 923 924 925 926 927
          ts_impl => tune_state
        class default
          print *, "This should not happen"
      end select

      print *, "set best, i = ", ts_impl%min_loc, "best time = ", ts_impl%min_val
      if (elpa_index_set_autotune_parameters_c(self%index, ts_impl%level, ts_impl%domain, ts_impl%min_loc) /= 1) then
        stop "This should not happen (in elpa_autotune_set_best())"
      endif
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
928

929 930


931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
    !> \brief function to print the up-to-know best options of the autotuning
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
    !> \param   tune_state      class(elpa_autotune_t): the autotuning object
    subroutine elpa_autotune_print_best(self, tune_state)
      implicit none
      class(elpa_impl_t), intent(inout) :: self
      class(elpa_autotune_t), intent(in), target :: tune_state
      type(elpa_autotune_impl_t), pointer :: ts_impl

      select type(tune_state)
        type is (elpa_autotune_impl_t)
          ts_impl => tune_state
        class default
          print *, "This should not happen"
      end select

      print *, "The following settings were found to be best:"
      print *, "Best, i = ", ts_impl%min_loc, "best time = ", ts_impl%min_val
      if (elpa_index_print_autotune_parameters_c(self%index, ts_impl%level, ts_impl%domain, ts_impl%min_loc) /= 1) then
        stop "This should not happen (in elpa_autotune_print_best())"
      endif
    end subroutine



957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
    !c> /*! \brief C interface for the implementation of the elpa_autotune_set_best method
    !c> *
    !c> *  \param  elpa_t           handle: of the ELPA object which should be tuned
    !c> *  \param  elpa_autotune_t  autotune_handle: the autotuning object
    !c> *  \result none 
    !c> */
    !c> void elpa_autotune_set_best(elpa_t handle, elpa_autotune_t autotune_handle);
    subroutine elpa_autotune_set_best_c(handle, autotune_handle) bind(C, name="elpa_autotune_set_best")
      type(c_ptr), intent(in), value       :: handle
      type(c_ptr), intent(in), value       :: autotune_handle
      type(elpa_impl_t), pointer           :: self
      type(elpa_autotune_impl_t), pointer  :: tune_state

      call c_f_pointer(handle, self)
      call c_f_pointer(autotune_handle, tune_state)

      call self%autotune_set_best(tune_state)

    end subroutine
976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997



    !c> /*! \brief C interface for the implementation of the elpa_autotune_print_best method
    !c> *
    !c> *  \param  elpa_t           handle: of the ELPA object which should be tuned
    !c> *  \param  elpa_autotune_t  autotune_handle: the autotuning object
    !c> *  \result none 
    !c> */
    !c> void elpa_autotune_print_best(elpa_t handle, elpa_autotune_t autotune_handle);
    subroutine elpa_autotune_print_best_c(handle, autotune_handle) bind(C, name="elpa_autotune_print_best")
      type(c_ptr), intent(in), value       :: handle
      type(c_ptr), intent(in), value       :: autotune_handle
      type(elpa_impl_t), pointer           :: self
      type(elpa_autotune_impl_t), pointer  :: tune_state

      call c_f_pointer(handle, self)
      call c_f_pointer(autotune_handle, tune_state)

      call self%autotune_print_best(tune_state)

    end subroutine
Andreas Marek's avatar
Andreas Marek committed
998
#endif
999 1000


1001
end module