elpa_impl.F90 60.2 KB
Newer Older
1 2 3
!
!    Copyright 2017, L. Hüdepohl and A. Marek, MPCDF
!
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
61
#ifdef ENABLE_AUTOTUNING
62
  use elpa_autotune_impl
63
#endif
64
  use, intrinsic :: iso_c_binding
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
160
     procedure, public :: load_settings => elpa_load_settings
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
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
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)
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
        if(present(error)) then
191
          error = ELPA_ERROR_API_VERSION
192
        endif
Andreas Marek's avatar
Andreas Marek committed
193 194
        return
      endif
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
209

Andreas Marek's avatar
Andreas Marek committed
210

211 212 213 214 215
    !c> /*! \brief C interface for the implementation of the elpa_allocate method
    !c> *
    !c> *  \param  none
    !c> *  \result elpa_t handle
    !c> */
216
    !c> elpa_t elpa_allocate(int *error);
217
    function elpa_impl_allocate_c(error) result(ptr) bind(C, name="elpa_allocate")
218 219 220 221 222 223 224 225
      integer(kind=c_int) :: error
      type(c_ptr) :: ptr
      type(elpa_impl_t), pointer :: obj

      obj => elpa_impl_allocate(error)
      ptr = c_loc(obj)
    end function

Andreas Marek's avatar
Andreas Marek committed
226

227 228 229 230 231
    !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> */
232
    !c> void elpa_deallocate(elpa_t handle);
233
    subroutine elpa_impl_deallocate_c(handle) bind(C, name="elpa_deallocate")
234 235 236 237 238 239 240 241
      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
242

243
#ifdef ENABLE_AUTOTUNING
244 245 246 247 248
    !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> */
249 250 251
    !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
252

253 254 255
      type(elpa_autotune_impl_t), pointer :: self

      call c_f_pointer(autotune_handle, self)
256 257 258
      call self%destroy()
      deallocate(self)
    end subroutine
259
#endif
260

Andreas Marek's avatar
Andreas Marek committed
261

262 263 264 265 266 267
    ! 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
268 269 270
      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, &
271
                                             is_process_id_zero, gpu
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 318 319 320 321
      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
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


      ! 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
362 363 364 365 366 367 368 369 370 371
        ! for the GPU calculation, the parent communicator has to be set
        call self%get("gpu",gpu,error)
        if (error .ne. ELPA_OK) then
          print *,"Problem getting option. Aborting..."
          stop
        endif
        if(gpu == 1) then
          print *,"MPI parent communicator has to be set for GPU calculation. Aborting..."
          stop
        endif
372 373 374 375 376 377 378 379
        ! 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)

380 381
    end subroutine

Andreas Marek's avatar
Andreas Marek committed
382

383 384 385 386
    !> \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
387
    function elpa_setup(self) result(error)
388 389
      class(elpa_impl_t), intent(inout)   :: self
      integer                             :: error, timings
390

391
#ifdef WITH_MPI
392 393 394
      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
395
#endif
396

397
#ifdef HAVE_DETAILED_TIMINGS
398
      call self%get("timings",timings, error)
399 400 401 402 403 404
      if (timings == 1) then
        call self%timer%enable()
      endif
#endif

      error = ELPA_OK
405

406 407
#ifdef WITH_MPI
      ! Create communicators ourselves
408 409 410
      if (self%is_set("mpi_comm_parent") == 1 .and. &
          self%is_set("process_row") == 1 .and. &
          self%is_set("process_col") == 1) then
411

412 413 414
        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)
415 416 417 418 419 420 421

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

423 424 425 426 427 428 429 430 431 432 433 434
        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
435

436 437 438 439 440 441 442 443 444 445
        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
446

447 448
        call set_or_check_missing_comm_params(self)

449 450 451
        ! remember that we created those communicators and we need to free them later
        self%communicators_owned = 1

452
        error = ELPA_OK
453
        return
454
      endif
455

456
      ! Externally supplied communicators
457
      if (self%is_set("mpi_comm_rows") == 1 .and. self%is_set("mpi_comm_cols") == 1) then
