Commit 0de0f7b8 authored by Andreas Marek's avatar Andreas Marek

Some man pages for the load/print/store functionality

parent 566f1f8e
......@@ -462,6 +462,8 @@ dist_man_MANS = \
man/elpa_solve_tridiagonal.3 \
man/elpa_hermitian_multiply.3 \
man/elpa_deallocate.3 \
man/elpa_load_settings.3 \
man/elpa_store_settings.3 \
man/elpa_uninit.3
if ENABLE_LEGACY
......
.TH "elpa_load_settings" 3 "Tue Nov 13 2018" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_load_settings \- loads the setting of an elpa object
.br
.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa
.br
class(elpa_t), pointer :: elpa
.br
.RI "call elpa%\fBload_settings\fP (filename, error)"
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.br
.TP
.RI "class(elpa_t) \fBelpa\f: returns an instance of the ELPA object"
.br
.RI "character(*) \fBfilename\fP: The file from where to load the settings"
.br
.RI "integer, optinal \fBerror\fP: A error return code"
.br
.SS C INTERFACE
#include <elpa/elpa.h>
.br
elpa_t handle;
.br
.RI "void \fBelpa_load_settings\fP(\fBelpa_t\fP handle, \fBconst char\fP *filename, \fBint\fP *error):
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.br
.TP
.RI "elpa_t \fBhandle\fP: The handle to the ELPA object"
.br
.TP
.RI "const char \fB*filename\fP: the filename to load the settings"
.br
.RI "int \fB*error\fP: the error return code"
.TP
.SH DESCRIPTION
Loads all the settings of an previously stored ELPA object from a file specified via the \fBfilename\fP parameter.
.SH "SEE ALSO"
.br
\fBelpa_store_setting\fP(3)
.TH "elpa_store_settings" 3 "Tue Nov 13 2018" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_store_settings \- stores the setting of an elpa object
.br
.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa
.br
class(elpa_t), pointer :: elpa
.br
.RI "call elpa%\fBstore_settings\fP (filename, error)"
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.br
.TP
.RI "class(elpa_t) \fBelpa\f: returns an instance of the ELPA object"
.br
.RI "character(*) \fBfilename\fP: The filename to be used for storing the settings"
.br
.RI "integer, optinal \fBerror\fP: A error return code"
.br
.SS C INTERFACE
#include <elpa/elpa.h>
.br
elpa_t handle;
.br
.RI "void \fBelpa_store_settings\fP(\fBelpa_t\fP handle, \fBconst char\fP *filename, \fBint\fP *error):
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.br
.TP
.RI "elpa_t \fBhandle\fP: The handle to the ELPA object"
.br
.TP
.RI "const char \fB*filename\fP: the filename to store the settings"
.br
.RI "int \fB*error\fP: the error return code"
.TP
.SH DESCRIPTION
Stores all the settings of an ELPA object in an human readable form to a file specified via the \fBfilename\fP parameter. The settings can later be restored with the
\fBelpa_load_settings\fP(3) method.
.SH "SEE ALSO"
.br
\fBelpa_load_setting\fP(3)
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