elpa_impl.F90 49.1 KB
Newer Older
1 2 3
!
!    Copyright 2017, L. Hüdepohl and A. Marek, MPCDF
!
Andreas Marek's avatar
Andreas Marek committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
!    This file is part of ELPA.
!
!    The ELPA library was originally created by the ELPA consortium,
!    consisting of the following organizations:
!
!    - Max Planck Computing and Data Facility (MPCDF), formerly known as
!      Rechenzentrum Garching der Max-Planck-Gesellschaft (RZG),
!    - Bergische Universität Wuppertal, Lehrstuhl für angewandte
!      Informatik,
!    - Technische Universität München, Lehrstuhl für Informatik mit
!      Schwerpunkt Wissenschaftliches Rechnen ,
!    - Fritz-Haber-Institut, Berlin, Abt. Theorie,
!    - Max-Plack-Institut für Mathematik in den Naturwissenschaften,
!      Leipzig, Abt. Komplexe Strukutren in Biologie und Kognition,
!      and
!    - IBM Deutschland GmbH
!
!    This particular source code file contains additions, changes and
!    enhancements authored by Intel Corporation which is not part of
!    the ELPA consortium.
!
!    More information can be found here:
!    http://elpa.mpcdf.mpg.de/
!
!    ELPA is free software: you can redistribute it and/or modify
!    it under the terms of the version 3 of the license of the
!    GNU Lesser General Public License as published by the Free
!    Software Foundation.
!
!    ELPA is distributed in the hope that it will be useful,
!    but WITHOUT ANY WARRANTY; without even the implied warranty of
!    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
!    GNU Lesser General Public License for more details.
!
!    You should have received a copy of the GNU Lesser General Public License
!    along with ELPA.  If not, see <http://www.gnu.org/licenses/>
!
!    ELPA reflects a substantial effort on the part of the original
!    ELPA consortium, and we ask you to respect the spirit of the
!    license that we chose: i.e., please contribute any changes you
!    may have back to the original ELPA library distribution, and keep
!    any derivatives of ELPA under the same license that we chose for
!    the original distribution, the GNU Lesser General Public License.
!
48
#include "config-f90.h"
49

50
!> \brief Fortran module which provides the actual implementation of the API. Do not use directly! Use the module "elpa"
51
module elpa_impl
52 53 54 55 56 57 58 59
  use precision
  use elpa2_impl
  use elpa1_impl
  use elpa1_auxiliary_impl
  use elpa_mpi
  use elpa_generated_fortran_interfaces
  use elpa_utilities, only : error_unit

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

68 69
  private
  public :: elpa_impl_allocate
70

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

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

83
     ! KV store
84 85 86 87
     procedure, public :: is_set => elpa_is_set                 !< a method to check whether a key/value pair has been set : implemented
                                                                !< in elpa_is_set
     procedure, public :: can_set => elpa_can_set               !< a method to check whether a key/value pair can be set : implemented
                                                                !< in elpa_can_set
88

89 90 91 92

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


97 98 99 100 101 102 103 104 105 106 107 108 109 110
     !> \brief the implemenation methods

     procedure, public :: elpa_eigenvectors_d                  !< public methods to implement the solve step for real/complex
                                                               !< double/single matrices
     procedure, public :: elpa_eigenvectors_f
     procedure, public :: elpa_eigenvectors_dc
     procedure, public :: elpa_eigenvectors_fc

     procedure, public :: elpa_eigenvalues_d                   !< public methods to implement the solve step for real/complex
                                                               !< double/single matrices; only the eigenvalues are computed
     procedure, public :: elpa_eigenvalues_f
     procedure, public :: elpa_eigenvalues_dc
     procedure, public :: elpa_eigenvalues_fc

Pavel Kus's avatar
Pavel Kus committed
111 112 113 114 115 116
     procedure, public :: elpa_generalized_eigenvectors_d      !< public methods to implement the solve step for generalized 
                                                               !< eigenproblem and real/complex double/single matrices
     procedure, public :: elpa_generalized_eigenvectors_f
     procedure, public :: elpa_generalized_eigenvectors_dc
     procedure, public :: elpa_generalized_eigenvectors_fc

