Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
elpa
elpa
Commits
b1297e23
Commit
b1297e23
authored
Jun 03, 2017
by
Andreas Marek
Browse files
Man page for elpa_init
parent
8453a9f1
Changes
3
Pipelines
1
Show whitespace changes
Inline
Side-by-side
Makefile.am
View file @
b1297e23
...
@@ -360,7 +360,8 @@ nobase_nodist_elpa_include_HEADERS = \
...
@@ -360,7 +360,8 @@ nobase_nodist_elpa_include_HEADERS = \
elpa/elpa_constants.h
elpa/elpa_constants.h
dist_man_MANS
=
\
dist_man_MANS
=
\
man/elpa2_print_kernels.1
man/elpa2_print_kernels.1
\
man/elpa_init.3
if
ENABLE_LEGACY
if
ENABLE_LEGACY
dist_man_MANS
+=
\
dist_man_MANS
+=
\
...
...
man/elpa_init.3
0 → 100644
View file @
b1297e23
.TH "elpa_init" 3 "Sat Jun 3 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_init \- initialize the ELPA library
.br
.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa
.br
class(elpa_t), pointer :: elpa
.br
.RI "error = \fBelpa_init\fP (api_version)"
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.br
.RI "integer, intent(in) \fBapi_version\fP: the api version that you want to initialize, currently the version is 20170403"
.br
.RI "integer \fBerror\fP: the return code. If the function returns without an error, the error code will be ELPA_OK."
.br
.br
.SS C INTERFACE
#include <elpa/elpa.h>
.br
elpa_t handle;
.br
.RI "\fBint\fP error = \fBelpa_init\fP (\fBint\fP api_version);"
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.br
.br
.RI "int \fBapi_version\fP: the api version that you want to initialize currently the version is 20170403"
.br
.RI "int \fBerror\fP: the return code. If the function returns without an error, the error code will be ELPA_OK."
.SH DESCRIPTION
Initializes the ELPA library for usage. The return code shold be ELPA_OK. The return code can be querried
with the \fBelpa_strerr\fP(3) function.
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1)
src/elpa_api.F90
View file @
b1297e23
...
@@ -1111,7 +1111,7 @@ module elpa_api
...
@@ -1111,7 +1111,7 @@ module elpa_api
contains
contains
!> \brief function to intiali
s
e the ELPA library
!> \brief function to intiali
z
e the ELPA library
!> Parameters
!> Parameters
!> \param api_version integer: api_version that ELPA should use
!> \param api_version integer: api_version that ELPA should use
!> \result error integer: error code, which can be queried with elpa_strerr
!> \result error integer: error code, which can be queried with elpa_strerr
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment