src/gromacs/gmxana/gmx_dyndom.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, 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 #ifdef HAVE_CONFIG_H
  38 #include <config.h>
  39 #endif
  40
  41 #include "index.h"
  42 #include "gromacs/fileio/confio.h"
  43 #include "gromacs/math/units.h"
  44 #include "gmx_ana.h"
  45 #include "macros.h"
  46 #include "gromacs/fileio/trxio.h"
  47
  48 #include "gromacs/commandline/pargs.h"
  49 #include "gromacs/math/3dtransforms.h"
  50 #include "gromacs/math/vec.h"
  51 #include "gromacs/utility/fatalerror.h"
  52 #include "gromacs/utility/smalloc.h"
  53
  54 static void rot_conf(t_atoms *atoms, rvec x[], rvec v[], real trans, real angle,
  55                      rvec head, rvec tail, int isize, atom_id index[],
  56                      rvec xout[], rvec vout[])
  57 {
  58     rvec     arrow, xcm;
  59     real     theta, phi, arrow_len;
  60     mat4     Rx, Ry, Rz, Rinvy, Rinvz, Mtot;
  61     mat4     temp1, temp2, temp3;
  62     vec4     xv;
  63     int      i, j, ai;
  64
  65     rvec_sub(tail, head, arrow);
  66     arrow_len = norm(arrow);
  67     if (debug)
  68     {
  69         fprintf(debug, "Arrow vector:   %10.4f  %10.4f  %10.4f\n",
  70                 arrow[XX], arrow[YY], arrow[ZZ]);
  71         fprintf(debug, "Effective translation %g nm\n", trans);
  72     }
  73     if (arrow_len == 0.0)
  74     {
  75         gmx_fatal(FARGS, "Arrow vector not given");
  76     }
  77
  78     /* Copy all aoms to output */
  79     for (i = 0; (i < atoms->nr); i++)
  80     {
  81         copy_rvec(x[i], xout[i]);
  82         copy_rvec(v[i], vout[i]);
  83     }
  84
  85     /* Compute center of mass and move atoms there */
  86     clear_rvec(xcm);
  87     for (i = 0; (i < isize); i++)
  88     {
  89         rvec_inc(xcm, x[index[i]]);
  90     }
  91     for (i = 0; (i < DIM); i++)
  92     {
  93         xcm[i] /= isize;
  94     }
  95     if (debug)
  96     {
  97         fprintf(debug, "Center of mass: %10.4f  %10.4f  %10.4f\n",
  98                 xcm[XX], xcm[YY], xcm[ZZ]);
  99     }
 100     for (i = 0; (i < isize); i++)
 101     {
 102         rvec_sub(x[index[i]], xcm, xout[index[i]]);
 103     }
 104
 105     /* Compute theta and phi that describe the arrow */
 106     theta = acos(arrow[ZZ]/arrow_len);
 107     phi   = atan2(arrow[YY]/arrow_len, arrow[XX]/arrow_len);
 108     if (debug)
 109     {
 110         fprintf(debug, "Phi = %.1f, Theta = %.1f\n", RAD2DEG*phi, RAD2DEG*theta);
 111     }
 112
 113     /* Now the total rotation matrix: */
 114     /* Rotate a couple of times */
 115     gmx_mat4_init_rotation(ZZ, -phi, Rz);
 116     gmx_mat4_init_rotation(YY, M_PI/2-theta, Ry);
 117     gmx_mat4_init_rotation(XX, angle*DEG2RAD, Rx);
 118     Rx[WW][XX] = trans;
 119     gmx_mat4_init_rotation(YY, theta-M_PI/2, Rinvy);
 120     gmx_mat4_init_rotation(ZZ, phi, Rinvz);
 121
 122     gmx_mat4_mmul(temp1, Ry, Rz);
 123     gmx_mat4_mmul(temp2, Rinvy, Rx);
 124     gmx_mat4_mmul(temp3, temp2, temp1);
 125     gmx_mat4_mmul(Mtot, Rinvz, temp3);
 126
 127     if (debug)
 128     {
 129         gmx_mat4_print(debug, "Rz", Rz);
 130         gmx_mat4_print(debug, "Ry", Ry);
 131         gmx_mat4_print(debug, "Rx", Rx);
 132         gmx_mat4_print(debug, "Rinvy", Rinvy);
 133         gmx_mat4_print(debug, "Rinvz", Rinvz);
 134         gmx_mat4_print(debug, "Mtot", Mtot);
 135     }
 136
 137     for (i = 0; (i < isize); i++)
 138     {
 139         ai = index[i];
 140         gmx_mat4_transform_point(Mtot, xout[ai], xv);
 141         rvec_add(xv, xcm, xout[ai]);
 142         gmx_mat4_transform_point(Mtot, v[ai], xv);
 143         copy_rvec(xv, vout[ai]);
 144     }
 145 }
 146
 147 int gmx_dyndom(int argc, char *argv[])
 148 {
 149     const char  *desc[] = {
 150         "[THISMODULE] reads a [TT].pdb[tt] file output from DynDom",
 151         "(http://www.cmp.uea.ac.uk/dyndom/).",
 152         "It reads the coordinates, the coordinates of the rotation axis,",
 153         "and an index file containing the domains.",
 154         "Furthermore, it takes the first and last atom of the arrow file",
 155         "as command line arguments (head and tail) and",
 156         "finally it takes the translation vector (given in DynDom info file)",
 157         "and the angle of rotation (also as command line arguments). If the angle",
 158         "determined by DynDom is given, one should be able to recover the",
 159         "second structure used for generating the DynDom output.",
 160         "Because of limited numerical accuracy this should be verified by",
 161         "computing an all-atom RMSD (using [gmx-confrms]) rather than by file",
 162         "comparison (using diff).[PAR]",
 163         "The purpose of this program is to interpolate and extrapolate the",
 164         "rotation as found by DynDom. As a result unphysical structures with",
 165         "long or short bonds, or overlapping atoms may be produced. Visual",
 166         "inspection, and energy minimization may be necessary to",
 167         "validate the structure."
 168     };
 169     static real  trans0 = 0;
 170     static rvec  head   = { 0, 0, 0 };
 171     static rvec  tail   = { 0, 0, 0 };
 172     static real  angle0 = 0, angle1 = 0, maxangle = 0;
 173     static int   label  = 0, nframes = 11;
 174     t_pargs      pa[]   = {
 175         { "-firstangle",    FALSE, etREAL, {&angle0},
 176           "Angle of rotation about rotation vector" },
 177         { "-lastangle",    FALSE, etREAL, {&angle1},
 178           "Angle of rotation about rotation vector" },
 179         { "-nframe",   FALSE, etINT,  {&nframes},
 180           "Number of steps on the pathway" },
 181         { "-maxangle", FALSE, etREAL, {&maxangle},
 182           "DymDom dtermined angle of rotation about rotation vector" },
 183         { "-trans",    FALSE, etREAL, {&trans0},
 184           "Translation (Angstrom) along rotation vector (see DynDom info file)" },
 185         { "-head",     FALSE, etRVEC, {head},
 186           "First atom of the arrow vector" },
 187         { "-tail",     FALSE, etRVEC, {tail},
 188           "Last atom of the arrow vector" }
 189     };
 190     int          i, j, natoms, isize;
 191     t_trxstatus *status;
 192     atom_id     *index = NULL, *index_all;
 193     char         title[256], *grpname;
 194     t_atoms      atoms;
 195     real         angle, trans;
 196     rvec        *x, *v, *xout, *vout;
 197     matrix       box;
 198     output_env_t oenv;
 199
 200     t_filenm     fnm[] = {
 201         { efPDB, "-f", "dyndom",  ffREAD },
 202         { efTRO, "-o", "rotated", ffWRITE },
 203         { efNDX, "-n", "domains", ffREAD }
 204     };
 205 #define NFILE asize(fnm)
 206
 207     if (!parse_common_args(&argc, argv, 0, NFILE, fnm, asize(pa), pa,
 208                            asize(desc), desc, 0, NULL, &oenv))
 209     {
 210         return 0;
 211     }
 212
 213     get_stx_coordnum (opt2fn("-f", NFILE, fnm), &natoms);
 214     init_t_atoms(&atoms, natoms, TRUE);
 215     snew(x, natoms);
 216     snew(v, natoms);
 217     read_stx_conf(opt2fn("-f", NFILE, fnm), title, &atoms, x, v, NULL, box);
 218     snew(xout, natoms);
 219     snew(vout, natoms);
 220
 221     printf("Select group to rotate:\n");
 222     rd_index(ftp2fn(efNDX, NFILE, fnm), 1, &isize, &index, &grpname);
 223     printf("Going to rotate %s containg %d atoms\n", grpname, isize);
 224
 225     snew(index_all, atoms.nr);
 226     for (i = 0; (i < atoms.nr); i++)
 227     {
 228         index_all[i] = i;
 229     }
 230
 231     status = open_trx(opt2fn("-o", NFILE, fnm), "w");
 232
 233     label = 'A';
 234     for (i = 0; (i < nframes); i++, label++)
 235     {
 236         angle = angle0 + (i*(angle1-angle0))/(nframes-1);
 237         trans = trans0*0.1*angle/maxangle;
 238         printf("Frame: %2d (label %c), angle: %8.3f deg., trans: %8.3f nm\n",
 239                i, label, angle, trans);
 240         rot_conf(&atoms, x, v, trans, angle, head, tail, isize, index, xout, vout);
 241
 242         if (label > 'Z')
 243         {
 244             label -= 26;
 245         }
 246         for (j = 0; (j < atoms.nr); j++)
 247         {
 248             atoms.resinfo[atoms.atom[j].resind].chainid = label;
 249         }
 250
 251         write_trx(status, atoms.nr, index_all, &atoms, i, angle, box, xout, vout, NULL);
 252     }
 253     close_trx(status);
 254
 255     return 0;
 256 }