src/gromacs/gmxana/gmx_nmens.c

   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, 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 #include "gmxpre.h"
  38
  39 #include <math.h>
  40 #include <string.h>
  41
  42 #include "gromacs/commandline/pargs.h"
  43 #include "gromacs/fileio/confio.h"
  44 #include "gromacs/fileio/pdbio.h"
  45 #include "gromacs/fileio/trxio.h"
  46 #include "gromacs/gmxana/eigio.h"
  47 #include "gromacs/gmxana/gmx_ana.h"
  48 #include "gromacs/legacyheaders/macros.h"
  49 #include "gromacs/legacyheaders/txtdump.h"
  50 #include "gromacs/legacyheaders/typedefs.h"
  51 #include "gromacs/math/units.h"
  52 #include "gromacs/math/vec.h"
  53 #include "gromacs/random/random.h"
  54 #include "gromacs/topology/index.h"
  55 #include "gromacs/utility/cstringutil.h"
  56 #include "gromacs/utility/fatalerror.h"
  57 #include "gromacs/utility/futil.h"
  58 #include "gromacs/utility/smalloc.h"
  59
  60
  61 int gmx_nmens(int argc, char *argv[])
  62 {
  63     const char *desc[] = {
  64         "[THISMODULE] generates an ensemble around an average structure",
  65         "in a subspace that is defined by a set of normal modes (eigenvectors).",
  66         "The eigenvectors are assumed to be mass-weighted.",
  67         "The position along each eigenvector is randomly taken from a Gaussian",
  68         "distribution with variance kT/eigenvalue.[PAR]",
  69         "By default the starting eigenvector is set to 7, since the first six",
  70         "normal modes are the translational and rotational degrees of freedom."
  71     };
  72     static int  nstruct = 100, first = 7, last = -1, seed = -1;
  73     static real temp    = 300.0;
  74     t_pargs     pa[]    = {
  75         { "-temp",  FALSE, etREAL, {&temp},
  76           "Temperature in Kelvin" },
  77         { "-seed", FALSE, etINT, {&seed},
  78           "Random seed, -1 generates a seed from time and pid" },
  79         { "-num", FALSE, etINT, {&nstruct},
  80           "Number of structures to generate" },
  81         { "-first", FALSE, etINT, {&first},
  82           "First eigenvector to use (-1 is select)" },
  83         { "-last",  FALSE, etINT, {&last},
  84           "Last eigenvector to use (-1 is till the last)" }
  85     };
  86 #define NPA asize(pa)
  87
  88     t_trxstatus        *out;
  89     int                 status, trjout;
  90     t_topology          top;
  91     int                 ePBC;
  92     t_atoms            *atoms;
  93     rvec               *xtop, *xref, *xav, *xout1, *xout2;
  94     gmx_bool            bDMR, bDMA, bFit;
  95     int                 nvec, *eignr = NULL;
  96     rvec              **eigvec = NULL;
  97     matrix              box;
  98     real               *eigval, totmass, *invsqrtm, t, disp;
  99     int                 natoms, neigval;
 100     char               *grpname, title[STRLEN];
 101     const char         *indexfile;
 102     int                 i, j, d, s, v;
 103     int                 nout, *iout, noutvec, *outvec;
 104     atom_id            *index;
 105     real                rfac, invfr, rhalf, jr;
 106     int          *      eigvalnr;
 107     output_env_t        oenv;
 108     gmx_rng_t           rng;
 109     unsigned long       jran;
 110     const unsigned long im = 0xffff;
 111     const unsigned long ia = 1093;
 112     const unsigned long ic = 18257;
 113
 114
 115     t_filenm fnm[] = {
 116         { efTRN, "-v",    "eigenvec",    ffREAD  },
 117         { efXVG, "-e",    "eigenval",    ffREAD  },
 118         { efTPS, NULL,    NULL,          ffREAD },
 119         { efNDX, NULL,    NULL,          ffOPTRD },
 120         { efTRO, "-o",    "ensemble",    ffWRITE }
 121     };
 122 #define NFILE asize(fnm)
 123
 124     if (!parse_common_args(&argc, argv, 0,
 125                            NFILE, fnm, NPA, pa, asize(desc), desc, 0, NULL, &oenv))
 126     {
 127         return 0;
 128     }
 129
 130     indexfile = ftp2fn_null(efNDX, NFILE, fnm);
 131
 132     read_eigenvectors(opt2fn("-v", NFILE, fnm), &natoms, &bFit,
 133                       &xref, &bDMR, &xav, &bDMA, &nvec, &eignr, &eigvec, &eigval);
 134
 135     read_tps_conf(ftp2fn(efTPS, NFILE, fnm), title, &top, &ePBC, &xtop, NULL, box, bDMA);
 136     atoms = &top.atoms;
 137
 138     printf("\nSelect an index group of %d elements that corresponds to the eigenvectors\n", natoms);
 139     get_index(atoms, indexfile, 1, &i, &index, &grpname);
 140     if (i != natoms)
 141     {
 142         gmx_fatal(FARGS, "you selected a group with %d elements instead of %d",
 143                   i, natoms);
 144     }
 145     printf("\n");
 146
 147     snew(invsqrtm, natoms);
 148     if (bDMA)
 149     {
 150         for (i = 0; (i < natoms); i++)
 151         {
 152             invsqrtm[i] = gmx_invsqrt(atoms->atom[index[i]].m);
 153         }
 154     }
 155     else
 156     {
 157         for (i = 0; (i < natoms); i++)
 158         {
 159             invsqrtm[i] = 1.0;
 160         }
 161     }
 162
 163     if (last == -1)
 164     {
 165         last = natoms*DIM;
 166     }
 167     if (first > -1)
 168     {
 169         /* make an index from first to last */
 170         nout = last-first+1;
 171         snew(iout, nout);
 172         for (i = 0; i < nout; i++)
 173         {
 174             iout[i] = first-1+i;
 175         }
 176     }
 177     else
 178     {
 179         printf("Select eigenvectors for output, end your selection with 0\n");
 180         nout = -1;
 181         iout = NULL;
 182         do
 183         {
 184             nout++;
 185             srenew(iout, nout+1);
 186             if (1 != scanf("%d", &iout[nout]))
 187             {
 188                 gmx_fatal(FARGS, "Error reading user input");
 189             }
 190             iout[nout]--;
 191         }
 192         while (iout[nout] >= 0);
 193         printf("\n");
 194     }
 195
 196     /* make an index of the eigenvectors which are present */
 197     snew(outvec, nout);
 198     noutvec = 0;
 199     for (i = 0; i < nout; i++)
 200     {
 201         j = 0;
 202         while ((j < nvec) && (eignr[j] != iout[i]))
 203         {
 204             j++;
 205         }
 206         if ((j < nvec) && (eignr[j] == iout[i]))
 207         {
 208             outvec[noutvec] = j;
 209             iout[noutvec]   = iout[i];
 210             noutvec++;
 211         }
 212     }
 213
 214     fprintf(stderr, "%d eigenvectors selected for output\n", noutvec);
 215
 216     if (seed == -1)
 217     {
 218         seed = (int)gmx_rng_make_seed();
 219         rng  = gmx_rng_init(seed);
 220     }
 221     else
 222     {
 223         rng = gmx_rng_init(seed);
 224     }
 225     fprintf(stderr, "Using seed %d and a temperature of %g K\n", seed, temp);
 226
 227     snew(xout1, natoms);
 228     snew(xout2, atoms->nr);
 229     out  = open_trx(ftp2fn(efTRO, NFILE, fnm), "w");
 230     jran = (unsigned long)((real)im*gmx_rng_uniform_real(rng));
 231     gmx_rng_destroy(rng);
 232     for (s = 0; s < nstruct; s++)
 233     {
 234         for (i = 0; i < natoms; i++)
 235         {
 236             copy_rvec(xav[i], xout1[i]);
 237         }
 238         for (j = 0; j < noutvec; j++)
 239         {
 240             v = outvec[j];
 241             /* (r-0.5) n times:  var_n = n * var_1 = n/12
 242                n=4:  var_n = 1/3, so multiply with 3 */
 243
 244             rfac  = sqrt(3.0 * BOLTZ*temp/eigval[iout[j]]);
 245             rhalf = 2.0*rfac;
 246             rfac  = rfac/(real)im;
 247
 248             jran = (jran*ia+ic) & im;
 249             jr   = (real)jran;
 250             jran = (jran*ia+ic) & im;
 251             jr  += (real)jran;
 252             jran = (jran*ia+ic) & im;
 253             jr  += (real)jran;
 254             jran = (jran*ia+ic) & im;
 255             jr  += (real)jran;
 256             disp = rfac * jr - rhalf;
 257
 258             for (i = 0; i < natoms; i++)
 259             {
 260                 for (d = 0; d < DIM; d++)
 261                 {
 262                     xout1[i][d] += disp*eigvec[v][i][d]*invsqrtm[i];
 263                 }
 264             }
 265         }
 266         for (i = 0; i < natoms; i++)
 267         {
 268             copy_rvec(xout1[i], xout2[index[i]]);
 269         }
 270         t = s+1;
 271         write_trx(out, natoms, index, atoms, 0, t, box, xout2, NULL, NULL);
 272         fprintf(stderr, "\rGenerated %d structures", s+1);
 273     }
 274     fprintf(stderr, "\n");
 275     close_trx(out);
 276
 277     return 0;
 278 }