117 118 119 120 121 122
     procedure, public :: elpa_generalized_eigenvalues_d      !< public methods to implement the solve step for generalized 
                                                              !< eigenproblem and real/complex double/single matrices
     procedure, public :: elpa_generalized_eigenvalues_f
     procedure, public :: elpa_generalized_eigenvalues_dc
     procedure, public :: elpa_generalized_eigenvalues_fc

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

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

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

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

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

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

158 159
     procedure, public :: print_settings => elpa_print_settings
     procedure, public :: store_settings => elpa_store_settings
Andreas Marek's avatar
Andreas Marek committed
160
     procedure, public :: load_settings => elpa_load_settings
Andreas Marek's avatar
Andreas Marek committed
161
#ifdef ENABLE_AUTOTUNING
162
     procedure, public :: autotune_setup => elpa_autotune_setup
163 164
     procedure, public :: autotune_step => elpa_autotune_step
     procedure, public :: autotune_set_best => elpa_autotune_set_best
165
     procedure, public :: autotune_print_best => elpa_autotune_print_best
Pavel Kus's avatar
Pavel Kus committed
166
     procedure, public :: autotune_print_state => elpa_autotune_print_state
167
     procedure, public :: autotune_save_state => elpa_autotune_save_state
168
     procedure, public :: autotune_load_state => elpa_autotune_load_state
Andreas Marek's avatar
Andreas Marek committed
169
#endif
170
     procedure, private :: construct_scalapack_descriptor => elpa_construct_scalapack_descriptor
171
  end type elpa_impl_t
172 173

  !> \brief the implementation of the generic methods
174
  contains
175 176


177 178 179 180
    !> \brief function to allocate an ELPA object
    !> Parameters
    !> \param   error      integer, optional to get an error code
    !> \result  obj        class(elpa_impl_t) allocated ELPA object
181 182 183 184 185
    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
186

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

196
      obj%index = elpa_index_instance_c()
197 198

      ! Associate some important integer pointers for convenience
199 200 201 202 203 204 205 206
      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
207 208
      endif
    end function
Andreas Marek's avatar
Andreas Marek committed
209

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

225 226 227 228 229
    !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> */
230
    !c> void elpa_deallocate(elpa_t handle);
231
    subroutine elpa_impl_deallocate_c(handle) bind(C, name="elpa_deallocate")
232 233 234 235 236 237 238 239
      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
240
#ifdef ENABLE_AUTOTUNING
241 242 243 244 245
    !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> */
246 247 248
    !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
249

250 251 252
      type(elpa_autotune_impl_t), pointer :: self

      call c_f_pointer(autotune_handle, self)
253 254 255
      call self%destroy()
      deallocate(self)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
256
#endif
257

258 259 260 261 262 263
    ! we want to ensure, that my_prow(col) and np_rows(cols) values are allways accessible trhough
    ! the elpa object, no matter whether the user provides communicators or communicators are created
    ! by elpa. If the walues are present already, they are checked for consistency with the communicators.
    subroutine set_or_check_missing_comm_params(self)
      implicit none
      class(elpa_impl_t), intent(inout)   :: self
