Commit fe4f1381 authored by Andreas Marek's avatar Andreas Marek
Browse files

Make clear that the elpa error codes are integers

parent 544ac815
...@@ -107,6 +107,7 @@ ...@@ -107,6 +107,7 @@
!> \code{.f90} !> \code{.f90}
!> use elpa !> use elpa
!> class(elpa_t), pointer :: elpa !> class(elpa_t), pointer :: elpa
!> integer :: success
!> !>
!> if (elpa_init(20170403) /= ELPA_OK) then !> if (elpa_init(20170403) /= ELPA_OK) then
!> print *, "ELPA API version not supported" !> print *, "ELPA API version not supported"
...@@ -150,6 +151,7 @@ ...@@ -150,6 +151,7 @@
!> #include <elpa/elpa.h> !> #include <elpa/elpa.h>
!> !>
!> elpa_t handle; !> elpa_t handle;
!> int error;
!> !>
!> if (elpa_init(20170403) != ELPA_OK) { !> if (elpa_init(20170403) != ELPA_OK) {
!> fprintf(stderr, "Error: ELPA API version not supported"); !> fprintf(stderr, "Error: ELPA API version not supported");
......
...@@ -301,7 +301,7 @@ module elpa_api ...@@ -301,7 +301,7 @@ module elpa_api
!> \param self class(elpa_t): the ELPA object !> \param self class(elpa_t): the ELPA object
!> \param name string: the name of the key !> \param name string: the name of the key
!> \param value double: the value associated with the key !> \param value double: the value associated with the key
!> \param error integer. optional : error code, which can be queried with elpa_strerr !> \param error integer, optional : error code, which can be queried with elpa_strerr
abstract interface abstract interface
subroutine elpa_get_double_i(self, name, value, error) subroutine elpa_get_double_i(self, name, value, error)
use iso_c_binding use iso_c_binding
...@@ -319,7 +319,7 @@ module elpa_api ...@@ -319,7 +319,7 @@ module elpa_api
!> \details !> \details
!> \param self class(elpa_t): the ELPA object !> \param self class(elpa_t): the ELPA object
!> \param name string: the name of the key !> \param name string: the name of the key
!> \result value integer pointer: the value associated with the key !> \result value integer, pointer: the value associated with the key
abstract interface abstract interface
function elpa_associate_int_i(self, name) result(value) function elpa_associate_int_i(self, name) result(value)
use iso_c_binding use iso_c_binding
...@@ -364,7 +364,11 @@ module elpa_api ...@@ -364,7 +364,11 @@ module elpa_api
end subroutine end subroutine
end interface end interface
!> \brief abstract definition of the start method for timer
!> Parameters
!> \details
!> \param self class(elpa_t): the ELPA object
!> \param name character(len=*) the name of the entry int the timer tree
abstract interface abstract interface
subroutine elpa_timer_start_i(self, name) subroutine elpa_timer_start_i(self, name)
import elpa_t import elpa_t
...@@ -374,6 +378,11 @@ module elpa_api ...@@ -374,6 +378,11 @@ module elpa_api
end subroutine end subroutine
end interface end interface
!> \brief abstract definition of the stop method for timer
!> Parameters
!> \details
!> \param self class(elpa_t): the ELPA object
!> \param name character(len=*) the name of the entry int the timer tree
abstract interface abstract interface
subroutine elpa_timer_stop_i(self, name) subroutine elpa_timer_stop_i(self, name)
...@@ -1158,7 +1167,7 @@ module elpa_api ...@@ -1158,7 +1167,7 @@ module elpa_api
!> \brief function to check whether the ELPA library has been correctly initialised !> \brief function to check whether the ELPA library has been correctly initialised
!> Parameters !> Parameters
!> \result state logical: state is either ELPA_OK or ELPA_ERROR, which can be queried with elpa_strerr !> \result state integer: state is either ELPA_OK or ELPA_ERROR, which can be queried with elpa_strerr
function elpa_initialized() result(state) function elpa_initialized() result(state)
integer :: state integer :: state
if (initDone) then if (initDone) then
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment