elpa_impl.F90 77.4 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
  use elpa_abstract_impl
53
  use, intrinsic :: iso_c_binding
54
  implicit none
55

56
57
  private
  public :: elpa_impl_allocate
58

59
!> \brief Definition of the extended elpa_impl_t type
60
  type, extends(elpa_abstract_impl_t) :: elpa_impl_t
Andreas Marek's avatar
Andreas Marek committed
61
   private
62
   type(c_ptr)         :: index = C_NULL_PTR
63

64
   !> \brief methods available with the elpa_impl_t type
65
   contains
66
     !> \brief the puplic methods
67
     ! con-/destructor
68
69
     procedure, public :: setup => elpa_setup                   !< a setup method: implemented in elpa_setup
     procedure, public :: destroy => elpa_destroy               !< a destroy method: implemented in elpa_destroy
70

71
     ! KV store
72
73
74
75
     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
76

77
78
79
80
81
82

     ! timer
     procedure, public :: get_time => elpa_get_time
     procedure, public :: print_times => elpa_print_times


83
     !> \brief the private methods
84

85
     procedure, private :: elpa_set_integer                     !< private methods to implement the setting of an integer/double key/value pair
86
     procedure, private :: elpa_set_double
87

88
89
90
     procedure, private :: elpa_get_integer                     !< private methods to implement the querry of an integer/double key/value pair
     procedure, private :: elpa_get_double

91
     procedure, private :: elpa_eigenvectors_d                         !< private methods to implement the solve step for real/complex
92
                                                                !< double/single matrices
93
94
95
     procedure, private :: elpa_eigenvectors_f
     procedure, private :: elpa_eigenvectors_dc
     procedure, private :: elpa_eigenvectors_fc
96

97
98
     procedure, private :: elpa_hermitian_multiply_d            !< private methods to implement a "hermitian" multiplication of matrices a and b
     procedure, private :: elpa_hermitian_multiply_f            !< for real valued matrices:   a**T * b
Andreas Marek's avatar
Andreas Marek committed
99
     procedure, private :: elpa_hermitian_multiply_dc           !< for complex valued matrices:   a**H * b
100
     procedure, private :: elpa_hermitian_multiply_fc
101

Andreas Marek's avatar
Andreas Marek committed
102
     procedure, private :: elpa_cholesky_d                      !< private methods to implement the cholesky factorisation of
103
                                                                !< real/complex double/single matrices
104
105
106
     procedure, private :: elpa_cholesky_f
     procedure, private :: elpa_cholesky_dc
     procedure, private :: elpa_cholesky_fc
107

Andreas Marek's avatar
Andreas Marek committed
108
     procedure, private :: elpa_invert_trm_d                    !< private methods to implement the inversion of a triangular
109
                                                                !< real/complex double/single matrix
110
111
112
     procedure, private :: elpa_invert_trm_f
     procedure, private :: elpa_invert_trm_dc
     procedure, private :: elpa_invert_trm_fc
113

Andreas Marek's avatar
Andreas Marek committed
114
115
     procedure, private :: elpa_solve_tridi_d                   !< private methods to implement the solve step for a real valued
     procedure, private :: elpa_solve_tridi_f                   !< double/single tridiagonal matrix
116

117
     procedure, private :: associate_int => elpa_associate_int  !< private method to set some pointers
118

119
  end type elpa_impl_t
120

121
  !> \brief the implementation of the private methods
122
  contains
123
124
125
126
    !> \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
127
    function elpa_impl_allocate(error) result(obj)
Andreas Marek's avatar
Andreas Marek committed
128
129
      use precision
      use elpa_utilities, only : error_unit
Lorenz Huedepohl's avatar
Lorenz Huedepohl committed
130
      use elpa_generated_fortran_interfaces
Andreas Marek's avatar
Andreas Marek committed
131

132
133
134
135
      type(elpa_impl_t), pointer   :: obj
      integer, optional            :: error

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

Andreas Marek's avatar
Andreas Marek committed
137
      ! check whether init has ever been called
138
      if ( elpa_initialized() .ne. ELPA_OK) then
139
        write(error_unit, *) "elpa_allocate(): you must call elpa_init() once before creating instances of ELPA"
140
141
        if(present(error)) then
          error = ELPA_ERROR
142
        endif
Andreas Marek's avatar
Andreas Marek committed
143
144
        return
      endif