264 265 266 267
      integer                             :: mpi_comm_parent, mpi_comm_rows, mpi_comm_cols, mpierr, error, &
                                             my_prow, my_pcol, my_id, present_my_prow, present_my_pcol, present_my_id, &
                                             np_rows, np_cols, np_total, present_np_rows, present_np_cols, present_np_total, &
                                             is_process_id_zero
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
      if (.not. (self%is_set("mpi_comm_rows") == 1 .and. self%is_set("mpi_comm_cols") == 1) ) then
        print *,"MPI row and column communicators not set correctly. Aborting..."
        stop
      endif
      call self%get("mpi_comm_rows", mpi_comm_rows, error)
      call self%get("mpi_comm_cols", mpi_comm_cols, error)

      call mpi_comm_size(mpi_comm_rows, np_rows, mpierr)
      if(self%is_set("num_process_rows") == 1) then
        call self%get("num_process_rows", present_np_rows, error)
        if(np_rows .ne. present_np_rows) then
          print *,"MPI row communicator not set correctly. Aborting..."
          stop
        endif
      else
        call self%set("num_process_rows", np_rows, error)
      endif

      call mpi_comm_size(mpi_comm_cols, np_cols, mpierr)
      if(self%is_set("num_process_cols") == 1) then
        call self%get("num_process_cols", present_np_cols, error)
        if(np_cols .ne. present_np_cols) then
          print *,"MPI column communicator not set correctly. Aborting..."
          stop
        endif
      else
        call self%set("num_process_cols", np_cols, error)
      endif

      call mpi_comm_rank(mpi_comm_rows, my_prow, mpierr)
      if(self%is_set("process_row") == 1) then
        call self%get("process_row", present_my_prow, error)
        if(my_prow .ne. present_my_prow) then
          print *,"MPI row communicator not set correctly. Aborting..."
          stop
        endif
      else
        call self%set("process_row", my_prow, error)
      endif

      call mpi_comm_rank(mpi_comm_cols, my_pcol, mpierr)
      if(self%is_set("process_col") == 1) then
        call self%get("process_col", present_my_pcol, error)
        if(my_pcol .ne. present_my_pcol) then
          print *,"MPI column communicator not set correctly. Aborting..."
          stop
        endif
      else
        call self%set("process_col", my_pcol, error)
      endif
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365


      ! sadly, at the moment, the parent mpi communicator is not required to be set, e.g. in legacy tests
      ! we thus cannot obtain process_id
      ! we can, however, determine the number of prcesses and determine, whether the given process has id 0, 
      ! assuming, that that is the wan with row and column ids == 0
      is_process_id_zero = 0
      if (self%is_set("mpi_comm_parent") == 1) then
        call self%get("mpi_comm_parent", mpi_comm_parent, error)

        call mpi_comm_size(mpi_comm_parent, np_total, mpierr)
        if(self%is_set("num_processes") == 1) then
          call self%get("num_processes", present_np_total, error)
          if(np_total .ne. present_np_total) then
            print *,"MPI parent communicator not set correctly. Aborting..."
            stop
          endif
        else
          call self%set("num_processes", np_total, error)
        endif

        if(np_total .ne. np_rows * np_cols) then
          print *,"MPI parent communicator and row/col communicators do not match. Aborting..."
          stop
        endif

        call mpi_comm_rank(mpi_comm_parent, my_id, mpierr)
        if(self%is_set("process_id") == 1) then
          call self%get("process_id", present_my_id, error)
          if(my_id .ne. present_my_id) then
            print *,"MPI parent communicator not set correctly. Aborting..."
            stop
          endif
        else
          call self%set("process_id", my_id, error)
        endif

        if(my_id == 0) &
          is_process_id_zero = 1
      else
        ! we can set number of processes and whether process id is zero, but not the process id.
        ! we assume, that my_pcol == 0 && my_prow == 0  <==> my_id == 0
        call self%set("num_process", np_rows * np_cols, error)
        if((my_prow == 0) .and. (my_pcol == 0)) &
          is_process_id_zero = 1
      endif
        call self%set("is_process_id_zero", is_process_id_zero, error)

366 367
    end subroutine

368 369 370 371
    !> \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
372
    function elpa_setup(self) result(error)
373 374
      class(elpa_impl_t), intent(inout)   :: self
      integer                             :: error, timings
375

376
#ifdef WITH_MPI
377 378 379
      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
380
#endif
381

382
#ifdef HAVE_DETAILED_TIMINGS
Andreas Marek's avatar
Andreas Marek committed
383
      call self%get("timings",timings, error)
384 385 386 387 388 389
      if (timings == 1) then
        call self%timer%enable()
      endif
#endif

      error = ELPA_OK
390

391 392
#ifdef WITH_MPI
      ! Create communicators ourselves
393 394 395
      if (self%is_set("mpi_comm_parent") == 1 .and. &
          self%is_set("process_row") == 1 .and. &
          self%is_set("process_col") == 1) then
396

Andreas Marek's avatar
Andreas Marek committed
397 398 399
        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)
400 401 402 403 404 405 406

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

408 409 410 411 412 413 414 415 416 417 418 419
        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
420

Andreas Marek's avatar
Andreas Marek committed
421 422 423 424 425 426 427 428 429 430
        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
431

432 433
        call set_or_check_missing_comm_params(self)

434 435 436
        ! remember that we created those communicators and we need to free them later
        self%communicators_owned = 1

437
        error = ELPA_OK
438
        return
439
      endif
440

441
      ! Externally supplied communicators
442
      if (self%is_set("mpi_comm_rows") == 1 .and. self%is_set("mpi_comm_cols") == 1) then
443
        call set_or_check_missing_comm_params(self)
444
        self%communicators_owned = 0
445
        error = ELPA_OK
446
        return
447
      endif
