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

50
!> \brief Fortran module which provides the actual implementation of the API. Do not use directly! Use the module "elpa"
51
module elpa_impl
52
  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

Andreas Marek's avatar
Andreas Marek committed
91
     procedure, private :: elpa_solve_d                         !< private methods to implement the solve step for real/complex
92
                                                                !< double/single matrices
93
94
95
     procedure, private :: elpa_solve_f
     procedure, private :: elpa_solve_dc
     procedure, private :: elpa_solve_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
      integer :: error, error2
199
      integer :: mpi_comm_parent, mpi_comm_rows, mpi_comm_cols, mpierr, process_row, process_col, timings
200

201
#ifdef WITH_MPI
202
203
204
205
      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
206

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

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

220
        error = ELPA_OK
221
      endif
222

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

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

237
    end function
238

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


256
257
258
259
260
261
    !> \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
262
    subroutine elpa_set_integer(self, name, value, error)
263
      use iso_c_binding
264
265
      use elpa_generated_fortran_interfaces
      use elpa_utilities, only : error_unit
266
      class(elpa_impl_t)              :: self
267
268
      character(*), intent(in)        :: name
      integer(kind=c_int), intent(in) :: value
269
270
      integer, optional               :: error
      integer                         :: actual_error
271

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

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

277
      else if (actual_error /= ELPA_OK) then
278
279
        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!"
280
      end if
281
282
    end subroutine

283
284
285
286
287
288
289
290
291
    !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> */
292
    !c> void elpa_set_integer(elpa_t handle, const char *name, int value, int *error);
293
    subroutine elpa_set_integer_c(handle, name_p, value, error) bind(C, name="elpa_set_integer")
294
295
296
297
298
299
300
301
302
303
304
305
306
      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


307
308
309
310
    !> \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
311
    !> \param   value      integer, the value of the key/vaue pair
312
    !> \param   error      integer, optional, to store an error code
313
    subroutine elpa_get_integer(self, name, value, error)
314
      use iso_c_binding
315
      use elpa_generated_fortran_interfaces
316
      use elpa_utilities, only : error_unit
317
      class(elpa_impl_t)             :: self
318
319
      character(*), intent(in)       :: name
      integer(kind=c_int)            :: value
320
      integer, intent(out), optional :: error
321
      integer                        :: actual_error
322

323
324
325
326
327
328
329
      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
330
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
331

332
333
334
335
336
337
338
339
340
    !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> */
341
342
    !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
343
344
345
346
347
348
349
350
351
      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)
352
353
      call elpa_get_integer(self, name, value, error)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
354
355


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

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

371
372
373
374
375
376
    !> \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
377
378
379
380
381
382
383
384
385
386
387
388
389
    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)
390
391
392
      use elpa_generated_fortran_interfaces
      class(elpa_impl_t), intent(in) :: self
      character(kind=c_char, len=*), intent(in) :: option_name
393
394
395
396
      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
397

398
399
      nullify(string)

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

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

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

418
419
420
421
422
423
    !> \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
424
    subroutine elpa_set_double(self, name, value, error)
Andreas Marek's avatar
Andreas Marek committed
425
      use iso_c_binding
Lorenz Huedepohl's avatar
Lorenz Huedepohl committed
426
      use elpa_generated_fortran_interfaces
427
      use elpa_utilities, only : error_unit
428
      class(elpa_impl_t)              :: self
429
      character(*), intent(in)        :: name
430
      real(kind=c_double), intent(in) :: value
431
432
      integer, optional               :: error
      integer                         :: actual_error
Andreas Marek's avatar
Andreas Marek committed
433

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

436
437
438
      if (present(error)) then
        error = actual_error
      else if (actual_error /= ELPA_OK) then
439
440
        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!"
441
442
      end if
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
443

444
445
446
447
448
449
450
451
452
    !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> */
453
    !c> void elpa_set_double(elpa_t handle, const char *name, double value, int *error);
454
    subroutine elpa_set_double_c(handle, name_p, value, error) bind(C, name="elpa_set_double")
455
456
457
458
459
460
461
462
463
464
465
466
      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

467
468
469
470
471
472
    !> \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
473
    subroutine elpa_get_double(self, name, value, error)
Andreas Marek's avatar
Andreas Marek committed
474
      use iso_c_binding
Lorenz Huedepohl's avatar
Lorenz Huedepohl committed
475
      use elpa_generated_fortran_interfaces
