src/tools/eigensolver.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Green Red Orange Magenta Azure Cyan Skyblue
  34  */
  35
  36 #ifndef _EIGENSOLVER_H
  37 #define _EIGENSOLVER_H
  38
  39 #include "types/simple.h"
  40 #include "sparsematrix.h"
  41
  42
  43 /** Calculate eigenvalues/vectors a matrix stored in linear memory (not sparse).
  44  *
  45  *  This routine uses lapack to diagonalize a matrix efficiently, and
  46  *  the eigenvalues/vectors will be sorted in ascending order on output.
  47  *  Gromacs comes with a built-in portable BLAS/LAPACK, but if performance
  48  *  matters it is advisable to link with an optimized vendor-provided library.
  49  *
  50  *  \param a            Pointer to matrix data, total size n*n
  51  *                      The input data in the matrix will be destroyed/changed.
  52  *  \param n            Side of the matrix to calculate eigenvalues for.
  53  *  \param index_lower  Index of first eigenvector to determine.
  54  *  \param index_upper  Last eigenvector determined is index_upper-1.
  55  *  \param eigenvalues  Array of the eigenvalues on return. The length
  56  *                      of this array _must_ be n, even if not all
  57  *                      eigenvectors are calculated, since all eigenvalues
  58  *                      might be needed as an intermediate step.
  59  *  \param eigenvectors If this pointer is non-NULL, the eigenvectors
  60  *                      specified by the indices are returned as rows of
  61  *                      a matrix, i.e. eigenvector j starts at offset j*n, and
  62  *                      is of length n.
  63  */
  64 void
  65 eigensolver(real *   a,
  66             int      n,
  67             int      index_lower,
  68             int      index_upper,
  69             real *   eigenvalues,
  70             real *   eigenvec);
  71
  72
  73
  74 /*! \brief Sparse matrix eigensolver.
  75  *
  76  *  This routine is intended for large matrices that might not fit in memory.
  77  *
  78  *  It will determine the neig lowest eigenvalues, and if the eigenvectors pointer
  79  *  is non-NULL also the corresponding eigenvectors.
  80  *
  81  *  maxiter=100000 should suffice in most cases!
  82  */
  83 void
  84 sparse_eigensolver(gmx_sparsematrix_t *    A,
  85                    int                     neig,
  86                    real *                  eigenvalues,
  87                    real *                  eigenvectors,
  88                    int                     maxiter);
  89
  90
  91 #endif