448

449 450
      ! Otherwise parameters are missing
      error = ELPA_ERROR
451 452 453 454 455 456 457 458
#else
        call self%set("process_row", 0, error)
        call self%set("process_col", 0, error)
        call self%set("process_id", 0, error)
        call self%set("is_process_id_zero", 1, error)
        call self%set("num_process_rows", 1, error)
        call self%set("num_process_cols", 1, error)
        call self%set("num_processes", 1, error)
459
#endif
460

461
    end function
462

463 464 465 466 467 468
    !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> */
469
    !c> int elpa_setup(elpa_t handle);
470
    function elpa_setup_c(handle) result(error) bind(C, name="elpa_setup")
471 472 473 474 475 476 477 478
      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

479
    function elpa_construct_scalapack_descriptor(self, sc_desc, rectangular_for_ev) result(error)
480
      class(elpa_impl_t), intent(inout)   :: self
481
      logical, intent(in)                 :: rectangular_for_ev
482 483 484 485 486 487 488 489 490 491 492 493 494
      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
495 496 497 498 499
      if(rectangular_for_ev) then
        sc_desc(4) = self%nev
      else
        sc_desc(4) = self%na
      endif
500 501 502 503 504 505 506 507 508 509
      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
510

511 512 513 514 515 516 517 518 519
    !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> */
520
    !c> void elpa_set_integer(elpa_t handle, const char *name, int value, int *error);
521
    subroutine elpa_set_integer_c(handle, name_p, value, error) bind(C, name="elpa_set_integer")
Andreas Marek's avatar
Andreas Marek committed
522 523 524
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
525
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
526 527 528 529 530 531 532
      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
533 534 535 536 537 538 539

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


540 541 542 543 544 545 546 547 548
    !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> */
549 550
    !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
551 552 553
      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
554
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
555 556 557 558 559 560
      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
561 562
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
563 564
      call elpa_get_integer(self, name, value, error)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
565 566


567 568 569 570 571
    !> \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
572 573
    function elpa_is_set(self, name) result(state)
      class(elpa_impl_t)       :: self
574
      character(*), intent(in) :: name
575
      integer                  :: state
576