476
      use elpa_utilities, only : error_unit
477
      class(elpa_impl_t)             :: self
478
      character(*), intent(in)       :: name
479
      real(kind=c_double)            :: value
480
      integer, intent(out), optional :: error
481
      integer                        :: actual_error
482

483
484
485
486
487
488
489
      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
490
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
491

492
493
494
495
496
497
498
499
500
501

     !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> */
502
503
    !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
504
505
506
507
508
509
510
511
512
      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)
513
514
      call elpa_get_double(self, name, value, error)
    end subroutine
Andreas Marek's avatar
Andreas Marek committed
515
516


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

525
526
      type(c_ptr)                    :: value_p

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

534

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

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


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

Andreas Marek's avatar
Andreas Marek committed
556
557
    !>  \brief elpa_solve_d: class method to solve the eigenvalue problem for double real matrices
    !>
558
559
    !>  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
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
    !>  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
581
    subroutine elpa_solve_d(self, a, ev, q, error)
582
583
      use elpa2_impl
      use elpa1_impl
584
      use elpa_utilities, only : error_unit
Andreas Marek's avatar
Andreas Marek committed
585
      use iso_c_binding
586
      class(elpa_impl_t)  :: self
Andreas Marek's avatar
Andreas Marek committed
587

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

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

599

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

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

611
      if (present(error)) then
612
        if (success_l) then
613
          error = ELPA_OK
614
        else
615
          error = ELPA_ERROR
616
617
618
619
620
621
        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

622
623
    !c> void elpa_solve_d(elpa_t handle, double *a, double *ev, double *q, int *error);
    subroutine elpa_solve_d_c(handle, a_p, ev_p, q_p, error) bind(C, name="elpa_solve_d")
624
625
626
627
628
629
630
631
632
633
634
      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])

635
      call elpa_solve_d(self, a, ev, q, error)
636
637
    end subroutine

Andreas Marek's avatar
Andreas Marek committed
638
639
640

    !>  \brief elpa_solve_f: class method to solve the eigenvalue problem for float real matrices
    !>
641
642
    !>  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
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
    !>  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
664
    subroutine elpa_solve_f(self, a, ev, q, error)
665
666
      use elpa2_impl
      use elpa1_impl
667
668
      use elpa_utilities, only : error_unit
      use iso_c_binding
669
      class(elpa_impl_t)  :: self
670
671
672
#ifdef USE_ASSUMED_SIZE
      real(kind=c_float)  :: a(self%local_nrows, *), q(self%local_nrows, *)
#else
673
      real(kind=c_float)  :: a(self%local_nrows, self%local_ncols), q(self%local_nrows, self%local_ncols)
674
#endif
675
      real(kind=c_float)  :: ev(self%na)
676

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

681
#ifdef WANT_SINGLE_PRECISION_REAL
682

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

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

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

709

710
711
    !c> void elpa_solve_f(elpa_t handle, float *a, float *ev, float *q, int *error);
    subroutine elpa_solve_f_c(handle, a_p, ev_p, q_p, error) bind(C, name="elpa_solve_f")
712
713
714
715
716
717
718
719
720
721
722
      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])

723
      call elpa_solve_f(self, a, ev, q, error)
724
725
726
    end subroutine


Andreas Marek's avatar
Andreas Marek committed
727
728
    !>  \brief elpa_solve_dc: class method to solve the eigenvalue problem for double complex matrices
    !>
729
730
    !>  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
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
    !>  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
752
    subroutine elpa_solve_dc(self, a, ev, q, error)
753
754
      use elpa2_impl
      use elpa1_impl
755
756
      use elpa_utilities, only : error_unit
      use iso_c_binding
757
      class(elpa_impl_t)             :: self
758

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

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

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

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

781
      if (present(error)) then
782
        if (success_l) then
783
          error = ELPA_OK
784
        else
785
          error = ELPA_ERROR
786
787
788
789
790
791
792
        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


793
794
    !c> void elpa_solve_dc(elpa_t handle, double complex *a, double *ev, double complex *q, int *error);
    subroutine elpa_solve_dc_c(handle, a_p, ev_p, q_p, error) bind(C, name="elpa_solve_dc")
795
796
797
798
799
800
801
802
803
804
805
806
      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])

807
      call elpa_solve_dc(self, a, ev, q, error)
808
809
810
    end subroutine


