Commit 3407b08b authored by Andreas Marek's avatar Andreas Marek
Browse files

Update doxygen documentation

parent 90b152f6
......@@ -53,7 +53,7 @@
#include "config-f90.h"
!> \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 elpa1
use elpa2
......
......@@ -92,7 +92,7 @@ module ELPA1
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 :: 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 eigenvalue problem. will be deleted at some point
public :: solve_evp_real_1stage !< Driver routine for real 1-stage eigenvalue problem
......@@ -148,6 +148,20 @@ module ELPA1
module procedure get_elpa_communicators
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
module procedure get_elpa_communicators
end interface
......
......@@ -52,8 +52,8 @@
#include "config-f90.h"
module elpa1_auxiliary
!> \brief Fortran module which provides helper routines for matrix calculations
module ELPA1_AUXILIARY
implicit none
private
......
......@@ -51,8 +51,8 @@
! distributed along with the original code in the file "COPYING".
#include "config-f90.h"
module ELPA1_compute
!> \brief Fortran module which contains the source of ELPA 1stage
module ELPA1_COMPUTE
use elpa_utilities
#ifdef HAVE_DETAILED_TIMINGS
use timings
......
This diff is collapsed.
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