src/tools/eigio.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 _eigio_h
  37 #define _eigio_h
  38
  39 #include "typedefs.h"
  40
  41 enum { eWXR_NO, eWXR_YES, eWXR_NOFIT };
  42
  43 extern void read_eigenvectors(const char *file,int *natoms,gmx_bool *bFit,
  44                               rvec **xref,gmx_bool *bDMR,
  45                               rvec **xav,gmx_bool *bDMA,
  46                               int *nvec, int **eignr, rvec ***eigvec, real **eigval);
  47 /* Read eigenvectors from file into eigvec, the eigenvector numbers   */
  48 /* are stored in eignr.                                               */
  49 /* When bFit=FALSE no fitting was used in the covariance analysis.    */
  50 /* xref is the reference structure, can be NULL if not present.       */
  51 /* bDMR indicates mass weighted fit.                                  */
  52 /* xav is the average/minimum structure is written (t=0).             */
  53 /* bDMA indicates mass weighted analysis/eigenvectors.                */
  54
  55 extern void write_eigenvectors(const char *trnname,int natoms,real mat[],
  56                                gmx_bool bReverse,int begin,int end,
  57                                int WriteXref,rvec *xref,gmx_bool bDMR,
  58                                rvec xav[],gmx_bool bDMA, real *eigval);
  59 /* Write eigenvectors in mat to a TRN file.                           */
  60 /* The reference structure is written (t=-1) when WriteXref=eWXR_YES. */
  61 /* When WriteXref==eWXR_NOFIT a zero frame is written (t=-1),         */
  62 /* with lambda=-1.                                                    */
  63 /* bDMR indicates mass weighted fit.                                  */
  64 /* The average/minimum structure is written (t=0).                    */
  65 /* bDMA indicates mass weighted analysis/eigenvectors.                */
  66 /* eigenvectors with begin <= num <= end are written (num is base-1), */
  67 /* the timestamp of eigenvector num is num.                           */
  68 /* If bReverse==TRUE, num=1 is the last vector in mat.                */
  69
  70
  71 /* Read up to nmax eigenvalues from file fn, store the values in eigval[],
  72  * and the corresponding indices (start counting on 0) in eigvalnr[].
  73  * Returns the number of values read.
  74  */
  75 int read_eigval  (const char *          fn,
  76                   int             nmax,
  77                   int             eigvalnr[],
  78                   real            eigval[]);
  79
  80 #endif