Andreas Marek's avatar
Andreas Marek committed
145

146
      obj%index = elpa_index_instance_c()
147
148

      ! Associate some important integer pointers for convenience
149
150
151
152
153
154
155
156
      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
157
158
      endif
    end function
Andreas Marek's avatar
Andreas Marek committed
159

160
161
162
163
164
    !c> /*! \brief C interface for the implementation of the elpa_allocate method
    !c> *
    !c> *  \param  none
    !c> *  \result elpa_t handle
    !c> */
165
    !c> elpa_t elpa_allocate();
166
    function elpa_impl_allocate_c(error) result(ptr) bind(C, name="elpa_allocate")
167
168
169
170
171
172
173
174
      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

175
176
177
178
179
    !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> */
180
    !c> void elpa_deallocate(elpa_t handle);
181
    subroutine elpa_impl_deallocate_c(handle) bind(C, name="elpa_deallocate")
182
183
184
185
186
187
188
189
190
      type(c_ptr), value :: handle
      type(elpa_impl_t), pointer :: self

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


191
192
193
194
    !> \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
195
    function elpa_setup(self) result(error)
196
      use elpa1_impl, only : elpa_get_communicators_impl
197
      class(elpa_impl_t), intent(inout) :: self
198
199
200
      integer                           :: error
      integer                           :: mpi_comm_parent, mpi_comm_rows, mpi_comm_cols, &
                                           mpierr, process_row, process_col, timings
201

202
#ifdef WITH_MPI
203
204
205
206
      error = ELPA_ERROR
      if (self%is_set("mpi_comm_parent") == 1 .and. &
          self%is_set("process_row") == 1 .and. &
          self%is_set("process_col") == 1) then
207

208
209
210
        call self%get("mpi_comm_parent", mpi_comm_parent)
        call self%get("process_row", process_row)
        call self%get("process_col", process_col)
211
        mpierr = elpa_get_communicators_impl(&
212
213
214
                        mpi_comm_parent, &
                        process_row, &
                        process_col, &
215
216
                        mpi_comm_rows, &
                        mpi_comm_cols)
217

218
219
220
        call self%set("mpi_comm_rows", mpi_comm_rows)
        call self%set("mpi_comm_cols", mpi_comm_cols)

221
        error = ELPA_OK
222
      endif
223

224
225
      if (self%is_set("mpi_comm_rows") == 1 .and. self%is_set("mpi_comm_cols") == 1) then
        error = ELPA_OK
226
      endif
227
228
229
#else
      error = ELPA_OK
#endif
230

231
#ifdef HAVE_DETAILED_TIMINGS
232
233
      call self%get("timings",timings)
      if (timings == 1) then
234
235
        call self%timer%enable()
      endif
236
#endif
237

238
    end function
239

240
241
242
243
244
245
    !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> */
246
    !c> int elpa_setup(elpa_t handle);
247
    function elpa_setup_c(handle) result(error) bind(C, name="elpa_setup")
248
249
250
251
252
253
254
255
256
      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


257
258
259
260
261
262
    !> \brief subroutine to set an integer key/value pair
    !> Parameters
    !> \param   self       class(elpa_impl_t) the allocated ELPA object
    !> \param   name       string, the key
    !> \param   value      integer, the value to be set
    !> \result  error      integer, the error code
263
    subroutine elpa_set_integer(self, name, value, error)
264
      use iso_c_binding
265
266
      use elpa_generated_fortran_interfaces
      use elpa_utilities, only : error_unit
267
      class(elpa_impl_t)              :: self
268
269
      character(*), intent(in)        :: name
      integer(kind=c_int), intent(in) :: value
270
271
      integer, optional               :: error
      integer                         :: actual_error
272