577
      state = elpa_index_value_is_set_c(self%index, name // c_null_char)
578 579
    end function

580 581 582 583 584 585
    !> \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
586 587 588 589 590 591 592 593 594 595
    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


596 597 598 599 600 601
    !> \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   
602
    function elpa_value_to_string(self, option_name, error) result(string)
603 604
      class(elpa_impl_t), intent(in) :: self
      character(kind=c_char, len=*), intent(in) :: option_name
605 606 607 608
      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
609

610 611
      nullify(string)

612
      call self%get(option_name, val, actual_error)
613 614 615 616 617
      if (actual_error /= ELPA_OK) then
        if (present(error)) then
          error = actual_error
        endif
        return
618 619
      endif

620 621 622 623
      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
624

625 626 627 628
      if (present(error)) then
        error = actual_error
      endif
    end function
629

Andreas Marek's avatar
Andreas Marek committed
630

631 632 633 634 635 636 637 638 639
    !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> */
640
    !c> void elpa_set_double(elpa_t handle, const char *name, double value, int *error);
641
    subroutine elpa_set_double_c(handle, name_p, value, error) bind(C, name="elpa_set_double")
Andreas Marek's avatar
Andreas Marek committed
642 643 644
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
645
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
646 647 648 649 650 651
      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
652 653 654 655 656
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
      call elpa_set_double(self, name, value, error)
    end subroutine

657

658
    !c> /*! \brief C interface for the implementation of the elpa_get_double method
659 660 661 662 663 664 665 666
    !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> */
667 668
    !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
669 670 671
      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
672
      character(len=elpa_strlen_c(name_p)), pointer :: name
Andreas Marek's avatar
Andreas Marek committed
673 674 675 676 677 678
      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
679 680
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
681 682
      call elpa_get_double(self, name, value, error)
    end subroutine
683
 
Andreas Marek's avatar
Andreas Marek committed
684

685 686 687 688 689
    !> \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
690
    function elpa_associate_int(self, name) result(value)
691
      class(elpa_impl_t)             :: self
692 693
      character(*), intent(in)       :: name
      integer(kind=c_int), pointer   :: value
Andreas Marek's avatar
Andreas Marek committed
694

695 696
      type(c_ptr)                    :: value_p

697
      value_p = elpa_index_get_int_loc_c(self%index, name // c_null_char)
698 699 700
      if (.not. c_associated(value_p)) then
        write(error_unit, '(a,a,a)') "ELPA: Warning, received NULL pointer for entry '", name, "'"
      endif
701 702
      call c_f_pointer(value_p, value)
    end function
Andreas Marek's avatar
Andreas Marek committed
703

704

705 706 707 708 709 710 711
    !> \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
712 713 714 715 716 717
    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

718
#ifdef HAVE_DETAILED_TIMINGS
719
      s = self%timer%get(name1, name2, name3, name4, name5, name6)
720 721 722
#else
      s = -1.0
#endif
723 724 725
    end function


726 727 728 729 730
    !> \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
731
    subroutine elpa_print_times(self, name1, name2, name3, name4)
732
      class(elpa_impl_t), intent(in) :: self
733
      character(len=*), intent(in), optional :: name1, name2, name3, name4
734
#ifdef HAVE_DETAILED_TIMINGS
735
      call self%timer%print(name1, name2, name3, name4)
736
#endif
737 738
    end subroutine

739

740 741 742 743
    !> \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
744 745 746 747 748 749 750 751 752
    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


753 754 755 756
    !> \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
757 758 759 760 761 762 763 764 765
    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


766 767 768
    !> \brief function to destroy an elpa object
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
769
    subroutine elpa_destroy(self)
770
#ifdef WITH_MPI
Pavel Kus's avatar
Pavel Kus committed
771 772
      integer :: mpi_comm_rows, mpi_comm_cols, mpierr, mpierr2, error, mpi_string_length
      character(len=MPI_MAX_ERROR_STRING) :: mpierr_string
773
#endif
774
      class(elpa_impl_t) :: self
775 776 777

#ifdef WITH_MPI
      if (self%communicators_owned == 1) then
Andreas Marek's avatar
Andreas Marek committed
778 779 780 781 782 783 784 785 786 787
        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
788

789
        call mpi_comm_free(mpi_comm_rows, mpierr)
Pavel Kus's avatar
Pavel Kus committed
790 791 792 793 794
        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_free for row communicator: ", trim(mpierr_string)
          return
        endif
795
        call mpi_comm_free(mpi_comm_cols, mpierr)
Pavel Kus's avatar
Pavel Kus committed
796 797 798 799 800
        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_free for col communicator: ", trim(mpierr_string)
          return
        endif
801 802 803
      endif
#endif

804
      call timer_free(self%timer)
805
      call timer_free(self%autotune_timer)
806 807
      call elpa_index_free_c(self%index)

808
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
809

Pavel Kus's avatar
Pavel Kus committed
810 811
#define REALCASE 1
#define DOUBLE_PRECISION 1
Andreas Marek's avatar
Andreas Marek committed
812
#define INCLUDE_ROUTINES 1
Pavel Kus's avatar
Pavel Kus committed
813
#include "general/precision_macros.h"
Andreas Marek's avatar
Andreas Marek committed
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
#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
854 855 856 857 858 859 860
#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
861
#include "elpa_impl_generalized_transform_template.F90"
Pavel Kus's avatar
Pavel Kus committed
862 863
#undef REALCASE
#undef SINGLE_PRECISION
Andreas Marek's avatar
Andreas Marek committed
864
#endif
Pavel Kus's avatar
Pavel Kus committed
865 866

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

Pavel Kus's avatar
Pavel Kus committed
868 869
#define DOUBLE_PRECISION 1
#include "general/precision_macros.h"
Andreas Marek's avatar
Andreas Marek committed
870
#include "elpa_impl_generalized_transform_template.F90"
Pavel Kus's avatar
Pavel Kus committed
871 872 873 874 875 876 877
#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
878
#include "elpa_impl_generalized_transform_template.F90"
Pavel Kus's avatar
Pavel Kus committed
879 880
#undef COMPLEXCASE
#undef SINGLE_PRECISION
Andreas Marek's avatar
Andreas Marek committed
881 882
#endif

883 884 885 886 887 888
!    function use_cannons_algorithm(self) result(use_cannon, do_print)
!      class(elpa_impl_t), intent(inout), target :: self
!      logical                                   :: use_cannon
!      logical, intent(in)                       :: do_print
!    end function
!
Andreas Marek's avatar
Andreas Marek committed
889
#ifdef ENABLE_AUTOTUNING
890 891
    !> \brief function to setup the ELPA autotuning and create the autotune object
    !> Parameters
892
    !> \param   self            the allocated ELPA object
893 894
    !> \param   level           integer: the "thoroughness" of the planed autotuning
    !> \param   domain          integer: the domain (real/complex) which should be tuned
895
    !> \result  tune_state      the created autotuning object
896
    function elpa_autotune_setup(self, level, domain, error) result(tune_state)
897
      class(elpa_impl_t), intent(inout), target :: self
Andreas Marek's avatar
Andreas Marek committed
898 899 900
      integer, intent(in)                       :: level, domain
      type(elpa_autotune_impl_t), pointer       :: ts_impl
      class(elpa_autotune_t), pointer           :: tune_state
901 902 903 904 905
#ifdef USE_FORTRAN2008
      integer(kind=c_int), optional             :: error
#else
      integer(kind=c_int)                       :: error
#endif
906

907 908 909 910 911 912 913
#ifdef USE_FORTRAN2008
      if (present(error)) then
        error = ELPA_OK
      endif
#else
      error = ELPA_OK
#endif
Andreas Marek's avatar
Andreas Marek committed
914
      if (elpa_get_api_version() < EARLIEST_AUTOTUNE_VERSION) then
915 916 917 918 919 920 921 922 923
        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
924 925
      endif

926 927 928 929 930
      allocate(ts_impl)
      ts_impl%parent => self
      ts_impl%level = level
      ts_impl%domain = domain

931
      ts_impl%current = -1
932
      ts_impl%min_loc = -1
933
      ts_impl%cardinality = elpa_index_autotune_cardinality_c(self%index, level, domain)
934 935 936 937 938 939 940

      tune_state => ts_impl

      call self%autotune_timer%enable()
    end function


Andreas Marek's avatar
Andreas Marek committed
941

942 943 944 945 946 947 948
    !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> */
949 950
    !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")
951 952 953 954 955 956 957
      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
958 959 960 961 962
#ifdef USE_FORTRAN2008
      integer(kind=c_int) , intent(in), optional    :: error
#else
      integer(kind=c_int) , intent(in)              :: error
#endif
963 964

      call c_f_pointer(handle, self)
965

966
      tune_state => self%autotune_setup(level, domain, error)
967
      select type(tune_state)
968
        type is (elpa_autotune_impl_t)
969 970 971
          obj => tune_state
        class default
          print *, "This should not happen"
972
          stop
973 974
      end select                
      ptr = c_loc(obj)
975

976
    end function
977 978


979 980 981 982 983
    !> \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)
984 985 986 987 988 989 990 991 992 993
    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)