Andreas Marek's avatar
Andreas Marek committed
811
812
    !>  \brief elpa_solve_fc: class method to solve the eigenvalue problem for float complex matrices
    !>
813
814
    !>  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
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
    !>  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
836
    subroutine elpa_solve_fc(self, a, ev, q, error)
837
838
      use elpa2_impl
      use elpa1_impl
839
840
841
      use elpa_utilities, only : error_unit

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

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

#ifdef WANT_SINGLE_PRECISION_COMPLEX
855

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

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

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

882

883
884
    !c> void elpa_solve_fc(elpa_t handle, float complex *a, float *ev, float complex *q, int *error);
    subroutine elpa_solve_fc_c(handle, a_p, ev_p, q_p, error) bind(C, name="elpa_solve_fc")
885
886
887
888
889
890
891
892
893
894
895
896
      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])

897
      call elpa_solve_fc(self, a, ev, q, error)
898
899
    end subroutine

Andreas Marek's avatar
Andreas Marek committed
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
    !> \brief  elpa_hermitian_multiply_d: class method to perform C : = A**T * B for double real matrices
    !>         where   A is a square matrix (na,na) which is optionally upper or lower triangular
    !>                 B is a (na,ncb) matrix
    !>                 C is a (na,ncb) matrix where optionally only the upper or lower
    !>                   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
    !>
    !> \param  uplo_a               'U' if A is upper triangular
    !>                              'L' if A is lower triangular
    !>                              anything else if A is a full matrix
    !>                              Please note: This pertains to the original A (as set in the calling program)
    !>                                           whereas the transpose of A is used for calculations
    !>                              If uplo_a is 'U' or 'L', the other triangle is not used at all,
    !>                              i.e. it may contain arbitrary numbers
    !> \param uplo_c                'U' if only the upper diagonal part of C is needed
    !>                              'L' if only the upper diagonal part of C is needed
    !>                              anything else if the full matrix C is needed
    !>                              Please note: Even when uplo_c is 'U' or 'L', the other triangle may be
    !>                                            written to a certain extent, i.e. one shouldn't rely on the content there!
    !> \param na                    Number of rows/columns of global matrix A, number of rows of global matrices B and C
    !> \param ncb                   Number of columns  of global matrices B and C
    !> \param a                     matrix a
    !> \param nrows_a               number of rows of local (sub) matrix a
    !> \param ncols_a               number of columns of local (sub) matrix a
    !> \param b                     matrix b
    !> \param nrows_b               number of rows of local (sub) matrix b
    !> \param ncols_b               number of columns of local (sub) matrix b
    !> \param c                     matrix c
    !> \param nrows_c               number of rows of local (sub) matrix c
    !> \param ncols_c               number of columns of local (sub) matrix c
    !> \param error                 optional argument, error code which can be queried with elpa_strerr
    subroutine elpa_hermitian_multiply_d (self,uplo_a, uplo_c, na, ncb, a, nrows_a, ncols_a, b, nrows_b, ncols_b, &
                                          c, nrows_c, ncols_c, error)
937
      use iso_c_binding
938
      use elpa1_auxiliary_impl
939
      class(elpa_impl_t)              :: self
940
      character*1                     :: uplo_a, uplo_c
Andreas Marek's avatar
Andreas Marek committed
941
      integer(kind=c_int), intent(in) :: na, nrows_a, ncols_a, nrows_b, ncols_b, nrows_c, ncols_c, ncb
942
#ifdef USE_ASSUMED_SIZE
Andreas Marek's avatar
Andreas Marek committed
943
      real(kind=c_double)             :: a(nrows_a,*), b(nrows_b,*), c(nrows_c,*)
944
#else
Andreas Marek's avatar
Andreas Marek committed
945
      real(kind=c_double)             :: a(nrows_a,ncols_a), b(nrows_b,ncols_b), c(nrows_c,ncols_c)
946
#endif
947
      integer, optional               :: error
948
949
      logical                         :: success_l

Andreas Marek's avatar
Andreas Marek committed
950
951
      success_l = elpa_mult_at_b_real_double_impl(self, uplo_a, uplo_c, na, ncb, a, nrows_a, ncols_a, b, nrows_b, ncols_b, &
                                                  c, nrows_c, ncols_c)
952
      if (present(error)) then
953
        if (success_l) then
954
          error = ELPA_OK
955
        else
956
          error = ELPA_ERROR
957
958
        endif
      else