273
      actual_error = elpa_index_set_int_value_c(self%index, name // c_null_char, value, 0)
274

275
276
      if (present(error)) then
        error = actual_error
277

278
      else if (actual_error /= ELPA_OK) then
279
280
        write(error_unit,'(a,i0,a)') "ELPA: Error setting option '" // name // "' to value ", value, &
                " (got: " // elpa_strerr(actual_error) // ") and you did not check for errors!"
281
      end if
282
283
    end subroutine

284
285
286
287
288
289
290
291
292
    !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> */
293
    !c> void elpa_set_integer(elpa_t handle, const char *name, int value, int *error);
294
    subroutine elpa_set_integer_c(handle, name_p, value, error) bind(C, name="elpa_set_integer")
295
296
297
298
299
300
301
302
303
304
305
306
307
      type(c_ptr), intent(in), value :: handle
      type(elpa_impl_t), pointer :: self
      type(c_ptr), intent(in), value :: name_p
      character(len=elpa_strlen_c(name_p)), pointer :: name
      integer(kind=c_int), intent(in), value :: value
      integer(kind=c_int), optional, intent(in) :: error

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


308
309
310
311
    !> \brief function to get an integer key/value pair
    !> Parameters
    !> \param   self       class(elpa_impl_t) the allocated ELPA object
    !> \param   name       string, the key
312
    !> \param   value      integer, the value of the key/vaue pair
313
    !> \param   error      integer, optional, to store an error code
314
    subroutine elpa_get_integer(self, name, value, error)
315
      use iso_c_binding
316
      use elpa_generated_fortran_interfaces
317
      use elpa_utilities, only : error_unit
318
      class(elpa_impl_t)             :: self
319
320
      character(*), intent(in)       :: name
      integer(kind=c_int)            :: value
321
      integer, intent(out), optional :: error
322
      integer                        :: actual_error
323

324
325
326
327
328
329
330
      value = elpa_index_get_int_value_c(self%index, name // c_null_char, actual_error)
      if (present(error)) then
        error = actual_error
      else if (actual_error /= ELPA_OK) then
        write(error_unit,'(a)') "ELPA: Error getting option '" // name // "'" // &
                " (got: " // elpa_strerr(actual_error) // ") and you did not check for errors!"
      end if
331
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
332

333
334
335
336
337
338
339
340
341
    !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> */
342
343
    !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
344
345
346
347
348
349
350
351
352
      type(c_ptr), intent(in), value :: handle
      type(elpa_impl_t), pointer :: self
      type(c_ptr), intent(in), value :: name_p
      character(len=elpa_strlen_c(name_p)), pointer :: name
      integer(kind=c_int)  :: value
      integer(kind=c_int), optional, intent(inout) :: error

      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
353
354
      call elpa_get_integer(self, name, value, error)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
355
356


357
358
359
360
361
    !> \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
362
    function elpa_is_set(self, name) result(state)
363
364
      use iso_c_binding
      use elpa_generated_fortran_interfaces
365
      class(elpa_impl_t)       :: self
366
      character(*), intent(in) :: name
367
      integer                  :: state
368

369
      state = elpa_index_value_is_set_c(self%index, name // c_null_char)
370
371
    end function

372
373
374
375
376
377
    !> \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
378
379
380
381
382
383
384
385
386
387
388
389
390
    function elpa_can_set(self, name, value) result(error)
      use iso_c_binding
      use elpa_generated_fortran_interfaces
      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


    function elpa_value_to_string(self, option_name, error) result(string)
391
392
393
      use elpa_generated_fortran_interfaces
      class(elpa_impl_t), intent(in) :: self
      character(kind=c_char, len=*), intent(in) :: option_name
394
395
396
397
      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
398

399
400
      nullify(string)

401
      call self%get(option_name, val, actual_error)
402
403
404
405
406
      if (actual_error /= ELPA_OK) then
        if (present(error)) then
          error = actual_error
        endif
        return
407
408
      endif

409
410
411
412
      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
413

414
415
416
417
      if (present(error)) then
        error = actual_error
      endif
    end function
418

419
420
421
422
423
424
    !> \brief subroutine to set a double key/value pair
    !> Parameters
    !> \param   self       class(elpa_impl_t) the allocated ELPA object
    !> \param   name       string, the key
    !> \param   value      double, the value to be set
    !> \result  error      integer, the error code
425
    subroutine elpa_set_double(self, name, value, error)
Andreas Marek's avatar
Andreas Marek committed
426
      use iso_c_binding
Lorenz Huedepohl's avatar
Lorenz Huedepohl committed
427
      use elpa_generated_fortran_interfaces
428
      use elpa_utilities, only : error_unit
429
      class(elpa_impl_t)              :: self
430
      character(*), intent(in)        :: name
431
      real(kind=c_double), intent(in) :: value
432
433
      integer, optional               :: error
      integer                         :: actual_error
Andreas Marek's avatar
Andreas Marek committed
434

435
      actual_error = elpa_index_set_double_value_c(self%index, name // c_null_char, value, 0)
Andreas Marek's avatar
Andreas Marek committed
436

437
438
439
      if (present(error)) then
        error = actual_error
      else if (actual_error /= ELPA_OK) then
440
441
        write(error_unit,'(a,es12.5,a)') "ELPA: Error setting option '" // name // "' to value ", value, &
                " (got: " // elpa_strerr(actual_error) // ") and you did not check for errors!"
442
443
      end if
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
444

445
446
447
448
449
450
451
452
453
    !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> */
454
    !c> void elpa_set_double(elpa_t handle, const char *name, double value, int *error);
455
    subroutine elpa_set_double_c(handle, name_p, value, error) bind(C, name="elpa_set_double")
456
457
458
459
460
461
462
463
464
465
466
467
      type(c_ptr), intent(in), value :: handle
      type(elpa_impl_t), pointer :: self
      type(c_ptr), intent(in), value :: name_p
      character(len=elpa_strlen_c(name_p)), pointer :: name
      real(kind=c_double), intent(in), value :: value
      integer(kind=c_int), optional, intent(in) :: error

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

468
469
470
471
472
473
    !> \brief function to get an double key/value pair
    !> Parameters
    !> \param   self       class(elpa_impl_t) the allocated ELPA object
    !> \param   name       string, the key
    !> \param   value      double, the value of the key/vaue pair
    !> \param   error      integer, optional, to store an error code
474
    subroutine elpa_get_double(self, name, value, error)
Andreas Marek's avatar
Andreas Marek committed
475
      use iso_c_binding
Lorenz Huedepohl's avatar
Lorenz Huedepohl committed
476
      use elpa_generated_fortran_interfaces
477
      use elpa_utilities, only : error_unit
478
      class(elpa_impl_t)             :: self
479
      character(*), intent(in)       :: name
480
      real(kind=c_double)            :: value
481
      integer, intent(out), optional :: error
482
      integer                        :: actual_error
483

484
485
486
487
488
489
490
      value = elpa_index_get_double_value_c(self%index, name // c_null_char, actual_error)
      if (present(error)) then
        error = actual_error
      else if (actual_error /= ELPA_OK) then
        write(error_unit,'(a)') "ELPA: Error getting option '" // name // "'" // &
                " (got: " // elpa_strerr(actual_error) // ") and you did not check for errors!"
      end if
491
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
492

493
494
495
496
497
498
499
500
501
502

     !c> /*! \brief C interface for the implementation of the elpa_get_double 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> */
503
504
    !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
505
506
507
508
509
510
511
512
513
      type(c_ptr), intent(in), value :: handle
      type(elpa_impl_t), pointer :: self
      type(c_ptr), intent(in), value :: name_p
      character(len=elpa_strlen_c(name_p)), pointer :: name
      real(kind=c_double)  :: value
      integer(kind=c_int), optional, intent(inout) :: error

      call c_f_pointer(handle, self)
      call c_f_pointer(name_p, name)
514
515
      call elpa_get_double(self, name, value, error)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
516
517


518
    function elpa_associate_int(self, name) result(value)
Andreas Marek's avatar
Andreas Marek committed
519
      use iso_c_binding
520
      use elpa_generated_fortran_interfaces
521
522
      use elpa_utilities, only : error_unit
      class(elpa_impl_t)             :: self
523
524
      character(*), intent(in)       :: name
      integer(kind=c_int), pointer   :: value
Andreas Marek's avatar
Andreas Marek committed
525

526
527
      type(c_ptr)                    :: value_p

528
      value_p = elpa_index_get_int_loc_c(self%index, name // c_null_char)
529
530
531
      if (.not. c_associated(value_p)) then
        write(error_unit, '(a,a,a)') "ELPA: Warning, received NULL pointer for entry '", name, "'"
      endif
532
533
      call c_f_pointer(value_p, value)
    end function
Andreas Marek's avatar
Andreas Marek committed
534

535

536
537
538
539
540
541
    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

542
#ifdef HAVE_DETAILED_TIMINGS
543
      s = self%timer%get(name1, name2, name3, name4, name5, name6)
544
545
546
#else
      s = -1.0
#endif
547
548
549
550
551
    end function


    subroutine elpa_print_times(self)
      class(elpa_impl_t), intent(in) :: self
552
#ifdef HAVE_DETAILED_TIMINGS
553
      call self%timer%print()
554
#endif
555
556
    end subroutine

557
    !>  \brief elpa_eigenvectors_d: class method to solve the eigenvalue problem for double real matrices
Andreas Marek's avatar
Andreas Marek committed
558
    !>
559
560
    !>  The dimensions of the matrix a (locally ditributed and global), the block-cyclic distribution
    !>  blocksize, the number of eigenvectors
Andreas Marek's avatar
Andreas Marek committed
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
    !>  to be computed and the MPI communicators are already known to the object and MUST be set BEFORE
    !>  with the class method "setup"
    !>
    !>  It is possible to change the behaviour of the method by setting tunable parameters with the
    !>  class method "set"
    !>
    !>  Parameters
    !>
    !>  \param a                                    Distributed matrix for which eigenvalues are to be computed.
    !>                                              Distribution is like in Scalapack.
    !>                                              The full matrix must be set (not only one half like in scalapack).
    !>                                              Destroyed on exit (upper and lower half).
    !>
    !>  \param ev                                   On output: eigenvalues of a, every processor gets the complete set
    !>
    !>  \param q                                    On output: Eigenvectors of a
    !>                                              Distribution is like in Scalapack.
    !>                                              Must be always dimensioned to the full size (corresponding to (na,na))
    !>                                              even if only a part of the eigenvalues is needed.
    !>
    !>  \param error                                integer, optional: returns an error code, which can be queried with elpa_strerr
582
    subroutine elpa_eigenvectors_d(self, a, ev, q, error)
583
584
      use elpa2_impl
      use elpa1_impl
585
      use elpa_utilities, only : error_unit
Andreas Marek's avatar
Andreas Marek committed
586
      use iso_c_binding
587
      class(elpa_impl_t)  :: self
Andreas Marek's avatar
Andreas Marek committed
588

589
590
591
#ifdef USE_ASSUMED_SIZE
      real(kind=c_double) :: a(self%local_nrows, *), q(self%local_nrows, *)
#else
592
      real(kind=c_double) :: a(self%local_nrows, self%local_ncols), q(self%local_nrows, self%local_ncols)
593
#endif
594
      real(kind=c_double) :: ev(self%na)
595

596
      integer, optional   :: error
597
      integer(kind=c_int) :: solver
598
      logical             :: success_l
599

600

601
602
      call self%get("solver", solver)
      if (solver .eq. ELPA_SOLVER_1STAGE) then
603
        success_l = elpa_solve_evp_real_1stage_double_impl(self, a, ev, q)
604

605
      else if (solver .eq. ELPA_SOLVER_2STAGE) then
606
        success_l = elpa_solve_evp_real_2stage_double_impl(self, a, ev, q)
607
608
609
610
      else
        print *,"unknown solver"
        stop
      endif
611

612
      if (present(error)) then
613
        if (success_l) then
614
          error = ELPA_OK
615
        else
616
          error = ELPA_ERROR
617
618
619
620
621
622
        endif
      else if (.not. success_l) then
        write(error_unit,'(a)') "ELPA: Error in solve() and you did not check for errors!"
      endif
    end subroutine

623
624
    !c> void elpa_eigenvectors_d(elpa_t handle, double *a, double *ev, double *q, int *error);
    subroutine elpa_eigenvectors_d_c(handle, a_p, ev_p, q_p, error) bind(C, name="elpa_eigenvectors_d")
625
626
627
628
629
630
631
632
633
634
635
      type(c_ptr), intent(in), value :: handle, a_p, ev_p, q_p
      integer(kind=c_int), optional, intent(in) :: error

      real(kind=c_double), pointer :: a(:, :), q(:, :), ev(:)
      type(elpa_impl_t), pointer  :: self

      call c_f_pointer(handle, self)
      call c_f_pointer(a_p, a, [self%local_nrows, self%local_ncols])
      call c_f_pointer(ev_p, ev, [self%na])
      call c_f_pointer(q_p, q, [self%local_nrows, self%local_ncols])

636
      call elpa_eigenvectors_d(self, a, ev, q, error)
637
638
    end subroutine

Andreas Marek's avatar
Andreas Marek committed
639

640
    !>  \brief elpa_eigenvectors_f: class method to solve the eigenvalue problem for float real matrices
Andreas Marek's avatar
Andreas Marek committed
641
    !>
642
643
    !>  The dimensions of the matrix a (locally ditributed and global), the block-cyclic distribution
    !>  blocksize, the number of eigenvectors
Andreas Marek's avatar
Andreas Marek committed
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
    !>  to be computed and the MPI communicators are already known to the object and MUST be set BEFORE
    !>  with the class method "setup"
    !>
    !>  It is possible to change the behaviour of the method by setting tunable parameters with the
    !>  class method "set"
    !>
    !>  Parameters
    !>
    !>  \param a                                    Distributed matrix for which eigenvalues are to be computed.
    !>                                              Distribution is like in Scalapack.
    !>                                              The full matrix must be set (not only one half like in scalapack).
    !>                                              Destroyed on exit (upper and lower half).
    !>
    !>  \param ev                                   On output: eigenvalues of a, every processor gets the complete set
    !>
    !>  \param q                                    On output: Eigenvectors of a
    !>                                              Distribution is like in Scalapack.
    !>                                              Must be always dimensioned to the full size (corresponding to (na,na))
    !>                                              even if only a part of the eigenvalues is needed.
    !>
    !>  \param error                                integer, optional: returns an error code, which can be queried with elpa_strerr
665
    subroutine elpa_eigenvectors_f(self, a, ev, q, error)
666
667
      use elpa2_impl
      use elpa1_impl
668
669
      use elpa_utilities, only : error_unit
      use iso_c_binding
670
      class(elpa_impl_t)  :: self
671
672
673
#ifdef USE_ASSUMED_SIZE
      real(kind=c_float)  :: a(self%local_nrows, *), q(self%local_nrows, *)
#else
674
      real(kind=c_float)  :: a(self%local_nrows, self%local_ncols), q(self%local_nrows, self%local_ncols)
675
#endif
676
      real(kind=c_float)  :: ev(self%na)
677

678
      integer, optional   :: error
679
      integer(kind=c_int) :: solver
680
      logical             :: success_l
681

682
#ifdef WANT_SINGLE_PRECISION_REAL
683

684
685
      call self%get("solver",solver)
      if (solver .eq. ELPA_SOLVER_1STAGE) then
686
        success_l = elpa_solve_evp_real_1stage_single_impl(self, a, ev, q)
687

688
      else if (solver .eq. ELPA_SOLVER_2STAGE) then
689
        success_l = elpa_solve_evp_real_2stage_single_impl(self, a, ev, q)
690
691
692
693
      else
        print *,"unknown solver"
        stop
      endif
694

695
      if (present(error)) then
696
        if (success_l) then
697
          error = ELPA_OK
698
        else
699
          error = ELPA_ERROR
700
701
702
703
704
        endif
      else if (.not. success_l) then
        write(error_unit,'(a)') "ELPA: Error in solve() and you did not check for errors!"
      endif
#else
705
      print *,"This installation of the ELPA library has not been build with single-precision support"
706
      error = ELPA_ERROR
707
708
709
#endif
    end subroutine

710

711
712
    !c> void elpa_eigenvectors_f(elpa_t handle, float *a, float *ev, float *q, int *error);
    subroutine elpa_eigenvectors_f_c(handle, a_p, ev_p, q_p, error) bind(C, name="elpa_eigenvectors_f")
713
714
715
716
717
718
719
720
721
722
723
      type(c_ptr), intent(in), value :: handle, a_p, ev_p, q_p
      integer(kind=c_int), optional, intent(in) :: error

      real(kind=c_float), pointer :: a(:, :), q(:, :), ev(:)
      type(elpa_impl_t), pointer  :: self

      call c_f_pointer(handle, self)
      call c_f_pointer(a_p, a, [self%local_nrows, self%local_ncols])
      call c_f_pointer(ev_p, ev, [self%na])
      call c_f_pointer(q_p, q, [self%local_nrows, self%local_ncols])

724
      call elpa_eigenvectors_f(self, a, ev, q, error)
725
726
727
    end subroutine


728
    !>  \brief elpa_eigenvectors_dc: class method to solve the eigenvalue problem for double complex matrices
Andreas Marek's avatar
Andreas Marek committed
729
    !>
730
731
    !>  The dimensions of the matrix a (locally ditributed and global), the block-cyclic distribution
    !>  blocksize, the number of eigenvectors
Andreas Marek's avatar
Andreas Marek committed
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
    !>  to be computed and the MPI communicators are already known to the object and MUST be set BEFORE
    !>  with the class method "setup"
    !>
    !>  It is possible to change the behaviour of the method by setting tunable parameters with the
    !>  class method "set"
    !>
    !>  Parameters
    !>
    !>  \param a                                    Distributed matrix for which eigenvalues are to be computed.
    !>                                              Distribution is like in Scalapack.
    !>                                              The full matrix must be set (not only one half like in scalapack).
    !>                                              Destroyed on exit (upper and lower half).
    !>
    !>  \param ev                                   On output: eigenvalues of a, every processor gets the complete set
    !>
    !>  \param q                                    On output: Eigenvectors of a
    !>                                              Distribution is like in Scalapack.
    !>                                              Must be always dimensioned to the full size (corresponding to (na,na))
    !>                                              even if only a part of the eigenvalues is needed.
    !>
    !>  \param error                                integer, optional: returns an error code, which can be queried with elpa_strerr
753
    subroutine elpa_eigenvectors_dc(self, a, ev, q, error)
754
755
      use elpa2_impl
      use elpa1_impl
756
757
      use elpa_utilities, only : error_unit
      use iso_c_binding
758
      class(elpa_impl_t)             :: self
759

760
761
762
#ifdef USE_ASSUMED_SIZE
      complex(kind=c_double_complex) :: a(self%local_nrows, *), q(self%local_nrows, *)
#else
763
      complex(kind=c_double_complex) :: a(self%local_nrows, self%local_ncols), q(self%local_nrows, self%local_ncols)
764
#endif
765
      real(kind=c_double)            :: ev(self%na)
766

767
      integer, optional              :: error
768
      integer(kind=c_int)            :: solver
769
      logical                        :: success_l
770

771
772
      call self%get("solver", solver)
      if (solver .eq. ELPA_SOLVER_1STAGE) then
773
        success_l = elpa_solve_evp_complex_1stage_double_impl(self, a, ev, q)
774

775
      else if (solver .eq. ELPA_SOLVER_2STAGE) then
776
        success_l = elpa_solve_evp_complex_2stage_double_impl(self,  a, ev, q)
777
778
779
780
      else
        print *,"unknown solver"
        stop
      endif
781

782
      if (present(error)) then
783
        if (success_l) then
784
          error = ELPA_OK
785
        else
786
          error = ELPA_ERROR
787
788
789
790
791
792
793
        endif
      else if (.not. success_l) then
        write(error_unit,'(a)') "ELPA: Error in solve() and you did not check for errors!"
      endif
    end subroutine


794
795
    !c> void elpa_eigenvectors_dc(elpa_t handle, double complex *a, double *ev, double complex *q, int *error);
    subroutine elpa_eigenvectors_dc_c(handle, a_p, ev_p, q_p, error) bind(C, name="elpa_eigenvectors_dc")
796
797
798
799
800
801
802
803
804
805
806
807
      type(c_ptr), intent(in), value :: handle, a_p, ev_p, q_p
      integer(kind=c_int), optional, intent(in) :: error

      complex(kind=c_double_complex), pointer :: a(:, :), q(:, :)
      real(kind=c_double), pointer :: ev(:)
      type(elpa_impl_t), pointer  :: self

      call c_f_pointer(handle, self)
      call c_f_pointer(a_p, a, [self%local_nrows, self%local_ncols])
      call c_f_pointer(ev_p, ev, [self%na])
      call c_f_pointer(q_p, q, [self%local_nrows, self%local_ncols])

808
      call elpa_eigenvectors_dc(self, a, ev, q, error)
809
810
811
    end subroutine


812
    !>  \brief elpa_eigenvectors_fc: class method to solve the eigenvalue problem for float complex matrices
Andreas Marek's avatar
Andreas Marek committed
813
    !>
814
815
    !>  The dimensions of the matrix a (locally ditributed and global), the block-cyclic distribution
    !>  blocksize, the number of eigenvectors
Andreas Marek's avatar
Andreas Marek committed
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
    !>  to be computed and the MPI communicators are already known to the object and MUST be set BEFORE
    !>  with the class method "setup"
    !>
    !>  It is possible to change the behaviour of the method by setting tunable parameters with the
    !>  class method "set"
    !>
    !>  Parameters
    !>
    !>  \param a                                    Distributed matrix for which eigenvalues are to be computed.
    !>                                              Distribution is like in Scalapack.
    !>                                              The full matrix must be set (not only one half like in scalapack).
    !>                                              Destroyed on exit (upper and lower half).
    !>
    !>  \param ev                                   On output: eigenvalues of a, every processor gets the complete set
    !>
    !>  \param q                                    On output: Eigenvectors of a
    !>                                              Distribution is like in Scalapack.
    !>                                              Must be always dimensioned to the full size (corresponding to (na,na))
    !>                                              even if only a part of the eigenvalues is needed.
    !>
    !>  \param error                                integer, optional: returns an error code, which can be queried with elpa_strerr
837
    subroutine elpa_eigenvectors_fc(self, a, ev, q, error)
838
839
      use elpa2_impl
      use elpa1_impl
840
841
842
      use elpa_utilities, only : error_unit

      use iso_c_binding
843
      class(elpa_impl_t)            :: self
844
#ifdef USE_ASSUMED_SIZE
Andreas Marek's avatar
Andreas Marek committed
845
      complex(kind=c_float_complex) :: a(self%local_nrows, *), q(self%local_nrows, *)
846
#else
Andreas Marek's avatar
Andreas Marek committed
847
      complex(kind=c_float_complex) :: a(self%local_nrows, self%local_ncols), q(self%local_nrows, self%local_ncols)
848
#endif
Andreas Marek's avatar
Andreas Marek committed
849
      real(kind=c_float)            :: ev(self%na)
850

851
      integer, optional             :: error
852
      integer(kind=c_int)           :: solver
853
      logical                       :: success_l
854
855

#ifdef WANT_SINGLE_PRECISION_COMPLEX
856

857
858
      call self%get("solver", solver)
      if (solver .eq. ELPA_SOLVER_1STAGE) then
859
        success_l = elpa_solve_evp_complex_1stage_single_impl(self, a, ev, q)
860

861
      else if (solver .eq. ELPA_SOLVER_2STAGE) then
862
        success_l = elpa_solve_evp_complex_2stage_single_impl(self,  a, ev, q)
863
864
865
866
      else
        print *,"unknown solver"
        stop
      endif
867

868
      if (present(error)) then
869
        if (success_l) then
870
          error = ELPA_OK
871
        else
872
          error = ELPA_ERROR
873
874
875
876
877
        endif
      else if (.not. success_l) then
        write(error_unit,'(a)') "ELPA: Error in solve() and you did not check for errors!"
      endif
#else
878
      print *,"This installation of the ELPA library has not been build with single-precision support"
879
      error = ELPA_ERROR
880
881
882
#endif
    end subroutine

883

884
885
    !c> void elpa_eigenvectors_fc(elpa_t handle, float complex *a, float *ev, float complex *q, int *error);
    subroutine elpa_eigenvectors_fc_c(handle, a_p, ev_p, q_p, error) bind(C, name="elpa_eigenvectors_fc")
886
887
888
889
890
891
892
893
894
895
896
897
      type(c_ptr), intent(in), value :: handle, a_p, ev_p, q_p
      integer(kind=c_int), optional, intent(in) :: error

      complex(kind=c_float_complex), pointer :: a(:, :), q(:, :)
      real(kind=c_float), pointer :: ev(:)
      type(elpa_impl_t), pointer  :: self

      call c_f_pointer(handle, self)
      call c_f_pointer(a_p, a, [self%local_nrows, self%local_ncols])
      call c_f_pointer(ev_p, ev, [self%na])
      call c_f_pointer(q_p, q, [self%local_nrows, self%local_ncols])

898
      call elpa_eigenvectors_fc(self, a, ev, q, error)
899
900
    end subroutine

Andreas Marek's avatar
Andreas Marek committed
901
    !> \brief  elpa_hermitian_multiply_d: class method to perform C : = A**T * B for double real matrices
902
903
904
    !>         where   A is a square matrix (self%na,self%na) which is optionally upper or lower triangular
    !>                 B is a (self%na,ncb) matrix
    !>                 C is a (self%na,ncb) matrix where optionally only the upper or lower
Andreas Marek's avatar
Andreas Marek committed
905
906
907
908
909
910
911
    !>                   triangle may be computed
    !>
    !> the MPI commicators and the block-cyclic distribution block size are already known to the type.
    !> Thus the class method "setup" must be called BEFORE this method is used
    !>
    !> \details
    !>