458 459 460 461 462 463 464 465 466 467 468 469
        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
        !write(error_unit, '(A,2I15)') "comms provided", mpi_comm_rows, mpi_comm_cols

470
        call set_or_check_missing_comm_params(self)
471
        self%communicators_owned = 0
472
        error = ELPA_OK
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487

        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
        call self%get("process_row", process_row, error)
        call self%get("process_col", process_col, error)
        !write(error_unit, '(A,2I15,2I4)') "comms provided II ", mpi_comm_rows, mpi_comm_cols, process_row, process_col

488
        return
489
      endif
490

491 492
      ! Otherwise parameters are missing
      error = ELPA_ERROR
493 494 495 496 497 498 499 500
#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)
501
#endif
502

503
    end function
504

Andreas Marek's avatar
Andreas Marek committed
505

506 507 508 509 510 511
    !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> */
512
    !c> int elpa_setup(elpa_t handle);
513
    function elpa_setup_c(handle) result(error) bind(C, name="elpa_setup")
514 515 516 517 518 519 520 521
      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

522
    function elpa_construct_scalapack_descriptor(self, sc_desc, rectangular_for_ev) result(error)
523
      class(elpa_impl_t), intent(inout)   :: self
524
      logical, intent(in)                 :: rectangular_for_ev
525 526 527 528 529 530 531 532 533 534 535 536 537
      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
538 539 540 541 542
      if(rectangular_for_ev) then
        sc_desc(4) = self%nev
      else
        sc_desc(4) = self%na
      endif
543 544 545 546 547 548 549 550 551 552
      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
553

Andreas Marek's avatar
Andreas Marek committed
554

555 556 557 558 559 560 561 562 563
    !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> */
564
    !c> void elpa_set_integer(elpa_t handle, const char *name, int value, int *error);
565
    subroutine elpa_set_integer_c(handle, name_p, value, error) bind(C, name="elpa_set_integer")
566 567 568
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
569
      character(len=elpa_strlen_c(name_p)), pointer :: name
570 571
      integer(kind=c_int), intent(in), value        :: value
      integer(kind=c_int) , intent(in)              :: error
572 573 574 575 576 577 578

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


579 580 581 582 583 584 585 586 587
    !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> */
588 589
    !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")
590 591 592
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
593
      character(len=elpa_strlen_c(name_p)), pointer :: name
594 595
      integer(kind=c_int)                           :: value
      integer(kind=c_int), intent(inout)            :: error
596
 
597 598
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
599 600
      call elpa_get_integer(self, name, value, error)
    end subroutine
601 602


603 604 605 606 607
    !> \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
608 609
    function elpa_is_set(self, name) result(state)
      class(elpa_impl_t)       :: self
610
      character(*), intent(in) :: name
611
      integer                  :: state
612

