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