Commit b929f1fb authored by Andreas Marek's avatar Andreas Marek

Update doxygen documentation

parent edf4c373
...@@ -53,7 +53,7 @@ ...@@ -53,7 +53,7 @@
#include "config-f90.h" #include "config-f90.h"
!> \brief Fortran module which provides the routines to the ELPA solver (1 and 2 stage) !> \brief Fortran module which provides the routines to the ELPA solver (1 and 2 stage)
module elpa module ELPA
use, intrinsic :: iso_c_binding, only : c_double, c_int use, intrinsic :: iso_c_binding, only : c_double, c_int
use elpa1 use elpa1
use elpa2 use elpa2
......
...@@ -93,7 +93,7 @@ module ELPA1 ...@@ -93,7 +93,7 @@ module ELPA1
public :: get_elpa_row_col_comms !< old, deprecated interface, will be deleted. Use elpa_get_communicators instead public :: get_elpa_row_col_comms !< old, deprecated interface, will be deleted. Use elpa_get_communicators instead
public :: get_elpa_communicators !< Sets MPI row/col communicators; OLD and deprecated interface, will be deleted. Use elpa_get_communicators instead public :: get_elpa_communicators !< Sets MPI row/col communicators; OLD and deprecated interface, will be deleted. Use elpa_get_communicators instead
public :: elpa_get_communicators !< Sets MPI row/col communicators public :: elpa_get_communicators !< Sets MPI row/col communicators as needed by ELPA
public :: solve_evp_real !< old, deprecated interface: Driver routine for real double-precision eigenvalue problem DO NOT USE. Will be deleted at some point public :: solve_evp_real !< old, deprecated interface: Driver routine for real double-precision eigenvalue problem DO NOT USE. Will be deleted at some point
public :: solve_evp_real_1stage !< Driver routine for real double-precision eigenvalue problem public :: solve_evp_real_1stage !< Driver routine for real double-precision eigenvalue problem
...@@ -169,6 +169,20 @@ module ELPA1 ...@@ -169,6 +169,20 @@ module ELPA1
module procedure get_elpa_communicators module procedure get_elpa_communicators
end interface end interface
!> \brief elpa_get_communicators: Fortran interface to set the communicators needed by ELPA
!> \details
!> The interface and variable definition is the same as in "elpa_get_communicators"
!> \param mpi_comm_global Global communicator for the calculations (in)
!>
!> \param my_prow Row coordinate of the calling process in the process grid (in)
!>
!> \param my_pcol Column coordinate of the calling process in the process grid (in)
!>
!> \param mpi_comm_rows Communicator for communicating within rows of processes (out)
!>
!> \param mpi_comm_cols Communicator for communicating within columns of processes (out)
!> \result mpierr integer error value of mpi_comm_split function
interface elpa_get_communicators interface elpa_get_communicators
module procedure get_elpa_communicators module procedure get_elpa_communicators
end interface end interface
......
...@@ -52,8 +52,8 @@ ...@@ -52,8 +52,8 @@
#include "config-f90.h" #include "config-f90.h"
!> \brief Fortran module which provides helper routines for matrix calculations
module elpa1_auxiliary module ELPA1_AUXILIARY
implicit none implicit none
public :: elpa_mult_at_b_real_double !< Multiply double-precision real matrices A**T * B public :: elpa_mult_at_b_real_double !< Multiply double-precision real matrices A**T * B
......
...@@ -51,8 +51,8 @@ ...@@ -51,8 +51,8 @@
! distributed along with the original code in the file "COPYING". ! distributed along with the original code in the file "COPYING".
#include "config-f90.h" #include "config-f90.h"
!> \brief Fortran module which contains the source of ELPA 1stage
module ELPA1_compute module ELPA1_COMPUTE
use elpa_utilities use elpa_utilities
#ifdef HAVE_DETAILED_TIMINGS #ifdef HAVE_DETAILED_TIMINGS
use timings use timings
......
...@@ -1119,19 +1119,19 @@ ...@@ -1119,19 +1119,19 @@
!c> \brief C interface to solve double-precision tridiagonal eigensystem with divide and conquer method !c> \brief C interface to solve double-precision tridiagonal eigensystem with divide and conquer method
!c> \details !c> \details
!c> !c>
!c> \param na Matrix dimension !c> *\param na Matrix dimension
!c> \param nev number of eigenvalues/vectors to be computed !c> *\param nev number of eigenvalues/vectors to be computed
!c> \param d array d(na) on input diagonal elements of tridiagonal matrix, on !c> *\param d array d(na) on input diagonal elements of tridiagonal matrix, on
!c> output the eigenvalues in ascending order !c> * output the eigenvalues in ascending order
!c> \param e array e(na) on input subdiagonal elements of matrix, on exit destroyed !c> *\param e array e(na) on input subdiagonal elements of matrix, on exit destroyed
!c> \param q on exit : matrix q(ldq,matrixCols) contains the eigenvectors !c> *\param q on exit : matrix q(ldq,matrixCols) contains the eigenvectors
!c> \param ldq leading dimension of matrix q !c> *\param ldq leading dimension of matrix q
!c> \param nblk blocksize of cyclic distribution, must be the same in both directions! !c> *\param nblk blocksize of cyclic distribution, must be the same in both directions!
!c> \param matrixCols columns of matrix q !c> *\param matrixCols columns of matrix q
!c> \param mpi_comm_rows MPI communicator for rows !c> *\param mpi_comm_rows MPI communicator for rows
!c> \param mpi_comm_cols MPI communicator for columns !c> *\param mpi_comm_cols MPI communicator for columns
!c> \param wantDebug give more debug information if 1, else 0 !c> *\param wantDebug give more debug information if 1, else 0
!c> \result success int 1 on success, else 0 !c> *\result success int 1 on success, else 0
!c> */ !c> */
!c> int elpa_solve_tridi_double(int na, int nev, double *d, double *e, double *q, int ldq, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int wantDebug); !c> int elpa_solve_tridi_double(int na, int nev, double *d, double *e, double *q, int ldq, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int wantDebug);
function elpa_solve_tridi_wrapper_double(na, nev, d, e, q, ldq, nblk, matrixCols, mpi_comm_rows, mpi_comm_cols, wantDebug) & function elpa_solve_tridi_wrapper_double(na, nev, d, e, q, ldq, nblk, matrixCols, mpi_comm_rows, mpi_comm_cols, wantDebug) &
...@@ -1594,7 +1594,6 @@ ...@@ -1594,7 +1594,6 @@
end function end function
#endif /* WANT_SINGLE_PRECISION_REAL */ #endif /* WANT_SINGLE_PRECISION_REAL */
!c> /* !c> /*
...@@ -1708,19 +1707,19 @@ ...@@ -1708,19 +1707,19 @@
!c> \brief elpa_cholesky_real_double: Cholesky factorization of a double-precision real symmetric matrix !c> \brief elpa_cholesky_real_double: Cholesky factorization of a double-precision real symmetric matrix
!c> \details !c> \details
!c> !c>
!c> \param na Order of matrix !c> *\param na Order of matrix
!c> \param a(lda,matrixCols) Distributed matrix which should be factorized. !c> *\param a(lda,matrixCols) Distributed matrix which should be factorized.
!c> Distribution is like in Scalapack. !c> * Distribution is like in Scalapack.
!c> Only upper triangle is needs to be set. !c> * Only upper triangle is needs to be set.
!c> On return, the upper triangle contains the Cholesky factor !c> * On return, the upper triangle contains the Cholesky factor
!c> and the lower triangle is set to 0. !c> * and the lower triangle is set to 0.
!c> \param lda Leading dimension of a !c> *\param lda Leading dimension of a
!c> \param matrixCols local columns of matrix a !c> *\param matrixCols local columns of matrix a
!c> \param nblk blocksize of cyclic distribution, must be the same in both directions! !c> *\param nblk blocksize of cyclic distribution, must be the same in both directions!
!c> \param mpi_comm_rows MPI communicator for rows !c> *\param mpi_comm_rows MPI communicator for rows
!c> \param mpi_comm_cols MPI communicator for columns !c> *\param mpi_comm_cols MPI communicator for columns
!c> \param wantDebug int more debug information on failure if 1, else 0 !c> *\param wantDebug int more debug information on failure if 1, else 0
!c> \result succes int reports success (1) or failure (0) !c> *\result succes int reports success (1) or failure (0)
!c> */ !c> */
!c> int elpa_cholesky_real_double(int na, double *a, int lda, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int wantDebug); !c> int elpa_cholesky_real_double(int na, double *a, int lda, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int wantDebug);
......
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