994
        type is (elpa_autotune_impl_t)
995 996 997 998 999 1000 1001
          ts_impl => tune_state
        class default
          print *, "This should not happen"
      end select

      unfinished = .false.

1002
      if (ts_impl%current >= 0) then
1003
#ifdef HAVE_DETAILED_TIMINGS
1004
        time_spent = self%autotune_timer%get("accumulator")
1005 1006
#else
        print *, "Cannot do autotuning without detailed timings"
1007
#endif
1008 1009
        if (ts_impl%min_loc == -1 .or. (time_spent < ts_impl%min_val)) then
          ts_impl%min_val = time_spent
1010
          ts_impl%min_loc = ts_impl%current
1011 1012 1013 1014
        end if
        call self%autotune_timer%free()
      endif

1015 1016 1017
      do while (ts_impl%current < ts_impl%cardinality - 1)
        ts_impl%current = ts_impl%current + 1
        if (elpa_index_set_autotune_parameters_c(self%index, ts_impl%level, ts_impl%domain, ts_impl%current) == 1) then
1018 1019 1020 1021 1022 1023 1024 1025
          unfinished = .true.
          return
        end if
      end do

    end function


1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055

    !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



1056 1057 1058 1059
    !> \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
1060 1061 1062 1063 1064 1065 1066
    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)
1067
        type is (elpa_autotune_impl_t)
1068 1069 1070 1071 1072 1073 1074 1075 1076
          ts_impl => tune_state
        class default
          print *, "This should not happen"
      end select

      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
1077

1078 1079


1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
    !> \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
Pavel Kus's avatar
Pavel Kus committed
1099
      flush(output_unit)