613
      state = elpa_index_value_is_set_c(self%index, name // c_null_char)
614 615
    end function

616 617 618 619 620 621
    !> \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
622 623 624 625 626 627 628 629 630 631
    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


632 633 634 635 636 637
    !> \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   
638
    function elpa_value_to_string(self, option_name, error) result(string)
639 640
      class(elpa_impl_t), intent(in) :: self
      character(kind=c_char, len=*), intent(in) :: option_name
641 642 643 644
      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
645

646 647
      nullify(string)

648
      call self%get(option_name, val, actual_error)
649 650 651 652 653
      if (actual_error /= ELPA_OK) then
        if (present(error)) then
          error = actual_error
        endif
        return
654 655
      endif

656 657 658 659
      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
660

661 662 663 664
      if (present(error)) then
        error = actual_error
      endif
    end function
665

666

667 668 669 670 671 672 673 674 675
    !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> */
676
    !c> void elpa_set_double(elpa_t handle, const char *name, double value, int *error);
677
    subroutine elpa_set_double_c(handle, name_p, value, error) bind(C, name="elpa_set_double")
678 679 680
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
681
      character(len=elpa_strlen_c(name_p)), pointer :: name
682 683
      real(kind=c_double), intent(in), value        :: value
      integer(kind=c_int), intent(in)               :: error
684

685 686 687 688 689
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
      call elpa_set_double(self, name, value, error)
    end subroutine

690

691
    !c> /*! \brief C interface for the implementation of the elpa_get_double method
692 693 694 695 696 697 698 699
    !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> */
700 701
    !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")
702 703 704
      type(c_ptr), intent(in), value                :: handle
      type(elpa_impl_t), pointer                    :: self
      type(c_ptr), intent(in), value                :: name_p
705
      character(len=elpa_strlen_c(name_p)), pointer :: name
706 707
      real(kind=c_double)                           :: value
      integer(kind=c_int), intent(inout)            :: error
708

709 710
      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
711 712
      call elpa_get_double(self, name, value, error)
    end subroutine
713
 
714

715 716 717 718 719
    !> \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
720
    function elpa_associate_int(self, name) result(value)
721
      class(elpa_impl_t)             :: self
722 723
      character(*), intent(in)       :: name
      integer(kind=c_int), pointer   :: value
724

725 726
      type(c_ptr)                    :: value_p

727
      value_p = elpa_index_get_int_loc_c(self%index, name // c_null_char)
728 729 730
      if (.not. c_associated(value_p)) then
        write(error_unit, '(a,a,a)') "ELPA: Warning, received NULL pointer for entry '", name, "'"
      endif
731 732
      call c_f_pointer(value_p, value)
    end function
733

734

735 736 737 738 739 740 741
    !> \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
742 743 744 745 746 747
    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

748
#ifdef HAVE_DETAILED_TIMINGS
749
      s = self%timer%get(name1, name2, name3, name4, name5, name6)
750 751 752
#else
      s = -1.0
#endif
753 754 755
    end function


756 757 758 759 760
    !> \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
761
    subroutine elpa_print_times(self, name1, name2, name3, name4)
762
      class(elpa_impl_t), intent(in) :: self
763
      character(len=*), intent(in), optional :: name1, name2, name3, name4
764
#ifdef HAVE_DETAILED_TIMINGS
765
      call self%timer%print(name1, name2, name3, name4)
766
#endif
767 768
    end subroutine

769

770 771 772 773
    !> \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
774 775 776 777 778 779 780 781 782
    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


783 784 785 786
    !> \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
787 788 789 790 791 792 793 794 795
    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


796 797 798
    !> \brief function to destroy an elpa object
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
799
    subroutine elpa_destroy(self)
800
#ifdef WITH_MPI
801 802
      integer :: mpi_comm_rows, mpi_comm_cols, mpierr, mpierr2, error, mpi_string_length
      character(len=MPI_MAX_ERROR_STRING) :: mpierr_string
803
#endif
804
      class(elpa_impl_t) :: self
805 806 807

#ifdef WITH_MPI
      if (self%communicators_owned == 1) then
808 809 810 811 812 813 814 815 816 817
        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
818

819
        write(error_unit, '(A,2I13)') "FREE comms", mpi_comm_rows, mpi_comm_cols
820
        call mpi_comm_free(mpi_comm_rows, mpierr)
821 822 823 824 825
        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
826
        call self%set("mpi_comm_cols", -12345,error)
827
        call mpi_comm_free(mpi_comm_cols, mpierr)
828 829 830 831 832
        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
833
        call self%set("mpi_comm_rows", -12345,error)
834 835 836
      endif
#endif

837
      call timer_free(self%timer)
838
      call timer_free(self%autotune_timer)
839 840
      call elpa_index_free_c(self%index)

841
    end subroutine
842

Pavel Kus's avatar
Pavel Kus committed
843 844
#define REALCASE 1
#define DOUBLE_PRECISION 1
Andreas Marek's avatar
Andreas Marek committed
845
#define INCLUDE_ROUTINES 1
Pavel Kus's avatar
Pavel Kus committed
846
#include "general/precision_macros.h"
Andreas Marek's avatar
Andreas Marek committed
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
#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
887 888 889 890 891 892 893
#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
894
#include "elpa_impl_generalized_transform_template.F90"
Pavel Kus's avatar
Pavel Kus committed
895 896
#undef REALCASE
#undef SINGLE_PRECISION
Andreas Marek's avatar
Andreas Marek committed
897
#endif
Pavel Kus's avatar
Pavel Kus committed
898 899

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

Pavel Kus's avatar
Pavel Kus committed
901 902
#define DOUBLE_PRECISION 1
#include "general/precision_macros.h"
Andreas Marek's avatar
Andreas Marek committed
903
#include "elpa_impl_generalized_transform_template.F90"
Pavel Kus's avatar
Pavel Kus committed
904 905 906 907 908 909 910
#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
911
#include "elpa_impl_generalized_transform_template.F90"
Pavel Kus's avatar
Pavel Kus committed
912 913
#undef COMPLEXCASE
#undef SINGLE_PRECISION
Andreas Marek's avatar
Andreas Marek committed
914 915
#endif

Andreas Marek's avatar
Andreas Marek committed
916

917 918 919 920 921 922
!    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
!
923
#ifdef ENABLE_AUTOTUNING
924 925
    !> \brief function to setup the ELPA autotuning and create the autotune object
    !> Parameters
926
    !> \param   self            the allocated ELPA object
927 928
    !> \param   level           integer: the "thoroughness" of the planed autotuning
    !> \param   domain          integer: the domain (real/complex) which should be tuned
929
    !> \result  tune_state      the created autotuning object
930
    function elpa_autotune_setup(self, level, domain, error) result(tune_state)
931
      class(elpa_impl_t), intent(inout), target :: self
932 933 934
      integer, intent(in)                       :: level, domain
      type(elpa_autotune_impl_t), pointer       :: ts_impl
      class(elpa_autotune_t), pointer           :: tune_state
935 936 937 938 939
#ifdef USE_FORTRAN2008
      integer(kind=c_int), optional             :: error
#else
      integer(kind=c_int)                       :: error
#endif
940

941 942 943 944 945 946 947
#ifdef USE_FORTRAN2008
      if (present(error)) then
        error = ELPA_OK
      endif
#else
      error = ELPA_OK
#endif
948
      if (elpa_get_api_version() < EARLIEST_AUTOTUNE_VERSION) then
949 950 951
        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
952
          error = ELPA_ERROR_AUTOTUNE_API_VERSION
953 954
        endif
#else
955
        error = ELPA_ERROR_AUTOTUNE_API_VERSION
956 957
#endif
        return
958 959
      endif

960 961 962 963 964
      allocate(ts_impl)
      ts_impl%parent => self
      ts_impl%level = level
      ts_impl%domain = domain

965
      ts_impl%current = -1
966
      ts_impl%min_loc = -1
967
      ts_impl%cardinality = elpa_index_autotune_cardinality_c(self%index, level, domain)
968 969 970 971 972 973 974

      tune_state => ts_impl

      call self%autotune_timer%enable()
    end function


975

976 977 978 979 980 981 982
    !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> */
983 984
    !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")
985 986 987 988 989 990 991
      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
992
      integer(kind=c_int) , intent(in)       :: error
993 994

      call c_f_pointer(handle, self)
995

996
      tune_state => self%autotune_setup(level, domain, error)
997
      select type(tune_state)
998
        type is (elpa_autotune_impl_t)
999 1000 1001
          obj => tune_state
        class default
          print *, "This should not happen"
1002
          stop
1003 1004
      end select                
      ptr = c_loc(obj)
1005

1006
    end function
1007 1008


1009 1010 1011 1012 1013
    !> \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)
1014
    function elpa_autotune_step(self, tune_state, error) result(unfinished)
1015
      implicit none
1016
      class(elpa_impl_t), intent(inout)             :: self
1017
      class(elpa_autotune_t), intent(inout), target :: tune_state
1018
      type(elpa_autotune_impl_t), pointer           :: ts_impl
Andreas Marek's avatar
Andreas Marek committed
1019 1020 1021 1022 1023 1024 1025 1026
#ifdef USE_FORTRAN2008
      integer(kind=c_int), optional, intent(out)    :: error
#else
      integer(kind=c_int),  intent(out)             :: error
#endif
      logical                                       :: unfinished
      integer                                       :: i
      real(kind=C_DOUBLE)                           :: time_spent
1027

1028 1029 1030
      if (present(error)) then
        error = ELPA_OK
      endif
1031
      select type(tune_state)
1032
        type is (elpa_autotune_impl_t)
1033 1034 1035
          ts_impl => tune_state
        class default
          print *, "This should not happen"
1036 1037 1038
          if (present(error)) then
            error = ELPA_OK
          endif
1039 1040 1041 1042
      end select

      unfinished = .false.

1043
      if (ts_impl%current >= 0) then
1044
#ifdef HAVE_DETAILED_TIMINGS
1045
        time_spent = self%autotune_timer%get("accumulator")
1046 1047
#else
        print *, "Cannot do autotuning without detailed timings"
1048 1049 1050 1051 1052

        if (present(error)) then
          error = ELPA_OK
          return
        endif
1053
#endif
1054 1055
        if (ts_impl%min_loc == -1 .or. (time_spent < ts_impl%min_val)) then
          ts_impl%min_val = time_spent
1056
          ts_impl%min_loc = ts_impl%current
1057 1058 1059 1060
        end if
        call self%autotune_timer%free()
      endif

1061 1062 1063
      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
1064 1065 1066 1067 1068 1069 1070 1071
          unfinished = .true.
          return
        end if
      end do

    end function


1072

1073 1074 1075 1076 1077 1078 1079
    !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> *  \param  error            int *error code
    !c> *  \result int              unfinished:  describes whether autotuning finished (0) or not (1)
    !c> */
Andreas Marek's avatar
Andreas Marek committed
1080 1081 1082
    !c> int elpa_autotune_step(elpa_t handle, elpa_autotune_t autotune_handle, int *error);
    function elpa_autotune_step_c(handle, autotune_handle, &
                    error) result(unfinished) bind(C, name="elpa_autotune_step")
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
      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
      integer(kind=c_int)                  :: error

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

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

    end function
1102

1103 1104 1105 1106
    !> \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
1107 1108
    !> \param   error code      optional, integer
    subroutine elpa_autotune_set_best(self, tune_state, error)
1109
      implicit none
1110
      class(elpa_impl_t), intent(inout)          :: self
1111
      class(elpa_autotune_t), intent(in), target :: tune_state
1112
      type(elpa_autotune_impl_t), pointer        :: ts_impl
Andreas Marek's avatar
Andreas Marek committed
1113
#ifdef USE_FORTRAN2008
1114
      integer(kind=ik), optional, intent(out)    :: error
Andreas Marek's avatar
Andreas Marek committed
1115 1116 1117
#else
      integer(kind=ik), intent(out)              :: error
#endif
1118 1119 1120
      if (present(error)) then
        error = ELPA_OK
      endif
1121
      select type(tune_state)
1122
        type is (elpa_autotune_impl_t)
1123 1124
          ts_impl => tune_state
        class default
1125
          write(error_unit, *) "This should not happen! Critical error"
1126
          if (present(error)) then
1127
            error = ELPA_ERROR_CRITICAL
1128
          endif
1129 1130 1131
      end select

      if (elpa_index_set_autotune_parameters_c(self%index, ts_impl%level, ts_impl%domain, ts_impl%min_loc) /= 1) then
1132
        write(error_unit, *) "This should not happen (in elpa_autotune_set_best())"
1133
        if (present(error)) then
1134
          error = ELPA_ERROR_AUTOTUNE_OBJECT_CHANGED
1135
        endif
1136 1137
      endif
    end subroutine
1138

1139 1140


1141 1142 1143 1144
    !> \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
1145
    !> \param   error           integer, optional
1146
    subroutine elpa_autotune_print_best(self, tune_state, error)
1147
      implicit none
1148
      class(elpa_impl_t), intent(inout)          :: self
1149
      class(elpa_autotune_t), intent(in), target :: tune_state
1150
      type(elpa_autotune_impl_t), pointer        :: ts_impl
Andreas Marek's avatar
Andreas Marek committed
1151 1152 1153 1154 1155
#ifdef USE_FORTRAN2008
      integer(kind=c_int), optional, intent(out) :: error
#else
      integer(kind=c_int),  intent(out)          :: error
#endif
1156 1157 1158
      if (present(error)) then
        error = ELPA_OK
      endif
1159 1160 1161 1162
      select type(tune_state)
        type is (elpa_autotune_impl_t)
          ts_impl => tune_state
        class default
1163
          write(error_unit, *) "This should not happen! Critical error"
1164
          if (present(error)) then
1165
            error = ELPA_ERROR_CRITICAL
1166
          endif
1167 1168
      end select

1169 1170
      !print *, "The following settings were found to be best:"
      !print *, "Best, i = ", ts_impl%min_loc, "best time = ", ts_impl%min_val
1171
      flush(output_unit)
1172
      if (elpa_index_print_autotune_parameters_c(self%index, ts_impl%level, ts_impl%domain) /= 1) then
1173
        write(error_unit, *) "This should not happen (in elpa_autotune_print_best())"
1174
        if (present(error)) then
1175
          error = ELPA_ERROR_AUTOTUNE_OBJECT_CHANGED
1176
        endif
1177 1178 1179 1180
      endif
    end subroutine


Pavel Kus's avatar
Pavel Kus committed
1181 1182 1183
    !> \brief function to print all the parameters, that have been set
    !> Parameters
    !> \param   self            class(elpa_impl_t) the allocated ELPA object
1184 1185
    !> \param   error           optional, integer
    subroutine elpa_print_settings(self, error)
Pavel Kus's avatar
Pavel Kus committed
1186 1187
      implicit none
      class(elpa_impl_t), intent(inout) :: self
Andreas Marek's avatar
Andreas Marek committed
1188 1189 1190 1191 1192
#ifdef USE_FORTRAN2008
      integer(kind=c_int), optional, intent(out)    :: error
#else
      integer(kind=c_int), intent(out)              :: error
#endif
1193 1194 1195
      if (present(error)) then
        error = ELPA_OK
      endif
1196
      if (elpa_index_print_settings_c(self%index, c_null_char) /= 1) then
1197
        write(error_unit, *) "This should not happen (in elpa_print_settings())"
1198 1199 1200
        if (present(error)) then
          error = ELPA_ERROR
        endif
Pavel Kus's avatar
Pavel Kus committed
1201 1202 1203
      endif
    end subroutine

1204 1205 1206 1207 1208
    !c> /*! \brief C interface for the implementation of the elpa_print_settings method
    !c> *
    !c> *  \param elpa_t handle
    !c> *  \param  char* filename
    !c> */
Andreas Marek's avatar
Andreas Marek committed
1209 1210 1211 1212 1213 1214
    !c> void elpa_print_settings(elpa_t handle, int *error);
    subroutine elpa_print_settings_c(handle, error) bind(C, name="elpa_print_settings")
      type(c_ptr), value         :: handle
      type(elpa_impl_t), pointer :: self
 
      integer(kind=c_int)        :: error
1215

Andreas Marek's avatar
Andreas Marek committed
1216 1217
      call c_f_pointer(handle, self)
      call elpa_print_settings(self, error)
1218

Andreas Marek's avatar
Andreas Marek committed
1219
    end subroutine
1220 1221


Pavel Kus's avatar
Pavel Kus committed
1222 1223
    !> \brief function to save all the parameters, that have been set
    !> Parameters
1224
    !> \param   self        class(elpa_impl_t) the allocated ELPA object
Pavel Kus's avatar
Pavel Kus committed
1225
    !> \param   file_name   string, the name of the file where to save the parameters
1226 1227
    !> \param   error       integer, optional
    subroutine elpa_store_settings(self, file_name, error)
Pavel Kus's avatar
Pavel Kus committed
1228 1229
      implicit none
      class(elpa_impl_t), intent(inout) :: self
Pavel Kus's avatar
Pavel Kus committed
1230
      character(*), intent(in)          :: file_name
Andreas Marek's avatar
Andreas Marek committed
1231 1232 1233 1234 1235
#ifdef USE_FORTRAN2008
      integer(kind=c_int), optional, intent(out)    :: error
#else
      integer(kind=c_int), intent(out)              :: error
#endif
Pavel Kus's avatar
Pavel Kus committed
1236

1237 1238 1239
      if (present(error)) then
        error = ELPA_OK
      endif
1240
      if (elpa_index_print_settings_c(self%index, file_name // c_null_char) /= 1) then
1241
        write(error_unit, *) "This should not happen (in elpa_store_settings())"
1242 1243 1244 1245
        if (present(error)) then
          error = ELPA_ERROR
        endif

Pavel Kus's avatar
Pavel Kus committed
1246 1247 1248
      endif
    end subroutine

Andreas Marek's avatar
Andreas Marek committed
1249
    !c> /*! \brief C interface for the implementation of the elpa_store_settings method
1250 1251 1252 1253
    !c> *
    !c> *  \param elpa_t handle
    !c> *  \param  char* filename
    !c> */
Andreas Marek's avatar
Andreas Marek committed
1254 1255 1256 1257 1258 1259 1260
    !c> void elpa_store_settings(elpa_t handle, const char *filename, int *error);
    subroutine elpa_store_settings_c(handle, filename_p, error) bind(C, name="elpa_store_settings")
      type(c_ptr), value         :: handle
      type(elpa_impl_t), pointer :: self
      type(c_ptr), intent(in)    :: filename_p
      character(len=elpa_strlen_c(filename_p)), pointer :: filename
      integer(kind=c_int)        :: error
1261

Andreas Marek's avatar
Andreas Marek committed
1262 1263 1264
      call c_f_pointer(handle, self)
      call c_f_pointer(filename_p, filename)
      call elpa_store_settings(self, filename, error)
1265

Andreas Marek's avatar
Andreas Marek committed
1266
    end subroutine
1267 1268


Pavel Kus's avatar
Pavel Kus committed
1269 1270
    !> \brief function to load all the parameters, which have been saved to a file
    !> Parameters
1271
    !> \param   self        class(elpa_impl_t) the allocated ELPA object
Pavel Kus's avatar
Pavel Kus committed
1272
    !> \param   file_name   string, the name of the file from which to load the parameters
1273 1274
    !> \param   error       integer, optional
    subroutine elpa_load_settings(self, file_name, error)
Pavel Kus's avatar
Pavel Kus committed
1275 1276 1277
      implicit none
      class(elpa_impl_t), intent(inout) :: self
      character(*), intent(in)          :: file_name
Andreas Marek's avatar
Andreas Marek committed
1278 1279 1280 1281 1282
#ifdef USE_FORTRAN2008
      integer(kind=c_int), optional, intent(out)    :: error
#else
      integer(kind=c_int), intent(out)              :: error
#endif
1283 1284 1285
      if (present(error)) then
        error = ELPA_OK
      endif
1286
      if (elpa_index_load_settings_c(self%index, file_name // c_null_char) /= 1) then
1287
        write(error_unit, *) "This should not happen (in elpa_load_settings())"
1288 1289 1290
        if (present(error)) then
          error = ELPA_ERROR
        endif
Pavel Kus's avatar
Pavel Kus committed
1291 1292 1293
      endif
    end subroutine

1294 1295 1296 1297 1298
    !c> /*! \brief C interface for the implementation of the elpa_load_settings method
    !c> *
    !c> *  \param elpa_t handle
    !c> *  \param  char* filename
    !c> */
Andreas Marek's avatar
Andreas Marek committed
1299 1300 1301 1302 1303 1304 1305 1306
    !c> void elpa_load_settings(elpa_t handle, const char *filename, int *error);
    subroutine elpa_load_settings_c(handle, filename_p, error) bind(C, name="elpa_load_settings")
      type(c_ptr), value         :: handle
      type(elpa_impl_t), pointer :: self

      integer(kind=c_int)        :: error
      type(c_ptr), intent(in)    :: filename_p
      character(len=elpa_strlen_c(filename_p)), pointer :: filename
1307

Andreas Marek's avatar
Andreas Marek committed
1308 1309 1310
      call c_f_pointer(handle, self)
      call c_f_pointer(filename_p, filename)
      call elpa_load_settings(self, filename, error)
1311

Andreas Marek's avatar
Andreas Marek committed
1312
    end subroutine
1313