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

Update man pages for legacy API

-man pages have been updated
-man pages for legacy API are only installed if legacy API is enabled
parent 2d684ef0
.TH "solve_evp_complex_1stage_single" 3 "Thu Mar 17 2016" "ELPA" \" -*- nroff -*-
.TH "solve_evp_complex_1stage_single" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
solve_evp_complex_1stage_single \- solve the single-precision complex eigenvalue problem with the 1-stage ELPA solver
solve_evp_complex_1stage_single \- solve the single-precision complex eigenvalue problem with the 1-stage ELPA solver (legacy interface)
.br
.SH SYNOPSIS
......@@ -47,7 +47,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
#include <complex.h>
......@@ -90,5 +90,12 @@ use elpa1
.SH DESCRIPTION
Solve the complex eigenvalue problem with the 1-stage solver. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function. The distributed quadratic marix \fBa\fP has global dimensions \fBna\fP x \fBna\fP, and a local size \fBlda\fP x \fBmatrixCols\fP. The solver will compute the first \fBnev\fP eigenvalues, which will be stored on exit in \fBev\fP. The eigenvectors corresponding to the eigenvalues will be stored in \fBq\fP. All memory of the arguments must be allocated outside the call to the solver.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
\fBelpa_get_communicators\fP(3) \fBsolve_evp_real_1stage_double\fP(3) \fBsolve_evp_real_1stage_single\fP(3) \fBsolve_evp_complex_1stage_double\fP(3) \fBsolve_evp_real_2stage_double\fP(3) \fBsolve_evp_real_2stage_single\fP(3) \fBsolve_evp_complex_2stage_double\fP(3) \fBsolve_evp_complex_2stage_single\fP(3) \fBprint_available_elpa2_kernels\fP(1)
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBsolve_evp_real_1stage_double\fP(3) \fBsolve_evp_real_1stage_single\fP(3) \fBsolve_evp_complex_1stage_double\fP(3) \fBsolve_evp_real_2stage_double\fP(3) \fBsolve_evp_real_2stage_single\fP(3) \fBsolve_evp_complex_2stage_double\fP(3) \fBsolve_evp_complex_2stage_single\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
.TH "solve_evp_complex_2stage" 3 "Tue Oct 18 2016" "ELPA" \" -*- nroff -*-
.TH "solve_evp_complex_2stage" 3 "Wed Mai 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
solve_evp_complex_2stage \- solve the complex eigenvalue problem with the 2-stage ELPA solver
solve_evp_complex_2stage \- solve the complex eigenvalue problem with the 2-stage ELPA solver (legacy interface)
Old, deprecated interface. It is recommended to use \fBelpa_solve_evp_complex_2stage\fP.(3)
.br
......@@ -51,7 +51,7 @@ use elpa2
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
#include <complex.h>
......@@ -100,5 +100,12 @@ Solve the complex eigenvalue problem with the 2-stage solver. The ELPA communica
.br
The interface \fBelpa_solve_evp_complex\fP(3) is a more flexible alternative.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
\fBelpa_get_communicators\fP(3) \fBelpa_solve_evp_real\fP(3) \fBelpa_solve_evp_complex\fP(3) \fBelpa_solve_evp_real_1stage\fP(3) \fBelpa_solve_evp_complex_1stage\fP(3) \fBelpa_solve_evp_real_2stage\fP(3) \fBelpa2_print_kernels\fP(1)
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_solve_evp_real\fP(3) \fBelpa_solve_evp_complex\fP(3) \fBelpa_solve_evp_real_1stage\fP(3) \fBelpa_solve_evp_complex_1stage\fP(3) \fBelpa_solve_evp_real_2stage\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
.TH "solve_evp_complex_2stage_double" 3 "Thu Mar 17 2016" "ELPA" \" -*- nroff -*-
.TH "solve_evp_complex_2stage_double" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
solve_evp_complex_2stage_double \- solve the double-precision complex eigenvalue problem with the 2-stage ELPA solver
solve_evp_complex_2stage_double \- solve the double-precision complex eigenvalue problem with the 2-stage ELPA solver (legacy interface)
.br
.SH SYNOPSIS
......@@ -48,7 +48,7 @@ use elpa2
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
#include <complex.h>
......@@ -91,5 +91,12 @@ use elpa2
.SH DESCRIPTION
Solve the complex eigenvalue problem with the 2-stage solver. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function. The distributed quadratic marix \fBa\fP has global dimensions \fBna\fP x \fBna\fP, and a local size \fBlda\fP x \fBmatrixCols\fP. The solver will compute the first \fBnev\fP eigenvalues, which will be stored on exit in \fBev\fP. The eigenvectors corresponding to the eigenvalues will be stored in \fBq\fP. All memory of the arguments must be allocated outside the call to the solver.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
\fBelpa_get_communicators\fP(3) \fBsolve_evp_real_1stage_double\fP(3) \fBsolve_evp_real_1stage_single\fP(3) \fBsolve_evp_complex_1stage_double\fP(3) \fBsolve_evp_complex_1stage_single\fP(3) \fBsolve_evp_real_2stage_double\fP(3) \fBsolve_evp_real_2stage_single\fP(3) \fBsolve_evp_complex_2stage_single\fP(3) \fBprint_available_elpa2_kernels\fP(1)
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBsolve_evp_real_1stage_double\fP(3) \fBsolve_evp_real_1stage_single\fP(3) \fBsolve_evp_complex_1stage_double\fP(3) \fBsolve_evp_complex_1stage_single\fP(3) \fBsolve_evp_real_2stage_double\fP(3) \fBsolve_evp_real_2stage_single\fP(3) \fBsolve_evp_complex_2stage_single\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
.TH "solve_evp_complex_2stage_single" 3 "Thu Mar 17 2016" "ELPA" \" -*- nroff -*-
.TH "solve_evp_complex_2stage_single" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
solve_evp_complex_2stage_single \- solve the single-precision complex eigenvalue problem with the 2-stage ELPA solver
solve_evp_complex_2stage_single \- solve the single-precision complex eigenvalue problem with the 2-stage ELPA solver (legacy interface)
.br
.SH SYNOPSIS
......@@ -48,7 +48,7 @@ use elpa2
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
#include <complex.h>
......@@ -91,5 +91,12 @@ use elpa2
.SH DESCRIPTION
Solve the complex eigenvalue problem with the 2-stage solver. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function. The distributed quadratic marix \fBa\fP has global dimensions \fBna\fP x \fBna\fP, and a local size \fBlda\fP x \fBmatrixCols\fP. The solver will compute the first \fBnev\fP eigenvalues, which will be stored on exit in \fBev\fP. The eigenvectors corresponding to the eigenvalues will be stored in \fBq\fP. All memory of the arguments must be allocated outside the call to the solver.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
\fBelpa_get_communicators\fP(3) \fBsolve_evp_real_1stage_double\fP(3) \fBsolve_evp_real_1stage_single\fP(3) \fBsolve_evp_complex_1stage_double\fP(3) \fBsolve_evp_complex_1stage_single\fP(3) \fBsolve_evp_real_2stage_double\fP(3) \fBsolve_evp_real_2stage_single\fP(3) \fBsolve_evp_complex_2stage_double\fP(3) \fBprint_available_elpa2_kernels\fP(1)
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBsolve_evp_real_1stage_double\fP(3) \fBsolve_evp_real_1stage_single\fP(3) \fBsolve_evp_complex_1stage_double\fP(3) \fBsolve_evp_complex_1stage_single\fP(3) \fBsolve_evp_real_2stage_double\fP(3) \fBsolve_evp_real_2stage_single\fP(3) \fBsolve_evp_complex_2stage_double\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
.TH "solve_evp_real_1stage" 3 "Tue Oct 18 2016" "ELPA" \" -*- nroff -*-
.TH "solve_evp_real_1stage" 3 "Wed Mai 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
solve_evp_real_1stage \- solve the real eigenvalue problem with the 1-stage ELPA solver
solve_evp_real_1stage \- solve the real eigenvalue problem with the 1-stage ELPA solver (legacy interface)
This interface is old and deprecated. It is recommended to use \fBelpa_solve_evp_real_1stage\fP(3)
.br
......@@ -49,7 +49,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "success = \fBsolve_evp_real_1stage\fP (\fBint\fP na, \fBint\fP nev, \fB double *\fPa, \fBint\fP lda, \fB double *\fPev, \fBdouble *\fPq, \fBint\fP ldq, \fBint\fP nblk, \fBint\fP matrixCols, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fBint\fP mpi_comm_all, \fBint\fP useGPU);"
......@@ -93,5 +93,12 @@ Solve the real eigenvalue problem with the 1-stage solver. The ELPA communicator
.br
The interface \fBelpa_solve_evp_real\fP(3) is a more flexible alternative.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
\fBelpa_get_communicators\fP(3) \fBelpa_solve_evp_real\fP(3) \fBelpa_solve_evp_complex\fP(3) \fBelpa_solve_evp_complex_1stage\fP(3) \fBelpa_solve_evp_real_2stage\fP(3) \fBelpa_solve_evp_complex_2stage\fP(3) \fBelpa2_print_kernels\fP(1)
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_solve_evp_real\fP(3) \fBelpa_solve_evp_complex\fP(3) \fBelpa_solve_evp_complex_1stage\fP(3) \fBelpa_solve_evp_real_2stage\fP(3) \fBelpa_solve_evp_complex_2stage\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
.TH "solve_evp_real_1stage_double" 3 "Thu Mar 17 2016" "ELPA" \" -*- nroff -*-
.TH "solve_evp_real_1stage_double" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
solve_evp_real_1stage_double \- solve the double-precision real eigenvalue problem with the 1-stage ELPA solver
solve_evp_real_1stage_double \- solve the double-precision real eigenvalue problem with the 1-stage ELPA solver (legacy interface)
.br
.SH SYNOPSIS
......@@ -48,7 +48,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "success = \fBsolve_evp_real_1stage_double_precision\fP (\fBint\fP na, \fBint\fP nev, \fB double *\fPa, \fBint\fP lda, \fB double *\fPev, \fBdouble *\fPq, \fBint\fP ldq, \fBint\fP nblk, \fBint\fP matrixCols, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fBint\fP mpi_comm_all, \fBint\fP useGPU);"
......@@ -90,5 +90,12 @@ use elpa1
.SH DESCRIPTION
Solve the real eigenvalue problem with the 1-stage solver. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function. The distributed quadratic marix \fBa\fP has global dimensions \fBna\fP x \fBna\fP, and a local size \fBlda\fP x \fBmatrixCols\fP. The solver will compute the first \fBnev\fP eigenvalues, which will be stored on exit in \fBev\fP. The eigenvectors corresponding to the eigenvalues will be stored in \fBq\fP. All memory of the arguments must be allocated outside the call to the solver.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
\fBelpa_get_communicators\fP(3) \fBsolve_evp_real_1stage_single\fP(3) \fBsolve_evp_complex_1stage_double\fP(3) \fBsolve_evp_complex_1stage_single\fP(3) \fBsolve_evp_real_2stage_double\fP(3) \fBsolve_evp_real_2stage_single\fP(3) \fBsolve_evp_complex_2stage_double\fP(3) \fBsolve_evp_complex_2stage_single\fP(3) \fBprint_available_elpa2_kernels\fP(1)
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBsolve_evp_real_1stage_single\fP(3) \fBsolve_evp_complex_1stage_double\fP(3) \fBsolve_evp_complex_1stage_single\fP(3) \fBsolve_evp_real_2stage_double\fP(3) \fBsolve_evp_real_2stage_single\fP(3) \fBsolve_evp_complex_2stage_double\fP(3) \fBsolve_evp_complex_2stage_single\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
.TH "solve_evp_real_1stage_single" 3 "Thu Mar 17 2016" "ELPA" \" -*- nroff -*-
.TH "solve_evp_real_1stage_single" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
solve_evp_real_1stage_single \- solve the single-precision real eigenvalue problem with the 1-stage ELPA solver
solve_evp_real_1stage_single \- solve the single-precision real eigenvalue problem with the 1-stage ELPA solver (legacy interface)
.br
.SH SYNOPSIS
......@@ -48,7 +48,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "success = \fBsolve_evp_real_1stage_single_precision\fP (\fBint\fP na, \fBint\fP nev, \fB float *\fPa, \fBint\fP lda, \fB float *\fPev, \fBfloat *\fPq, \fBint\fP ldq, \fBint\fP nblk, \fBint\fP matrixCols, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fBint\fP mpi_comm_all, \fBint\fP useGPU);"
......@@ -90,5 +90,12 @@ use elpa1
.SH DESCRIPTION
Solve the real eigenvalue problem with the 1-stage solver. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function. The distributed quadratic marix \fBa\fP has global dimensions \fBna\fP x \fBna\fP, and a local size \fBlda\fP x \fBmatrixCols\fP. The solver will compute the first \fBnev\fP eigenvalues, which will be stored on exit in \fBev\fP. The eigenvectors corresponding to the eigenvalues will be stored in \fBq\fP. All memory of the arguments must be allocated outside the call to the solver.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
\fBelpa_get_communicators\fP(3) \fBsolve_evp_real_1stage_double\fP(3) \fBsolve_evp_complex_1stage_double\fP(3) \fBsolve_evp_complex_1stage_single\fP(3) \fBsolve_evp_real_2stage_double\fP(3) \fBsolve_evp_real_2stage_single\fP(3) \fBsolve_evp_complex_2stage_double\fP(3) \fBsolve_evp_complex_2stage_single\fP(3) \fBprint_available_elpa2_kernels\fP(1)
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBsolve_evp_real_1stage_double\fP(3) \fBsolve_evp_complex_1stage_double\fP(3) \fBsolve_evp_complex_1stage_single\fP(3) \fBsolve_evp_real_2stage_double\fP(3) \fBsolve_evp_real_2stage_single\fP(3) \fBsolve_evp_complex_2stage_double\fP(3) \fBsolve_evp_complex_2stage_single\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
.TH "solve_evp_real_2stage" 3 "Tue Oct 18 2016" "ELPA" \" -*- nroff -*-
.TH "solve_evp_real_2stage" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
solve_evp_real_2stage \- solve the real eigenvalue problem with the 2-stage ELPA solver
solve_evp_real_2stage \- solve the real eigenvalue problem with the 2-stage ELPA solver (legacy interface)
Old, deprecated interface. It is recommended to use \fBelpa_solve_evp_real_2stage\fP(3)
.br
......@@ -53,7 +53,7 @@ use elpa2
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "success = \fBsolve_evp_real_2stage\fP (\fBint\fP na, \fBint\fP nev, \fB double *\fPa, \fBint\fP lda, \fB double *\fPev, \fBdouble *\fPq, \fBint\fP ldq, \fBint\fP nblk, \fBint\fP matrixCols, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fBint\fP mpi_comm_all, \fBint\fP THIS_ELPA_REAL_KERNEL, \fBint\fP useQR, \fBint\fP useGPU);"
......@@ -100,5 +100,12 @@ Solve the real eigenvalue problem with the 2-stage solver. The ELPA communicator
.br
The interface \fBelpa_solve_evp_real\fP(3) is a more flexible alternative.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
\fBelpa_get_communicators\fP(3) \fBelpa_solve_evp_real\fP(3) \fBelpa_solve_evp_complex\fP(3) \fBelpa_solve_evp_real_1stage\fP(3) \fBelpa_solve_evp_complex_1stage\fP(3) \fBelpa_solve_evp_complex_2stage\fP(3) \fBelpa2_print_kernels\fP(1)
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_solve_evp_real\fP(3) \fBelpa_solve_evp_complex\fP(3) \fBelpa_solve_evp_real_1stage\fP(3) \fBelpa_solve_evp_complex_1stage\fP(3) \fBelpa_solve_evp_complex_2stage\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
.TH "solve_evp_real_2stage_double" 3 "Thu Mar 17 2016" "ELPA" \" -*- nroff -*-
.TH "solve_evp_real_2stage_double" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
solve_evp_real_2stage_double \- solve the double-precision real eigenvalue problem with the 2-stage ELPA solver
solve_evp_real_2stage_double \- solve the double-precision real eigenvalue problem with the 2-stage ELPA solver (legacy interface)
.br
.SH SYNOPSIS
......@@ -50,7 +50,7 @@ use elpa2
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "success = \fBsolve_evp_real_2stage_double_precision\fP (\fBint\fP na, \fBint\fP nev, \fB double *\fPa, \fBint\fP lda, \fB double *\fPev, \fBdouble *\fPq, \fBint\fP ldq, \fBint\fP nblk, \fBint\fP matrixCols, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fBint\fP mpi_comm_all, \fBint\fP THIS_ELPA_REAL_KERNEL, \fBint\fP useQR, \fBint\fP useGPU);"
......@@ -93,5 +93,12 @@ use elpa2
.SH DESCRIPTION
Solve the real eigenvalue problem with the 2-stage solver. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function. The distributed quadratic marix \fBa\fP has global dimensions \fBna\fP x \fBna\fP, and a local size \fBlda\fP x \fBmatrixCols\fP. The solver will compute the first \fBnev\fP eigenvalues, which will be stored on exit in \fBev\fP. The eigenvectors corresponding to the eigenvalues will be stored in \fBq\fP. All memory of the arguments must be allocated outside the call to the solver.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
\fBelpa_get_communicators\fP(3) \fBsolve_evp_real_1stage_double\fP(3) \fBsolve_evp_real_1stage_single\fP(3) \fBsolve_evp_complex_1stage_double\fP(3) \fBsolve_evp_complex_1stage_single\fP(3) \fBsolve_evp_complex_2stage_double\fP(3) \fBsolve_evp_complex_2stage_single\fP(3) \fBsolve_evp_real_2stage_single\fP(3) \fBprint_available_elpa2_kernels\fP(1)
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBsolve_evp_real_1stage_double\fP(3) \fBsolve_evp_real_1stage_single\fP(3) \fBsolve_evp_complex_1stage_double\fP(3) \fBsolve_evp_complex_1stage_single\fP(3) \fBsolve_evp_complex_2stage_double\fP(3) \fBsolve_evp_complex_2stage_single\fP(3) \fBsolve_evp_real_2stage_single\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
.TH "solve_evp_real_2stage_single" 3 "Thu Mar 17 2016" "ELPA" \" -*- nroff -*-
.TH "solve_evp_real_2stage_single" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
solve_evp_real_2stage_single \- solve the single-precision real eigenvalue problem with the 2-stage ELPA solver
solve_evp_real_2stage_single \- solve the single-precision real eigenvalue problem with the 2-stage ELPA solver (legacy interface)
.br
.SH SYNOPSIS
......@@ -50,7 +50,7 @@ use elpa2
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "success = \fBsolve_evp_real_2stage_single_precision\fP (\fBint\fP na, \fBint\fP nev, \fBfloat *\fPa, \fBint\fP lda, \fBfloat *\fPev, \fBfloat *\fPq, \fBint\fP ldq, \fBint\fP nblk, \fBint\fP matrixCols, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fBint\fP mpi_comm_all, \fBint\fP THIS_ELPA_REAL_KERNEL, \fBint\fP useQR, \fBint\fP useGPU);"
......@@ -93,5 +93,12 @@ use elpa2
.SH DESCRIPTION
Solve the real eigenvalue problem with the 2-stage solver. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function. The distributed quadratic marix \fBa\fP has global dimensions \fBna\fP x \fBna\fP, and a local size \fBlda\fP x \fBmatrixCols\fP. The solver will compute the first \fBnev\fP eigenvalues, which will be stored on exit in \fBev\fP. The eigenvectors corresponding to the eigenvalues will be stored in \fBq\fP. All memory of the arguments must be allocated outside the call to the solver.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
\fBelpa_get_communicators\fP(3) \fBsolve_evp_real_1stage_double\fP(3) \fBsolve_evp_real_1stage_single\fP(3) \fBsolve_evp_complex_1stage_double\fP(3) \fBsolve_evp_complex_1stage_single\fP(3) \fBsolve_evp_complex_2stage_double\fP(3) \fBsolve_evp_complex_2stage_single\fP(3) \fBsolve_evp_real_2stage_double\fP(3) \fBprint_available_elpa2_kernels\fP(1)
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBsolve_evp_real_1stage_double\fP(3) \fBsolve_evp_real_1stage_single\fP(3) \fBsolve_evp_complex_1stage_double\fP(3) \fBsolve_evp_complex_1stage_single\fP(3) \fBsolve_evp_complex_2stage_double\fP(3) \fBsolve_evp_complex_2stage_single\fP(3) \fBsolve_evp_real_2stage_double\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
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