src/tools/eigio.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef _eigio_h
  40 #define _eigio_h
  41
  42 #include "typedefs.h"
  43
  44 enum { eWXR_NO, eWXR_YES, eWXR_NOFIT };
  45
  46 extern void read_eigenvectors(const char *file,int *natoms,gmx_bool *bFit,
  47                               rvec **xref,gmx_bool *bDMR,
  48                               rvec **xav,gmx_bool *bDMA,
  49                               int *nvec, int **eignr, rvec ***eigvec, real **eigval);
  50 /* Read eigenvectors from file into eigvec, the eigenvector numbers   */
  51 /* are stored in eignr.                                               */
  52 /* When bFit=FALSE no fitting was used in the covariance analysis.    */
  53 /* xref is the reference structure, can be NULL if not present.       */
  54 /* bDMR indicates mass weighted fit.                                  */
  55 /* xav is the average/minimum structure is written (t=0).             */
  56 /* bDMA indicates mass weighted analysis/eigenvectors.                */
  57
  58 extern void write_eigenvectors(const char *trnname,int natoms,real mat[],
  59                                gmx_bool bReverse,int begin,int end,
  60                                int WriteXref,rvec *xref,gmx_bool bDMR,
  61                                rvec xav[],gmx_bool bDMA, real *eigval);
  62 /* Write eigenvectors in mat to a TRN file.                           */
  63 /* The reference structure is written (t=-1) when WriteXref=eWXR_YES. */
  64 /* When WriteXref==eWXR_NOFIT a zero frame is written (t=-1),         */
  65 /* with lambda=-1.                                                    */
  66 /* bDMR indicates mass weighted fit.                                  */
  67 /* The average/minimum structure is written (t=0).                    */
  68 /* bDMA indicates mass weighted analysis/eigenvectors.                */
  69 /* eigenvectors with begin <= num <= end are written (num is base-1), */
  70 /* the timestamp of eigenvector num is num.                           */
  71 /* If bReverse==TRUE, num=1 is the last vector in mat.                */
  72
  73
  74 /* Read up to nmax eigenvalues from file fn, store the values in eigval[],
  75  * and the corresponding indices (start counting on 0) in eigvalnr[].
  76  * Returns the number of values read.
  77  */
  78 int read_eigval  (const char *          fn,
  79                   int             nmax,
  80                   int             eigvalnr[],
  81                   real            eigval[]);
  82
  83 #endif