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