Skip to content

GitLab

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

Better format man pages

parent 0010fe42
Hide whitespace changes
Inline Side-by-side
Showing with 89 additions and 53 deletions
man/elpa2_print_kernels.1
View file @ a8182a89
......@@ -23,5 +23,5 @@ A. Marek, MPCDF
.SH "Reporting bugs"
Report bugs to the ELPA mail elpa-library@mpcdf.mpg.de
.SH "SEE ALSO"
\fBelpa_get_communicators\fP(3) \fBelpa_solve_evp_real_double\fP(3) \fBelpa_solve_evp_real_single\fP(3) \fBelpa_solve_evp_complex_double\fP(3) \fBelpa_solve_evp_complex_single\fP(3) \fBelpa_solve_evp_real_1stage_double\fP(3) \fBelpa_solve_evp_real_1stage_single\fP(3) \fBelpa_solve_evp_real_2stage_double\fP(3) \fBelpa_solve_evp_real_2stage_single\fP(3) \fBelpa_solve_evp_complex_2stage_double\fP(3) \fBelpa_solve_evp_complex_2stage_single\fP(3)
\fBelpa_init\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
man/elpa_allocate.3
View file @ a8182a89
......@@ -20,7 +20,7 @@ class(elpa_t), pointer :: elpa
.RI "With the definintions of the input and output variables:"
.br
.RI "class(elpa_t) \fBelpa\fP: returns an instance of the ELPA object"
.RI "class(elpa_t) :: \fBelpa\fP ! returns an instance of the ELPA object"
.br
.br
......@@ -30,7 +30,7 @@ class(elpa_t), pointer :: elpa
elpa_t handle;
.br
.RI "\fBelpa_t\fP handle = \fBelpa_allocate\fP ();"
.RI "\fBelpa_t\fP handle = \fBelpa_allocate\fP();"
.br
.RI " "
.br
......@@ -38,11 +38,11 @@ elpa_t handle;
.br
.br
.RI "elpa_t \fBhandle\fP: returns an handle to the allocated ELPA object"
.RI "elpa_t \fBhandle\fP; // returns an handle to the allocated ELPA object"
.SH DESCRIPTION
Allocate an ELPA object. The function \fBelpa_init\fP(3) must be called once BEFORE \fBelpa_allocate\fP can be called.
Allocate an ELPA object. The function \fBelpa_init\fP(3) must be called once \fIBEFORE\fP \fBelpa_allocate\fP can be called.
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
man/elpa_deallocate.3
View file @ a8182a89
......@@ -20,7 +20,7 @@ class(elpa_t), pointer :: elpa
.RI "With the definintions of the input and output variables:"
.br
.RI "class(elpa_t) \fBelpa\fP: the pointer to the instance of the ELPA library which should be deallocated"
.RI "class(elpa_t) :: \fBelpa\fP ! the pointer to the instance of the ELPA library which should be deallocated"
.br
.br
......@@ -30,7 +30,7 @@ class(elpa_t), pointer :: elpa
elpa_t handle;
.br
.RI "\fBvoid\fP \fBelpa_deallocate\fP (\fBelpa_t\fP handle);"
.RI "\fBvoid\fP \fBelpa_deallocate\fP(\fBelpa_t\fP handle);"
.br
.RI " "
.br
......@@ -38,11 +38,11 @@ elpa_t handle;
.br
.br
.RI "elpa_t \fBhandle\fP: the handle to the ELPA instance which should be deallocated."
.RI "elpa_t \fBhandle\fP; // the handle to the ELPA instance which should be deallocated."
.SH DESCRIPTION
Deallocate an ELPA object. The functions \fBelpa_init\fP(3) and \fBelpa_allocate\fP(3) must have been called BEFORE elpa_deallocate\fP can be called.
Deallocate an ELPA object. The functions \fBelpa_init\fP(3) and \fBelpa_allocate\fP(3) must have been called \fIBEFORE\fP \fBelpa_deallocate\fP can be called.
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_uninit\fP(3)
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_uninit\fP(3)
man/elpa_init.3
View file @ a8182a89
......@@ -20,9 +20,9 @@ class(elpa_t), pointer :: elpa
.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"
.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."
.RI "integer :: \fBerror\fP ! the return code. If the function returns without an error, the error code will be ELPA_OK."
.br
.br
......@@ -40,9 +40,9 @@ elpa_t handle;
.br
.br
.RI "int \fBapi_version\fP: the api version that you want to initialize currently the version is 20170403"
.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."
.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
......@@ -50,4 +50,4 @@ with the \fBelpa_strerr\fP(3) function.
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_allocate\fP(3) \fPelpa_set\fP(3) \fPelpa_setup\fP(3) \fPelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
\fBelpa2_print_kernels\fP(1) \fBelpa_allocate\fP(3) \fPelpa_set\fP(3) \fPelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fPelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
man/elpa_set.3
View file @ a8182a89
......@@ -20,11 +20,17 @@ class(elpa_t), pointer :: elpa
.RI "With the definintions of the input and output variables:"
.br
.RI "character(*) \fBname\fP: the name of the option to be set"
.TP
.RI "character(*) :: \fBname\fP"
the name of the option to be set
.br
.RI "datatype \fBvalue\fP: the value which should be assigned to the option \fBname\fP. The datatype can be \fBinteger\fP or \fBreal(kind=c_double)\fP."
.TP
.RI "datatype :: \fBvalue\fP"
the value which should be assigned to the option \fBname\fP. The datatype can be \fBinteger\fP or \fBreal(kind=c_double)\fP.
.br
.RI "integer, optional \fBerror\fP: the returned error code. On success it is ELPA_OK, otherwise an error. The error code can be querried with \fBelpa_strerr\fP(3)"
.TP
.RI "integer, optional :: \fBerror\fP"
the returned error code. On success it is ELPA_OK, otherwise an error. The error code can be querried with \fBelpa_strerr\fP(3)
.br
.SS C INTERFACE
......@@ -41,49 +47,79 @@ elpa_t handle;
.br
.br
.RI "elpa_t \fBhandle\fP: the handle of an ELPA object, obtained before with \fBelpa_allocate\fP(3)"
.TP
.RI "elpa_t \fBhandle\fP;"
the handle of an ELPA object, obtained before with \fBelpa_allocate\fP(3)"
.br
.RI "const char\fB*name\fP: the name of the option to be set."
.TP
.RI "const char \fB*name\fP;"
the name of the option to be set.
.br
.RI "datatype \fBvalue\fP: the value which should be assigned to the option \fBname\fP. Datatype can be either \fBint\fP or \fBdouble\fP."
.TP
.RI "datatype \fBvalue\fP;"
the value which should be assigned to the option \fBname\fP. Datatype can be either \fBint\fP or \fBdouble\fP."
.SH DESCRIPTION
The elpa_set function is used to set \fBparameters\fP and \fBtunables\fP for the run-time of the ELPA library. It returns an error code which can be querried with \fBelpa_strerr\fP(3).
\fBParameters:\fP
Parameters of an ELPA instance have to be set BEFORE the ELPA instance is set up with the function \fBelpa_setup\fP(3).
Parameters of an ELPA instance have to be set \fIBEFORE\fP the ELPA instance is set up with the function \fBelpa_setup\fP(3).
At the moment the following parameters are supported:
\fB"na"\fP: integer parameter. The global matrix has size (na * na)
\fB"nev"\fP: integer parameter. The number of eigenvectors to be computed in a call to \fBelpa_eigenvectors\fP(3). Must have dimension 1 <= nev <= na.
\fB"local_nrows"\fP: integer parameter. Number of matrix rows stored on this MPI process.
\fB"local_ncols"\fP: integer parameter. Number of matrix cols stored on this MPI process.
\fB"process_row"\fP: integer parameter. Process row number in the 2D domain decomposition.
\fB"process_col"\fP: integer parameter. Process col number in the 2D domain decomposition.
\fB"mpi_comm_parent"\fP: \fBinteger\fP parameter. The parent MPI communicator which includes all MPI process which are used
in the 2D domain decomposition.
\fB"bandwidth"\fP: integer parameter. Some ELPA compute steps can be accelerated if the matrix is already in banded
form. If set, ELPA assumes that the bandwidth of the matrix is the value set.
.br
.TP
.RI \fB"na"\fP:
integer parameter. The global matrix has size (na * na)
.TP
.RI \fB"nev"\fP:
integer parameter. The number of eigenvectors to be computed in a call to \fBelpa_eigenvectors\fP(3). Must have dimension 1 <= nev <= na.
.TP
.RI \fB"local_nrows"\fP:
integer parameter. Number of matrix rows stored on this MPI process.
.TP
.RI \fB"local_ncols"\fP:
integer parameter. Number of matrix cols stored on this MPI process.
.TP
.RI \fB"process_row"\fP:
integer parameter. Process row number in the 2D domain decomposition.
.TP
.RI \fB"process_col"\fP:
integer parameter. Process col number in the 2D domain decomposition.
.TP
.RI \fB"mpi_comm_parent"\fP:
integer parameter. The parent MPI communicator which includes all MPI process which are used in the 2D domain decomposition.
.TP
.RI \fB"bandwidth"\fP:
integer parameter. Some ELPA compute steps can be accelerated if the matrix is already in banded form. If set, ELPA assumes that the bandwidth of the matrix is the value set.
.RI \fB"timings"\fP:
Choose whether time measurements should be done in the ELPA routines.
.LP
\fBTunables:\fP
Tunables of an ELPA can be set at anytime.
Tunables of an ELPA option can be set at \fIanytime\fP.
At the moment the following parameters are supported:
\fB"solver"\fP: Choose which solver should be used in the compute steps \fBelpa_eigenvalues\fP(3) or \fBelpa_eigenvectors\fP(3). At the moment allowed option are \fB"ELPA_SOLVER_1STAGE"\fP or \fB"ELPA_SOLVER_2STAGE"\fP.
\fB"real_kernel"\fP: Choose which real kernel should be used in the \fBelpa_eigenvalues\fP(3) or \fBelpa_eigenvectors\fP(3)compute steps, if solver is set to \fB"ELPA_SOLVER_2STAGE"\fP. The available kernels can be querried with \fBelpa2_print_kernels\fP(1).
\fB"complex_kernel"\fP: Choose which complex kernel should be used in the \fBelpa_eigenvalues\fP(3) or \fBelpa_eigenvectors\fP(3)compute steps, if solver is set to \fB"ELPA_SOLVER_2STAGE"\fP. The available kernels can be querried with \fBelpa2_print_kernels\fP(1).
\fB"qr"\fP : Choose whether in the real case computations in \fBelpa_eigenvalues\fP(3) or \fBelpa_eigenvectors\fP(3)compute steps, if solver is set to \fB"ELPA_SOLVER_2STAGE"\fP, a QR decompostion should be used.
\fB"qpu"\fP : Choose whether accelerated GPU calculations should be used. Only available if ELPA has been build with GPU support.
\fB"timings"\fP : Choose whether time measurements should be done in the ELPA routines.
\fB"debug"\f P : Choose whether, in case of an error, more debug information should be provided.
.br
.TP
.RI \fB"solver"\fP:
Choose which solver should be used in the compute steps \fBelpa_eigenvalues\fP(3) or \fBelpa_eigenvectors\fP(3). At the moment allowed option are \fB"ELPA_SOLVER_1STAGE"\fP or \fB"ELPA_SOLVER_2STAGE"\fP.
.TP
.RI \fB"real_kernel"\fP:
Choose which real kernel should be used in the \fBelpa_eigenvalues\fP(3) or \fBelpa_eigenvectors\fP(3) compute steps, if solver is set to \fB"ELPA_SOLVER_2STAGE"\fP. The available kernels can be querried with \fBelpa2_print_kernels\fP(1).
.TP
.RI \fB"complex_kernel"\fP:
Choose which complex kernel should be used in the \fBelpa_eigenvalues\fP(3) or \fBelpa_eigenvectors\fP(3) compute steps, if solver is set to \fB"ELPA_SOLVER_2STAGE"\fP. The available kernels can be querried with \fBelpa2_print_kernels\fP(1).
.TP
.RI \fB"qr"\fP:
Choose whether in the real case computations in \fBelpa_eigenvalues\fP(3) or \fBelpa_eigenvectors\fP(3) compute steps, if solver is set to \fB"ELPA_SOLVER_2STAGE"\fP, a QR decompostion should be used.
.TP
.RI \fB"qpu"\fP:
Choose whether accelerated GPU calculations should be used. Only available if ELPA has been build with GPU support.
.TP
.RI \fB"debug"\fP:
Choose whether, in case of an error, more debug information should be provided.
.br
.SH "SEE ALSO"
.br
......
man/elpa_setup.3
View file @ a8182a89
......@@ -20,7 +20,7 @@ class(elpa_t), pointer :: elpa
.RI "With the definintions of the input and output variables:"
.br
.RI "integer \fBsucces\fP: the returned error code. Should normally be ELPA_OK. Can be querried with \fBelpa_strerr\fP3"
.RI "integer :: \fBsucces\fP ! the returned error code. Should normally be ELPA_OK. Can be querried with \fBelpa_strerr\fP(3)"
.br
.br
......@@ -38,12 +38,12 @@ elpa_t handle;
.br
.br
.RI "elpa_t \fBhandle\fP: the handle of an ELPA object, obtained before with \fBelpa_allocate\fP(3)"
.RI "elpa_t \fBhandle\fP; // the handle of an ELPA object, obtained before with \fBelpa_allocate\fP(3)"
.br
.RI "int \fBsuccess\fP: the returned error code. Should normally be ELPA_OK. Can be querried with \fBelpa_strerr\fP(3)"
.RI "int \fBsuccess\fP; // the returned error code. Should normally be ELPA_OK. Can be querried with \fBelpa_strerr\fP(3)"
.SH DESCRIPTION
Setups an ELPA object. BEFORE the setup the functions \fBelpa_init\fP(3), \fBelpa_allocate\fP(3) must have been called and some parameters must have been set with \fBelpa_set\fP(3).
Setups an ELPA object. \fIPrior\fP to calling the setup, the functions \fBelpa_init\fP(3), \fBelpa_allocate\fP(3) \fImust have been called\fP and some parameters must have been set with \fBelpa_set\fP(3).
.br
.SH "SEE ALSO"
.br
......
man/elpa_uninit.3
View file @ a8182a89
......@@ -43,7 +43,7 @@ elpa_t handle;
.br
.SH DESCRIPTION
Uninitializes the ELPA library after usage. The function \fBelpa_init\fP(3) must have been called BEFORE elpa_uninit can be called.
Uninitializes the ELPA library after usage. The function \fBelpa_init\fP(3) must have been called \fIBEFORE\fP elpa_uninit can be called.
.br
.SH "SEE ALSO"
.br
......
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