1100
      if (elpa_index_print_autotune_parameters_c(self%index, ts_impl%level, ts_impl%domain) /= 1) then
1101 1102 1103 1104 1105
        stop "This should not happen (in elpa_autotune_print_best())"
      endif
    end subroutine


Pavel Kus's avatar
Pavel Kus committed
1106 1107 1108
    !> \brief function to print all the parameters, that have been set
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
1109
    subroutine elpa_print_settings(self)
Pavel Kus's avatar
Pavel Kus committed
1110 1111 1112
      implicit none
      class(elpa_impl_t), intent(inout) :: self

1113 1114
      if (elpa_index_print_settings_c(self%index, c_null_char) /= 1) then
        stop "This should not happen (in elpa_print_settings())"
Pavel Kus's avatar
Pavel Kus committed
1115 1116 1117
      endif
    end subroutine

Pavel Kus's avatar
Pavel Kus committed
1118 1119 1120 1121
    !> \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
1122
    subroutine elpa_store_settings(self, file_name)
Pavel Kus's avatar
Pavel Kus committed
1123 1124
      implicit none
      class(elpa_impl_t), intent(inout) :: self
Pavel Kus's avatar
Pavel Kus committed
1125
      character(*), intent(in)          :: file_name
Pavel Kus's avatar
Pavel Kus committed
1126

1127 1128
      if (elpa_index_print_settings_c(self%index, file_name // c_null_char) /= 1) then
        stop "This should not happen (in elpa_store_settings())"
Pavel Kus's avatar
Pavel Kus committed
1129 1130 1131
      endif
    end subroutine

Pavel Kus's avatar
Pavel Kus committed
1132 1133 1134 1135
    !> \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
1136
    subroutine elpa_load_settings(self, file_name)
Pavel Kus's avatar
Pavel Kus committed
1137 1138 1139 1140
      implicit none
      class(elpa_impl_t), intent(inout) :: self
      character(*), intent(in)          :: file_name

1141 1142
      if (elpa_index_load_settings_c(self%index, file_name // c_null_char) /= 1) then
        stop "This should not happen (in elpa_load_settings())"
Pavel Kus's avatar
Pavel Kus committed
1143 1144 1145
      endif
    end subroutine

Pavel Kus's avatar
Pavel Kus committed
1146

Pavel Kus's avatar
Pavel Kus committed
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
    !> \brief function to print the state 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_state(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

      if (elpa_index_print_autotune_state_c(self%index, ts_impl%level, ts_impl%domain, ts_impl%min_loc, &
1165
                  ts_impl%min_val, ts_impl%current, ts_impl%cardinality, c_null_char) /= 1) then
Pavel Kus's avatar
Pavel Kus committed
1166 1167 1168 1169
        stop "This should not happen (in elpa_autotune_print_state())"
      endif
    end subroutine

1170

1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
    !> \brief function to save the state of the autotuning
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
    !> \param   tune_state      class(elpa_autotune_t): the autotuning object
    !> \param   file_name       string, the name of the file where to save the state
    subroutine elpa_autotune_save_state(self, tune_state, file_name)
      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
      character(*), intent(in)        :: file_name

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

      if (elpa_index_print_autotune_state_c(self%index, ts_impl%level, ts_impl%domain, ts_impl%min_loc, &
                  ts_impl%min_val, ts_impl%current, ts_impl%cardinality, file_name // c_null_char) /= 1) then
        stop "This should not happen (in elpa_autotune_save_state())"
      endif
    end subroutine


1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
    !> \brief function to load the state of the autotuning
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
    !> \param   tune_state      class(elpa_autotune_t): the autotuning object
    !> \param   file_name       string, the name of the file from which to load the state
    subroutine elpa_autotune_load_state(self, tune_state, file_name)
      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
      character(*), intent(in)        :: file_name

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

      print *, "testing, before C call, ts_impl%current is ", ts_impl%current

      if (elpa_index_load_autotune_state_c(self%index, ts_impl%level, ts_impl%domain, ts_impl%min_loc, &
                  ts_impl%min_val, ts_impl%current, ts_impl%cardinality, file_name // c_null_char) /= 1) then
        stop "This should not happen (in elpa_autotune_load_state())"
      endif
      print *, "testing, after C call, ts_impl%current is ", ts_impl%current
    end subroutine


1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
    !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
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266



    !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
1267
#endif
1268 1269


1270
end module