src/gromacs/gmxana/gmx_trjconv.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 <stdlib.h>
  41 #include <string.h>
  42
  43 #include "gromacs/commandline/pargs.h"
  44 #include "gromacs/fileio/confio.h"
  45 #include "gromacs/fileio/gmxfio.h"
  46 #include "gromacs/fileio/pdbio.h"
  47 #include "gromacs/fileio/tngio_for_tools.h"
  48 #include "gromacs/fileio/tpxio.h"
  49 #include "gromacs/fileio/trnio.h"
  50 #include "gromacs/fileio/trxio.h"
  51 #include "gromacs/fileio/xtcio.h"
  52 #include "gromacs/fileio/xvgr.h"
  53 #include "gromacs/gmxana/gmx_ana.h"
  54 #include "gromacs/legacyheaders/copyrite.h"
  55 #include "gromacs/legacyheaders/macros.h"
  56 #include "gromacs/legacyheaders/names.h"
  57 #include "gromacs/legacyheaders/typedefs.h"
  58 #include "gromacs/legacyheaders/viewit.h"
  59 #include "gromacs/math/do_fit.h"
  60 #include "gromacs/math/vec.h"
  61 #include "gromacs/pbcutil/pbc.h"
  62 #include "gromacs/pbcutil/rmpbc.h"
  63 #include "gromacs/topology/index.h"
  64 #include "gromacs/topology/topology.h"
  65 #include "gromacs/utility/fatalerror.h"
  66 #include "gromacs/utility/futil.h"
  67 #include "gromacs/utility/smalloc.h"
  68
  69 enum {
  70     euSel, euRect, euTric, euCompact, euNR
  71 };
  72
  73
  74 static void calc_pbc_cluster(int ecenter, int nrefat, t_topology *top, int ePBC,
  75                              rvec x[], atom_id index[], matrix box)
  76 {
  77     int       m, i, j, j0, j1, jj, ai, aj;
  78     int       imin, jmin;
  79     real      fac, min_dist2;
  80     rvec      dx, xtest, box_center;
  81     int       nmol, imol_center;
  82     atom_id  *molind;
  83     gmx_bool *bMol, *bTmp;
  84     rvec     *m_com, *m_shift;
  85     t_pbc     pbc;
  86     real     *com_dist2;
  87     int      *cluster;
  88     int      *added;
  89     int       ncluster, nadded;
  90     real      tmp_r2;
  91
  92     calc_box_center(ecenter, box, box_center);
  93
  94     /* Initiate the pbc structure */
  95     memset(&pbc, 0, sizeof(pbc));
  96     set_pbc(&pbc, ePBC, box);
  97
  98     /* Convert atom index to molecular */
  99     nmol   = top->mols.nr;
 100     molind = top->mols.index;
 101     snew(bMol, nmol);
 102     snew(m_com, nmol);
 103     snew(m_shift, nmol);
 104     snew(cluster, nmol);
 105     snew(added, nmol);
 106     snew(bTmp, top->atoms.nr);
 107
 108     for (i = 0; (i < nrefat); i++)
 109     {
 110         /* Mark all molecules in the index */
 111         ai       = index[i];
 112         bTmp[ai] = TRUE;
 113         /* Binary search assuming the molecules are sorted */
 114         j0 = 0;
 115         j1 = nmol-1;
 116         while (j0 < j1)
 117         {
 118             if (ai < molind[j0+1])
 119             {
 120                 j1 = j0;
 121             }
 122             else if (ai >= molind[j1])
 123             {
 124                 j0 = j1;
 125             }
 126             else
 127             {
 128                 jj = (j0+j1)/2;
 129                 if (ai < molind[jj+1])
 130                 {
 131                     j1 = jj;
 132                 }
 133                 else
 134                 {
 135                     j0 = jj;
 136                 }
 137             }
 138         }
 139         bMol[j0] = TRUE;
 140     }
 141     /* Double check whether all atoms in all molecules that are marked are part
 142      * of the cluster. Simultaneously compute the center of geometry.
 143      */
 144     min_dist2   = 10*sqr(trace(box));
 145     imol_center = -1;
 146     ncluster    = 0;
 147     for (i = 0; i < nmol; i++)
 148     {
 149         for (j = molind[i]; j < molind[i+1]; j++)
 150         {
 151             if (bMol[i] && !bTmp[j])
 152             {
 153                 gmx_fatal(FARGS, "Molecule %d marked for clustering but not atom %d in it - check your index!", i+1, j+1);
 154             }
 155             else if (!bMol[i] && bTmp[j])
 156             {
 157                 gmx_fatal(FARGS, "Atom %d marked for clustering but not molecule %d - this is an internal error...", j+1, i+1);
 158             }
 159             else if (bMol[i])
 160             {
 161                 /* Make molecule whole, move 2nd and higher atom to same periodicity as 1st atom in molecule */
 162                 if (j > molind[i])
 163                 {
 164                     pbc_dx(&pbc, x[j], x[j-1], dx);
 165                     rvec_add(x[j-1], dx, x[j]);
 166                 }
 167                 /* Compute center of geometry of molecule - m_com[i] was zeroed when we did snew() on it! */
 168                 rvec_inc(m_com[i], x[j]);
 169             }
 170         }
 171         if (bMol[i])
 172         {
 173             /* Normalize center of geometry */
 174             fac = 1.0/(molind[i+1]-molind[i]);
 175             for (m = 0; (m < DIM); m++)
 176             {
 177                 m_com[i][m] *= fac;
 178             }
 179             /* Determine which molecule is closest to the center of the box */
 180             pbc_dx(&pbc, box_center, m_com[i], dx);
 181             tmp_r2 = iprod(dx, dx);
 182
 183             if (tmp_r2 < min_dist2)
 184             {
 185                 min_dist2   = tmp_r2;
 186                 imol_center = i;
 187             }
 188             cluster[ncluster++] = i;
 189         }
 190     }
 191     sfree(bTmp);
 192
 193     if (ncluster <= 0)
 194     {
 195         fprintf(stderr, "No molecules selected in the cluster\n");
 196         return;
 197     }
 198     else if (imol_center == -1)
 199     {
 200         fprintf(stderr, "No central molecules could be found\n");
 201         return;
 202     }
 203
 204     nadded            = 0;
 205     added[nadded++]   = imol_center;
 206     bMol[imol_center] = FALSE;
 207
 208     while (nadded < ncluster)
 209     {
 210         /* Find min distance between cluster molecules and those remaining to be added */
 211         min_dist2   = 10*sqr(trace(box));
 212         imin        = -1;
 213         jmin        = -1;
 214         /* Loop over added mols */
 215         for (i = 0; i < nadded; i++)
 216         {
 217             ai = added[i];
 218             /* Loop over all mols */
 219             for (j = 0; j < ncluster; j++)
 220             {
 221                 aj = cluster[j];
 222                 /* check those remaining to be added */
 223                 if (bMol[aj])
 224                 {
 225                     pbc_dx(&pbc, m_com[aj], m_com[ai], dx);
 226                     tmp_r2 = iprod(dx, dx);
 227                     if (tmp_r2 < min_dist2)
 228                     {
 229                         min_dist2   = tmp_r2;
 230                         imin        = ai;
 231                         jmin        = aj;
 232                     }
 233                 }
 234             }
 235         }
 236
 237         /* Add the best molecule */
 238         added[nadded++]   = jmin;
 239         bMol[jmin]        = FALSE;
 240         /* Calculate the shift from the ai molecule */
 241         pbc_dx(&pbc, m_com[jmin], m_com[imin], dx);
 242         rvec_add(m_com[imin], dx, xtest);
 243         rvec_sub(xtest, m_com[jmin], m_shift[jmin]);
 244         rvec_inc(m_com[jmin], m_shift[jmin]);
 245
 246         for (j = molind[jmin]; j < molind[jmin+1]; j++)
 247         {
 248             rvec_inc(x[j], m_shift[jmin]);
 249         }
 250         fprintf(stdout, "\rClustering iteration %d of %d...", nadded, ncluster);
 251         fflush(stdout);
 252     }
 253
 254     sfree(added);
 255     sfree(cluster);
 256     sfree(bMol);
 257     sfree(m_com);
 258     sfree(m_shift);
 259
 260     fprintf(stdout, "\n");
 261 }
 262
 263 static void put_molecule_com_in_box(int unitcell_enum, int ecenter,
 264                                     t_block *mols,
 265                                     int natoms, t_atom atom[],
 266                                     int ePBC, matrix box, rvec x[])
 267 {
 268     atom_id i, j;
 269     int     d;
 270     rvec    com, new_com, shift, dx, box_center;
 271     real    m;
 272     double  mtot;
 273     t_pbc   pbc;
 274
 275     calc_box_center(ecenter, box, box_center);
 276     set_pbc(&pbc, ePBC, box);
 277     if (mols->nr <= 0)
 278     {
 279         gmx_fatal(FARGS, "There are no molecule descriptions. I need a .tpr file for this pbc option.");
 280     }
 281     for (i = 0; (i < mols->nr); i++)
 282     {
 283         /* calc COM */
 284         clear_rvec(com);
 285         mtot = 0;
 286         for (j = mols->index[i]; (j < mols->index[i+1] && j < natoms); j++)
 287         {
 288             m = atom[j].m;
 289             for (d = 0; d < DIM; d++)
 290             {
 291                 com[d] += m*x[j][d];
 292             }
 293             mtot += m;
 294         }
 295         /* calculate final COM */
 296         svmul(1.0/mtot, com, com);
 297
 298         /* check if COM is outside box */
 299         copy_rvec(com, new_com);
 300         switch (unitcell_enum)
 301         {
 302             case euRect:
 303                 put_atoms_in_box(ePBC, box, 1, &new_com);
 304                 break;
 305             case euTric:
 306                 put_atoms_in_triclinic_unitcell(ecenter, box, 1, &new_com);
 307                 break;
 308             case euCompact:
 309                 put_atoms_in_compact_unitcell(ePBC, ecenter, box, 1, &new_com);
 310                 break;
 311         }
 312         rvec_sub(new_com, com, shift);
 313         if (norm2(shift) > 0)
 314         {
 315             if (debug)
 316             {
 317                 fprintf(debug, "\nShifting position of molecule %d "
 318                         "by %8.3f  %8.3f  %8.3f\n", i+1,
 319                         shift[XX], shift[YY], shift[ZZ]);
 320             }
 321             for (j = mols->index[i]; (j < mols->index[i+1] && j < natoms); j++)
 322             {
 323                 rvec_inc(x[j], shift);
 324             }
 325         }
 326     }
 327 }
 328
 329 static void put_residue_com_in_box(int unitcell_enum, int ecenter,
 330                                    int natoms, t_atom atom[],
 331                                    int ePBC, matrix box, rvec x[])
 332 {
 333     atom_id i, j, res_start, res_end, res_nat;
 334     int     d, presnr;
 335     real    m;
 336     double  mtot;
 337     rvec    box_center, com, new_com, shift;
 338
 339     calc_box_center(ecenter, box, box_center);
 340
 341     presnr    = NOTSET;
 342     res_start = 0;
 343     clear_rvec(com);
 344     mtot = 0;
 345     for (i = 0; i < natoms+1; i++)
 346     {
 347         if (i == natoms || (presnr != atom[i].resind && presnr != NOTSET))
 348         {
 349             /* calculate final COM */
 350             res_end = i;
 351             res_nat = res_end - res_start;
 352             svmul(1.0/mtot, com, com);
 353
 354             /* check if COM is outside box */
 355             copy_rvec(com, new_com);
 356             switch (unitcell_enum)
 357             {
 358                 case euRect:
 359                     put_atoms_in_box(ePBC, box, 1, &new_com);
 360                     break;
 361                 case euTric:
 362                     put_atoms_in_triclinic_unitcell(ecenter, box, 1, &new_com);
 363                     break;
 364                 case euCompact:
 365                     put_atoms_in_compact_unitcell(ePBC, ecenter, box, 1, &new_com);
 366                     break;
 367             }
 368             rvec_sub(new_com, com, shift);
 369             if (norm2(shift))
 370             {
 371                 if (debug)
 372                 {
 373                     fprintf(debug, "\nShifting position of residue %d (atoms %d-%d) "
 374                             "by %g,%g,%g\n", atom[res_start].resind+1,
 375                             res_start+1, res_end+1, shift[XX], shift[YY], shift[ZZ]);
 376                 }
 377                 for (j = res_start; j < res_end; j++)
 378                 {
 379                     rvec_inc(x[j], shift);
 380                 }
 381             }
 382             clear_rvec(com);
 383             mtot = 0;
 384
 385             /* remember start of new residue */
 386             res_start = i;
 387         }
 388         if (i < natoms)
 389         {
 390             /* calc COM */
 391             m = atom[i].m;
 392             for (d = 0; d < DIM; d++)
 393             {
 394                 com[d] += m*x[i][d];
 395             }
 396             mtot += m;
 397
 398             presnr = atom[i].resind;
 399         }
 400     }
 401 }
 402
 403 static void center_x(int ecenter, rvec x[], matrix box, int n, int nc, atom_id ci[])
 404 {
 405     int  i, m, ai;
 406     rvec cmin, cmax, box_center, dx;
 407
 408     if (nc > 0)
 409     {
 410         copy_rvec(x[ci[0]], cmin);
 411         copy_rvec(x[ci[0]], cmax);
 412         for (i = 0; i < nc; i++)
 413         {
 414             ai = ci[i];
 415             for (m = 0; m < DIM; m++)
 416             {
 417                 if (x[ai][m] < cmin[m])
 418                 {
 419                     cmin[m] = x[ai][m];
 420                 }
 421                 else if (x[ai][m] > cmax[m])
 422                 {
 423                     cmax[m] = x[ai][m];
 424                 }
 425             }
 426         }
 427         calc_box_center(ecenter, box, box_center);
 428         for (m = 0; m < DIM; m++)
 429         {
 430             dx[m] = box_center[m]-(cmin[m]+cmax[m])*0.5;
 431         }
 432
 433         for (i = 0; i < n; i++)
 434         {
 435             rvec_inc(x[i], dx);
 436         }
 437     }
 438 }
 439
 440 static void mk_filenm(char *base, const char *ext, int ndigit, int file_nr,
 441                       char out_file[])
 442 {
 443     char nbuf[128];
 444     int  nd = 0, fnr;
 445
 446     strcpy(out_file, base);
 447     fnr = file_nr;
 448     do
 449     {
 450         fnr /= 10;
 451         nd++;
 452     }
 453     while (fnr > 0);
 454
 455     if (nd < ndigit)
 456     {
 457         strncat(out_file, "00000000000", ndigit-nd);
 458     }
 459     sprintf(nbuf, "%d.", file_nr);
 460     strcat(out_file, nbuf);
 461     strcat(out_file, ext);
 462 }
 463
 464 void check_trn(const char *fn)
 465 {
 466     if (fn2ftp(fn) != efTRR)
 467     {
 468         gmx_fatal(FARGS, "%s is not a trajectory file, exiting\n", fn);
 469     }
 470 }
 471
 472 void do_trunc(const char *fn, real t0)
 473 {
 474     t_fileio        *in;
 475     FILE            *fp;
 476     gmx_bool         bStop, bOK;
 477     t_trnheader      sh;
 478     gmx_off_t        fpos;
 479     char             yesno[256];
 480     int              j;
 481     real             t = 0;
 482
 483     if (t0 == -1)
 484     {
 485         gmx_fatal(FARGS, "You forgot to set the truncation time");
 486     }
 487
 488     /* Check whether this is a .trr file */
 489     check_trn(fn);
 490
 491     in   = open_trn(fn, "r");
 492     fp   = gmx_fio_getfp(in);
 493     if (fp == NULL)
 494     {
 495         fprintf(stderr, "Sorry, can not trunc %s, truncation of this filetype is not supported\n", fn);
 496         close_trn(in);
 497     }
 498     else
 499     {
 500         j     = 0;
 501         fpos  = gmx_fio_ftell(in);
 502         bStop = FALSE;
 503         while (!bStop && fread_trnheader(in, &sh, &bOK))
 504         {
 505             fread_htrn(in, &sh, NULL, NULL, NULL, NULL);
 506             fpos = gmx_ftell(fp);
 507             t    = sh.t;
 508             if (t >= t0)
 509             {
 510                 gmx_fseek(fp, fpos, SEEK_SET);
 511                 bStop = TRUE;
 512             }
 513         }
 514         if (bStop)
 515         {
 516             fprintf(stderr, "Do you REALLY want to truncate this trajectory (%s) at:\n"
 517                     "frame %d, time %g, bytes %ld ??? (type YES if so)\n",
 518                     fn, j, t, (long int)fpos);
 519             if (1 != scanf("%s", yesno))
 520             {
 521                 gmx_fatal(FARGS, "Error reading user input");
 522             }
 523             if (strcmp(yesno, "YES") == 0)
 524             {
 525                 fprintf(stderr, "Once again, I'm gonna DO this...\n");
 526                 close_trn(in);
 527                 if (0 != gmx_truncate(fn, fpos))
 528                 {
 529                     gmx_fatal(FARGS, "Error truncating file %s", fn);
 530                 }
 531             }
 532             else
 533             {
 534                 fprintf(stderr, "Ok, I'll forget about it\n");
 535             }
 536         }
 537         else
 538         {
 539             fprintf(stderr, "Already at end of file (t=%g)...\n", t);
 540             close_trn(in);
 541         }
 542     }
 543 }
 544
 545 /*! \brief Read a full molecular topology if useful and available.
 546  *
 547  * If the input trajectory file is not in TNG format, and the output
 548  * file is in TNG format, then we want to try to read a full topology
 549  * (if available), so that we can write molecule information to the
 550  * output file. The full topology provides better molecule information
 551  * than is available from the normal t_topology data used by GROMACS
 552  * tools.
 553  *
 554  * Also, the t_topology is only read under (different) particular
 555  * conditions. If both apply, then a .tpr file might be read
 556  * twice. Trying to fix this redundancy while trjconv is still an
 557  * all-purpose tool does not seem worthwhile.
 558  *
 559  * Because of the way gmx_prepare_tng_writing is implemented, the case
 560  * where the input TNG file has no molecule information will never
 561  * lead to an output TNG file having molecule information. Since
 562  * molecule information will generally be present if the input TNG
 563  * file was written by a GROMACS tool, this seems like reasonable
 564  * behaviour. */
 565 static gmx_mtop_t *read_mtop_for_tng(const char *tps_file,
 566                                      const char *input_file,
 567                                      const char *output_file)
 568 {
 569     gmx_mtop_t *mtop = NULL;
 570
 571     if (fn2bTPX(tps_file) &&
 572         efTNG != fn2ftp(input_file) &&
 573         efTNG == fn2ftp(output_file))
 574     {
 575         int temp_natoms = -1;
 576         snew(mtop, 1);
 577         read_tpx(tps_file, NULL, NULL, &temp_natoms,
 578                  NULL, NULL, NULL, mtop);
 579     }
 580
 581     return mtop;
 582 }
 583
 584 int gmx_trjconv(int argc, char *argv[])
 585 {
 586     const char *desc[] = {
 587         "[THISMODULE] can convert trajectory files in many ways:",
 588         "",
 589         "* from one format to another",
 590         "* select a subset of atoms",
 591         "* change the periodicity representation",
 592         "* keep multimeric molecules together",
 593         "* center atoms in the box",
 594         "* fit atoms to reference structure",
 595         "* reduce the number of frames",
 596         "* change the timestamps of the frames ([TT]-t0[tt] and [TT]-timestep[tt])",
 597         "* cut the trajectory in small subtrajectories according",
 598         "  to information in an index file. This allows subsequent analysis of",
 599         "  the subtrajectories that could, for example, be the result of a",
 600         "  cluster analysis. Use option [TT]-sub[tt].",
 601         "  This assumes that the entries in the index file are frame numbers and",
 602         "  dumps each group in the index file to a separate trajectory file.",
 603         "* select frames within a certain range of a quantity given",
 604         "  in an [REF].xvg[ref] file.",
 605         "",
 606         "[gmx-trjcat] is better suited for concatenating multiple trajectory files.",
 607         "[PAR]",
 608
 609         "The following formats are supported for input and output:",
 610         "[REF].xtc[ref], [REF].trr[ref], [REF].gro[ref], [TT].g96[tt]",
 611         "and [REF].pdb[ref].",
 612         "The file formats are detected from the file extension.",
 613         "The precision of [REF].xtc[ref] and [REF].gro[ref] output is taken from the",
 614         "input file for [REF].xtc[ref], [REF].gro[ref] and [REF].pdb[ref],",
 615         "and from the [TT]-ndec[tt] option for other input formats. The precision",
 616         "is always taken from [TT]-ndec[tt], when this option is set.",
 617         "All other formats have fixed precision. [REF].trr[ref]",
 618         "output can be single or double precision, depending on the precision",
 619         "of the [THISMODULE] binary.",
 620         "Note that velocities are only supported in",
 621         "[REF].trr[ref], [REF].gro[ref] and [TT].g96[tt] files.[PAR]",
 622
 623         "Option [TT]-sep[tt] can be used to write every frame to a separate",
 624         "[TT].gro, .g96[tt] or [REF].pdb[ref] file. By default, all frames all written to one file.",
 625         "[REF].pdb[ref] files with all frames concatenated can be viewed with",
 626         "[TT]rasmol -nmrpdb[tt].[PAR]",
 627
 628         "It is possible to select part of your trajectory and write it out",
 629         "to a new trajectory file in order to save disk space, e.g. for leaving",
 630         "out the water from a trajectory of a protein in water.",
 631         "[BB]ALWAYS[bb] put the original trajectory on tape!",
 632         "We recommend to use the portable [REF].xtc[ref] format for your analysis",
 633         "to save disk space and to have portable files.[PAR]",
 634
 635         "There are two options for fitting the trajectory to a reference",
 636         "either for essential dynamics analysis, etc.",
 637         "The first option is just plain fitting to a reference structure",
 638         "in the structure file. The second option is a progressive fit",
 639         "in which the first timeframe is fitted to the reference structure ",
 640         "in the structure file to obtain and each subsequent timeframe is ",
 641         "fitted to the previously fitted structure. This way a continuous",
 642         "trajectory is generated, which might not be the case when using the",
 643         "regular fit method, e.g. when your protein undergoes large",
 644         "conformational transitions.[PAR]",
 645
 646         "Option [TT]-pbc[tt] sets the type of periodic boundary condition",
 647         "treatment:",
 648         "",
 649         " * [TT]mol[tt] puts the center of mass of molecules in the box,",
 650         "   and requires a run input file to be supplied with [TT]-s[tt].",
 651         " * [TT]res[tt] puts the center of mass of residues in the box.",
 652         " * [TT]atom[tt] puts all the atoms in the box.",
 653         " * [TT]nojump[tt] checks if atoms jump across the box and then puts",
 654         "   them back. This has the effect that all molecules",
 655         "   will remain whole (provided they were whole in the initial",
 656         "   conformation). [BB]Note[bb] that this ensures a continuous trajectory but",
 657         "   molecules may diffuse out of the box. The starting configuration",
 658         "   for this procedure is taken from the structure file, if one is",
 659         "   supplied, otherwise it is the first frame.",
 660         " * [TT]cluster[tt] clusters all the atoms in the selected index",
 661         "   such that they are all closest to the center of mass of the cluster,",
 662         "   which is iteratively updated. [BB]Note[bb] that this will only give meaningful",
 663         "   results if you in fact have a cluster. Luckily that can be checked",
 664         "   afterwards using a trajectory viewer. Note also that if your molecules",
 665         "   are broken this will not work either.",
 666         "",
 667         "   The separate option [TT]-clustercenter[tt] can be used to specify an",
 668         "   approximate center for the cluster. This is useful e.g. if you have",
 669         "   two big vesicles, and you want to maintain their relative positions.",
 670         " * [TT]whole[tt] only makes broken molecules whole.",
 671         "",
 672
 673         "Option [TT]-ur[tt] sets the unit cell representation for options",
 674         "[TT]mol[tt], [TT]res[tt] and [TT]atom[tt] of [TT]-pbc[tt].",
 675         "All three options give different results for triclinic boxes and",
 676         "identical results for rectangular boxes.",
 677         "[TT]rect[tt] is the ordinary brick shape.",
 678         "[TT]tric[tt] is the triclinic unit cell.",
 679         "[TT]compact[tt] puts all atoms at the closest distance from the center",
 680         "of the box. This can be useful for visualizing e.g. truncated octahedra",
 681         "or rhombic dodecahedra. The center for options [TT]tric[tt] and [TT]compact[tt]",
 682         "is [TT]tric[tt] (see below), unless the option [TT]-boxcenter[tt]",
 683         "is set differently.[PAR]",
 684
 685         "Option [TT]-center[tt] centers the system in the box. The user can",
 686         "select the group which is used to determine the geometrical center.",
 687         "Option [TT]-boxcenter[tt] sets the location of the center of the box",
 688         "for options [TT]-pbc[tt] and [TT]-center[tt]. The center options are:",
 689         "[TT]tric[tt]: half of the sum of the box vectors,",
 690         "[TT]rect[tt]: half of the box diagonal,",
 691         "[TT]zero[tt]: zero.",
 692         "Use option [TT]-pbc mol[tt] in addition to [TT]-center[tt] when you",
 693         "want all molecules in the box after the centering.[PAR]",
 694
 695         "Option [TT]-box[tt] sets the size of the new box. This option only works",
 696         "for leading dimensions and is thus generally only useful for rectangular boxes.",
 697         "If you want to modify only some of the dimensions, e.g. when reading from",
 698         "a trajectory, you can use -1 for those dimensions that should stay the same",
 699
 700         "It is not always possible to use combinations of [TT]-pbc[tt],",
 701         "[TT]-fit[tt], [TT]-ur[tt] and [TT]-center[tt] to do exactly what",
 702         "you want in one call to [THISMODULE]. Consider using multiple",
 703         "calls, and check out the GROMACS website for suggestions.[PAR]",
 704
 705         "With [TT]-dt[tt], it is possible to reduce the number of ",
 706         "frames in the output. This option relies on the accuracy of the times",
 707         "in your input trajectory, so if these are inaccurate use the",
 708         "[TT]-timestep[tt] option to modify the time (this can be done",
 709         "simultaneously). For making smooth movies, the program [gmx-filter]",
 710         "can reduce the number of frames while using low-pass frequency",
 711         "filtering, this reduces aliasing of high frequency motions.[PAR]",
 712
 713         "Using [TT]-trunc[tt] [THISMODULE] can truncate [REF].trr[ref] in place, i.e.",
 714         "without copying the file. This is useful when a run has crashed",
 715         "during disk I/O (i.e. full disk), or when two contiguous",
 716         "trajectories must be concatenated without having double frames.[PAR]",
 717
 718         "Option [TT]-dump[tt] can be used to extract a frame at or near",
 719         "one specific time from your trajectory.[PAR]",
 720
 721         "Option [TT]-drop[tt] reads an [REF].xvg[ref] file with times and values.",
 722         "When options [TT]-dropunder[tt] and/or [TT]-dropover[tt] are set,",
 723         "frames with a value below and above the value of the respective options",
 724         "will not be written."
 725     };
 726
 727     int         pbc_enum;
 728     enum
 729     {
 730         epSel,
 731         epNone,
 732         epComMol,
 733         epComRes,
 734         epComAtom,
 735         epNojump,
 736         epCluster,
 737         epWhole,
 738         epNR
 739     };
 740     const char *pbc_opt[epNR + 1] =
 741     {
 742         NULL, "none", "mol", "res", "atom", "nojump", "cluster", "whole",
 743         NULL
 744     };
 745
 746     int         unitcell_enum;
 747     const char *unitcell_opt[euNR+1] =
 748     { NULL, "rect", "tric", "compact", NULL };
 749
 750     enum
 751     {
 752         ecSel, ecTric, ecRect, ecZero, ecNR
 753     };
 754     const char *center_opt[ecNR+1] =
 755     { NULL, "tric", "rect", "zero", NULL };
 756     int         ecenter;
 757
 758     int         fit_enum;
 759     enum
 760     {
 761         efSel, efNone, efFit, efFitXY, efReset, efResetXY, efPFit, efNR
 762     };
 763     const char *fit[efNR + 1] =
 764     {
 765         NULL, "none", "rot+trans", "rotxy+transxy", "translation", "transxy",
 766         "progressive", NULL
 767     };
 768
 769     static gmx_bool  bSeparate     = FALSE, bVels = TRUE, bForce = FALSE, bCONECT = FALSE;
 770     static gmx_bool  bCenter       = FALSE;
 771     static int       skip_nr       = 1, ndec = 3, nzero = 0;
 772     static real      tzero         = 0, delta_t = 0, timestep = 0, ttrunc = -1, tdump = -1, split_t = 0;
 773     static rvec      newbox        = {0, 0, 0}, shift = {0, 0, 0}, trans = {0, 0, 0};
 774     static char     *exec_command  = NULL;
 775     static real      dropunder     = 0, dropover = 0;
 776     static gmx_bool  bRound        = FALSE;
 777
 778     t_pargs
 779         pa[] =
 780     {
 781         { "-skip", FALSE, etINT,
 782           { &skip_nr }, "Only write every nr-th frame" },
 783         { "-dt", FALSE, etTIME,
 784           { &delta_t },
 785           "Only write frame when t MOD dt = first time (%t)" },
 786         { "-round", FALSE, etBOOL,
 787           { &bRound }, "Round measurements to nearest picosecond"},
 788         { "-dump", FALSE, etTIME,
 789           { &tdump }, "Dump frame nearest specified time (%t)" },
 790         { "-t0", FALSE, etTIME,
 791           { &tzero },
 792           "Starting time (%t) (default: don't change)" },
 793         { "-timestep", FALSE, etTIME,
 794           { &timestep },
 795           "Change time step between input frames (%t)" },
 796         { "-pbc", FALSE, etENUM,
 797           { pbc_opt },
 798           "PBC treatment (see help text for full description)" },
 799         { "-ur", FALSE, etENUM,
 800           { unitcell_opt }, "Unit-cell representation" },
 801         { "-center", FALSE, etBOOL,
 802           { &bCenter }, "Center atoms in box" },
 803         { "-boxcenter", FALSE, etENUM,
 804           { center_opt }, "Center for -pbc and -center" },
 805         { "-box", FALSE, etRVEC,
 806           { newbox },
 807           "Size for new cubic box (default: read from input)" },
 808         { "-trans", FALSE, etRVEC,
 809           { trans },
 810           "All coordinates will be translated by trans. This "
 811           "can advantageously be combined with -pbc mol -ur "
 812           "compact." },
 813         { "-shift", FALSE, etRVEC,
 814           { shift },
 815           "All coordinates will be shifted by framenr*shift" },
 816         { "-fit", FALSE, etENUM,
 817           { fit },
 818           "Fit molecule to ref structure in the structure file" },
 819         { "-ndec", FALSE, etINT,
 820           { &ndec },
 821           "Precision for .xtc and .gro writing in number of "
 822           "decimal places" },
 823         { "-vel", FALSE, etBOOL,
 824           { &bVels }, "Read and write velocities if possible" },
 825         { "-force", FALSE, etBOOL,
 826           { &bForce }, "Read and write forces if possible" },
 827         { "-trunc", FALSE, etTIME,
 828           { &ttrunc },
 829           "Truncate input trajectory file after this time (%t)" },
 830         { "-exec", FALSE, etSTR,
 831           { &exec_command },
 832           "Execute command for every output frame with the "
 833           "frame number as argument" },
 834         { "-split", FALSE, etTIME,
 835           { &split_t },
 836           "Start writing new file when t MOD split = first "
 837           "time (%t)" },
 838         { "-sep", FALSE, etBOOL,
 839           { &bSeparate },
 840           "Write each frame to a separate .gro, .g96 or .pdb "
 841           "file" },
 842         { "-nzero", FALSE, etINT,
 843           { &nzero },
 844           "If the -sep flag is set, use these many digits "
 845           "for the file numbers and prepend zeros as needed" },
 846         { "-dropunder", FALSE, etREAL,
 847           { &dropunder }, "Drop all frames below this value" },
 848         { "-dropover", FALSE, etREAL,
 849           { &dropover }, "Drop all frames above this value" },
 850         { "-conect", FALSE, etBOOL,
 851           { &bCONECT },
 852           "Add conect records when writing [REF].pdb[ref] files. Useful "
 853           "for visualization of non-standard molecules, e.g. "
 854           "coarse grained ones" }
 855     };
 856 #define NPA asize(pa)
 857
 858     FILE            *out    = NULL;
 859     t_trxstatus     *trxout = NULL;
 860     t_trxstatus     *trxin;
 861     int              ftp, ftpin = 0, file_nr;
 862     t_trxframe       fr, frout;
 863     int              flags;
 864     rvec            *xmem = NULL, *vmem = NULL, *fmem = NULL;
 865     rvec            *xp   = NULL, x_shift, hbox, box_center, dx;
 866     real             xtcpr, lambda, *w_rls = NULL;
 867     int              m, i, d, frame, outframe, natoms, nout, ncent, nre, newstep = 0, model_nr;
 868 #define SKIP 10
 869     t_topology       top;
 870     gmx_mtop_t      *mtop  = NULL;
 871     gmx_conect       gc    = NULL;
 872     int              ePBC  = -1;
 873     t_atoms         *atoms = NULL, useatoms;
 874     matrix           top_box;
 875     atom_id         *index, *cindex;
 876     char            *grpnm;
 877     int             *frindex, nrfri;
 878     char            *frname;
 879     int              ifit, irms, my_clust = -1;
 880     atom_id         *ind_fit, *ind_rms;
 881     char            *gn_fit, *gn_rms;
 882     t_cluster_ndx   *clust           = NULL;
 883     t_trxstatus    **clust_status    = NULL;
 884     int             *clust_status_id = NULL;
 885     int              ntrxopen        = 0;
 886     int             *nfwritten       = NULL;
 887     int              ndrop           = 0, ncol, drop0 = 0, drop1 = 0, dropuse = 0;
 888     double         **dropval;
 889     real             tshift = 0, t0 = -1, dt = 0.001, prec;
 890     gmx_bool         bFit, bFitXY, bPFit, bReset;
 891     int              nfitdim;
 892     gmx_rmpbc_t      gpbc = NULL;
 893     gmx_bool         bRmPBC, bPBCWhole, bPBCcomRes, bPBCcomMol, bPBCcomAtom, bPBC, bNoJump, bCluster;
 894     gmx_bool         bCopy, bDoIt, bIndex, bTDump, bSetTime, bTPS = FALSE, bDTset = FALSE;
 895     gmx_bool         bExec, bTimeStep = FALSE, bDumpFrame = FALSE, bSetPrec, bNeedPrec;
 896     gmx_bool         bHaveFirstFrame, bHaveNextFrame, bSetBox, bSetUR, bSplit = FALSE;
 897     gmx_bool         bSubTraj = FALSE, bDropUnder = FALSE, bDropOver = FALSE, bTrans = FALSE;
 898     gmx_bool         bWriteFrame, bSplitHere;
 899     const char      *top_file, *in_file, *out_file = NULL;
 900     char             out_file2[256], *charpt;
 901     char            *outf_base = NULL;
 902     const char      *outf_ext  = NULL;
 903     char             top_title[256], title[256], command[256], filemode[5];
 904     int              xdr          = 0;
 905     gmx_bool         bWarnCompact = FALSE;
 906     const char      *warn;
 907     output_env_t     oenv;
 908
 909     t_filenm         fnm[] = {
 910         { efTRX, "-f",   NULL,      ffREAD  },
 911         { efTRO, "-o",   NULL,      ffWRITE },
 912         { efTPS, NULL,   NULL,      ffOPTRD },
 913         { efNDX, NULL,   NULL,      ffOPTRD },
 914         { efNDX, "-fr",  "frames",  ffOPTRD },
 915         { efNDX, "-sub", "cluster", ffOPTRD },
 916         { efXVG, "-drop", "drop",    ffOPTRD }
 917     };
 918 #define NFILE asize(fnm)
 919
 920     if (!parse_common_args(&argc, argv,
 921                            PCA_CAN_BEGIN | PCA_CAN_END | PCA_CAN_VIEW |
 922                            PCA_TIME_UNIT,
 923                            NFILE, fnm, NPA, pa, asize(desc), desc,
 924                            0, NULL, &oenv))
 925     {
 926         return 0;
 927     }
 928
 929     top_file = ftp2fn(efTPS, NFILE, fnm);
 930     init_top(&top);
 931
 932     /* Check command line */
 933     in_file = opt2fn("-f", NFILE, fnm);
 934
 935     if (ttrunc != -1)
 936     {
 937         do_trunc(in_file, ttrunc);
 938     }
 939     else
 940     {
 941         /* mark active cmdline options */
 942         bSetBox    = opt2parg_bSet("-box", NPA, pa);
 943         bSetTime   = opt2parg_bSet("-t0", NPA, pa);
 944         bSetPrec   = opt2parg_bSet("-ndec", NPA, pa);
 945         bSetUR     = opt2parg_bSet("-ur", NPA, pa);
 946         bExec      = opt2parg_bSet("-exec", NPA, pa);
 947         bTimeStep  = opt2parg_bSet("-timestep", NPA, pa);
 948         bTDump     = opt2parg_bSet("-dump", NPA, pa);
 949         bDropUnder = opt2parg_bSet("-dropunder", NPA, pa);
 950         bDropOver  = opt2parg_bSet("-dropover", NPA, pa);
 951         bTrans     = opt2parg_bSet("-trans", NPA, pa);
 952         bSplit     = (split_t != 0);
 953
 954         /* parse enum options */
 955         fit_enum      = nenum(fit);
 956         bFit          = (fit_enum == efFit || fit_enum == efFitXY);
 957         bFitXY        = fit_enum == efFitXY;
 958         bReset        = (fit_enum == efReset || fit_enum == efResetXY);
 959         bPFit         = fit_enum == efPFit;
 960         pbc_enum      = nenum(pbc_opt);
 961         bPBCWhole     = pbc_enum == epWhole;
 962         bPBCcomRes    = pbc_enum == epComRes;
 963         bPBCcomMol    = pbc_enum == epComMol;
 964         bPBCcomAtom   = pbc_enum == epComAtom;
 965         bNoJump       = pbc_enum == epNojump;
 966         bCluster      = pbc_enum == epCluster;
 967         bPBC          = pbc_enum != epNone;
 968         unitcell_enum = nenum(unitcell_opt);
 969         ecenter       = nenum(center_opt) - ecTric;
 970
 971         /* set and check option dependencies */
 972         if (bPFit)
 973         {
 974             bFit = TRUE;        /* for pfit, fit *must* be set */
 975         }
 976         if (bFit)
 977         {
 978             bReset = TRUE;       /* for fit, reset *must* be set */
 979         }
 980         nfitdim = 0;
 981         if (bFit || bReset)
 982         {
 983             nfitdim = (fit_enum == efFitXY || fit_enum == efResetXY) ? 2 : 3;
 984         }
 985         bRmPBC = bFit || bPBCWhole || bPBCcomRes || bPBCcomMol;
 986
 987         if (bSetUR)
 988         {
 989             if (!(bPBCcomRes || bPBCcomMol ||  bPBCcomAtom))
 990             {
 991                 fprintf(stderr,
 992                         "WARNING: Option for unitcell representation (-ur %s)\n"
 993                         "         only has effect in combination with -pbc %s, %s or %s.\n"
 994                         "         Ingoring unitcell representation.\n\n",
 995                         unitcell_opt[0], pbc_opt[2], pbc_opt[3], pbc_opt[4]);
 996                 bSetUR = FALSE;
 997             }
 998         }
 999         if (bFit && bPBC)
1000         {
1001             gmx_fatal(FARGS, "PBC condition treatment does not work together with rotational fit.\n"
1002                       "Please do the PBC condition treatment first and then run trjconv in a second step\n"
1003                       "for the rotational fit.\n"
1004                       "First doing the rotational fit and then doing the PBC treatment gives incorrect\n"
1005                       "results!");
1006         }
1007
1008         /* ndec is in nr of decimal places, prec is a multiplication factor: */
1009         prec = 1;
1010         for (i = 0; i < ndec; i++)
1011         {
1012             prec *= 10;
1013         }
1014
1015         bIndex = ftp2bSet(efNDX, NFILE, fnm);
1016
1017
1018         /* Determine output type */
1019         out_file = opt2fn("-o", NFILE, fnm);
1020         ftp      = fn2ftp(out_file);
1021         fprintf(stderr, "Will write %s: %s\n", ftp2ext(ftp), ftp2desc(ftp));
1022         bNeedPrec = (ftp == efXTC || ftp == efGRO);
1023         if (bVels)
1024         {
1025             /* check if velocities are possible in input and output files */
1026             ftpin = fn2ftp(in_file);
1027             bVels = (ftp == efTRR || ftp == efGRO ||
1028                      ftp == efG96 || ftp == efTNG)
1029                 && (ftpin == efTRR || ftpin == efGRO ||
1030                     ftpin == efG96 || ftpin == efTNG || ftpin == efCPT);
1031         }
1032         if (bSeparate || bSplit)
1033         {
1034             outf_ext = strrchr(out_file, '.');
1035             if (outf_ext == NULL)
1036             {
1037                 gmx_fatal(FARGS, "Output file name '%s' does not contain a '.'", out_file);
1038             }
1039             outf_base = gmx_strdup(out_file);
1040             outf_base[outf_ext - out_file] = '\0';
1041         }
1042
1043         bSubTraj = opt2bSet("-sub", NFILE, fnm);
1044         if (bSubTraj)
1045         {
1046             if ((ftp != efXTC) && (ftp != efTRR))
1047             {
1048                 /* It seems likely that other trajectory file types
1049                  * could work here. */
1050                 gmx_fatal(FARGS, "Can only use the sub option with output file types "
1051                           "xtc and trr");
1052             }
1053             clust = cluster_index(NULL, opt2fn("-sub", NFILE, fnm));
1054
1055             /* Check for number of files disabled, as FOPEN_MAX is not the correct
1056              * number to check for. In my linux box it is only 16.
1057              */
1058             if (0 && (clust->clust->nr > FOPEN_MAX-4))
1059             {
1060                 gmx_fatal(FARGS, "Can not open enough (%d) files to write all the"
1061                           " trajectories.\ntry splitting the index file in %d parts.\n"
1062                           "FOPEN_MAX = %d",
1063                           clust->clust->nr, 1+clust->clust->nr/FOPEN_MAX, FOPEN_MAX);
1064             }
1065             gmx_warning("The -sub option could require as many open output files as there are\n"
1066                         "index groups in the file (%d). If you get I/O errors opening new files,\n"
1067                         "try reducing the number of index groups in the file, and perhaps\n"
1068                         "using trjconv -sub several times on different chunks of your index file.\n",
1069                         clust->clust->nr);
1070
1071             snew(clust_status, clust->clust->nr);
1072             snew(clust_status_id, clust->clust->nr);
1073             snew(nfwritten, clust->clust->nr);
1074             for (i = 0; (i < clust->clust->nr); i++)
1075             {
1076                 clust_status[i]    = NULL;
1077                 clust_status_id[i] = -1;
1078             }
1079             bSeparate = bSplit = FALSE;
1080         }
1081         /* skipping */
1082         if (skip_nr <= 0)
1083         {
1084         }
1085
1086         mtop = read_mtop_for_tng(top_file, in_file, out_file);
1087
1088         /* Determine whether to read a topology */
1089         bTPS = (ftp2bSet(efTPS, NFILE, fnm) ||
1090                 bRmPBC || bReset || bPBCcomMol || bCluster ||
1091                 (ftp == efGRO) || (ftp == efPDB) || bCONECT);
1092
1093         /* Determine if when can read index groups */
1094         bIndex = (bIndex || bTPS);
1095
1096         if (bTPS)
1097         {
1098             read_tps_conf(top_file, top_title, &top, &ePBC, &xp, NULL, top_box,
1099                           bReset || bPBCcomRes);
1100             atoms = &top.atoms;
1101
1102             if (0 == top.mols.nr && (bCluster || bPBCcomMol))
1103             {
1104                 gmx_fatal(FARGS, "Option -pbc %s requires a .tpr file for the -s option", pbc_opt[pbc_enum]);
1105             }
1106
1107             /* top_title is only used for gro and pdb,
1108              * the header in such a file is top_title t= ...
1109              * to prevent a double t=, remove it from top_title
1110              */
1111             if ((charpt = strstr(top_title, " t= ")))
1112             {
1113                 charpt[0] = '\0';
1114             }
1115
1116             if (bCONECT)
1117             {
1118                 gc = gmx_conect_generate(&top);
1119             }
1120             if (bRmPBC)
1121             {
1122                 gpbc = gmx_rmpbc_init(&top.idef, ePBC, top.atoms.nr);
1123             }
1124         }
1125
1126         /* get frame number index */
1127         frindex = NULL;
1128         if (opt2bSet("-fr", NFILE, fnm))
1129         {
1130             printf("Select groups of frame number indices:\n");
1131             rd_index(opt2fn("-fr", NFILE, fnm), 1, &nrfri, (atom_id **)&frindex, &frname);
1132             if (debug)
1133             {
1134                 for (i = 0; i < nrfri; i++)
1135                 {
1136                     fprintf(debug, "frindex[%4d]=%4d\n", i, frindex[i]);
1137                 }
1138             }
1139         }
1140
1141         /* get index groups etc. */
1142         if (bReset)
1143         {
1144             printf("Select group for %s fit\n",
1145                    bFit ? "least squares" : "translational");
1146             get_index(atoms, ftp2fn_null(efNDX, NFILE, fnm),
1147                       1, &ifit, &ind_fit, &gn_fit);
1148
1149             if (bFit)
1150             {
1151                 if (ifit < 2)
1152                 {
1153                     gmx_fatal(FARGS, "Need at least 2 atoms to fit!\n");
1154                 }
1155                 else if (ifit == 3)
1156                 {
1157                     fprintf(stderr, "WARNING: fitting with only 2 atoms is not unique\n");
1158                 }
1159             }
1160         }
1161         else if (bCluster)
1162         {
1163             printf("Select group for clustering\n");
1164             get_index(atoms, ftp2fn_null(efNDX, NFILE, fnm),
1165                       1, &ifit, &ind_fit, &gn_fit);
1166         }
1167
1168         if (bIndex)
1169         {
1170             if (bCenter)
1171             {
1172                 printf("Select group for centering\n");
1173                 get_index(atoms, ftp2fn_null(efNDX, NFILE, fnm),
1174                           1, &ncent, &cindex, &grpnm);
1175             }
1176             printf("Select group for output\n");
1177             get_index(atoms, ftp2fn_null(efNDX, NFILE, fnm),
1178                       1, &nout, &index, &grpnm);
1179         }
1180         else
1181         {
1182             /* no index file, so read natoms from TRX */
1183             if (!read_first_frame(oenv, &trxin, in_file, &fr, TRX_DONT_SKIP))
1184             {
1185                 gmx_fatal(FARGS, "Could not read a frame from %s", in_file);
1186             }
1187             natoms = fr.natoms;
1188             close_trj(trxin);
1189             sfree(fr.x);
1190             snew(index, natoms);
1191             for (i = 0; i < natoms; i++)
1192             {
1193                 index[i] = i;
1194             }
1195             nout = natoms;
1196             if (bCenter)
1197             {
1198                 ncent  = nout;
1199                 cindex = index;
1200             }
1201         }
1202
1203         if (bReset)
1204         {
1205             snew(w_rls, atoms->nr);
1206             for (i = 0; (i < ifit); i++)
1207             {
1208                 w_rls[ind_fit[i]] = atoms->atom[ind_fit[i]].m;
1209             }
1210
1211             /* Restore reference structure and set to origin,
1212                store original location (to put structure back) */
1213             if (bRmPBC)
1214             {
1215                 gmx_rmpbc(gpbc, top.atoms.nr, top_box, xp);
1216             }
1217             copy_rvec(xp[index[0]], x_shift);
1218             reset_x_ndim(nfitdim, ifit, ind_fit, atoms->nr, NULL, xp, w_rls);
1219             rvec_dec(x_shift, xp[index[0]]);
1220         }
1221         else
1222         {
1223             clear_rvec(x_shift);
1224         }
1225
1226         if (bDropUnder || bDropOver)
1227         {
1228             /* Read the .xvg file with the drop values */
1229             fprintf(stderr, "\nReading drop file ...");
1230             ndrop = read_xvg(opt2fn("-drop", NFILE, fnm), &dropval, &ncol);
1231             fprintf(stderr, " %d time points\n", ndrop);
1232             if (ndrop == 0 || ncol < 2)
1233             {
1234                 gmx_fatal(FARGS, "Found no data points in %s",
1235                           opt2fn("-drop", NFILE, fnm));
1236             }
1237             drop0 = 0;
1238             drop1 = 0;
1239         }
1240
1241         /* Make atoms struct for output in GRO or PDB files */
1242         if ((ftp == efGRO) || ((ftp == efG96) && bTPS) || (ftp == efPDB))
1243         {
1244             /* get memory for stuff to go in .pdb file, and initialize
1245              * the pdbinfo structure part if the input has it.
1246              */
1247             init_t_atoms(&useatoms, atoms->nr, (atoms->pdbinfo != NULL));
1248             sfree(useatoms.resinfo);
1249             useatoms.resinfo = atoms->resinfo;
1250             for (i = 0; (i < nout); i++)
1251             {
1252                 useatoms.atomname[i] = atoms->atomname[index[i]];
1253                 useatoms.atom[i]     = atoms->atom[index[i]];
1254                 if (atoms->pdbinfo != NULL)
1255                 {
1256                     useatoms.pdbinfo[i]  = atoms->pdbinfo[index[i]];
1257                 }
1258                 useatoms.nres        = max(useatoms.nres, useatoms.atom[i].resind+1);
1259             }
1260             useatoms.nr = nout;
1261         }
1262         /* select what to read */
1263         if (ftp == efTRR)
1264         {
1265             flags = TRX_READ_X;
1266         }
1267         else
1268         {
1269             flags = TRX_NEED_X;
1270         }
1271         if (bVels)
1272         {
1273             flags = flags | TRX_READ_V;
1274         }
1275         if (bForce)
1276         {
1277             flags = flags | TRX_READ_F;
1278         }
1279
1280         /* open trx file for reading */
1281         bHaveFirstFrame = read_first_frame(oenv, &trxin, in_file, &fr, flags);
1282         if (fr.bPrec)
1283         {
1284             fprintf(stderr, "\nPrecision of %s is %g (nm)\n", in_file, 1/fr.prec);
1285         }
1286         if (bNeedPrec)
1287         {
1288             if (bSetPrec || !fr.bPrec)
1289             {
1290                 fprintf(stderr, "\nSetting output precision to %g (nm)\n", 1/prec);
1291             }
1292             else
1293             {
1294                 fprintf(stderr, "Using output precision of %g (nm)\n", 1/prec);
1295             }
1296         }
1297
1298         if (bHaveFirstFrame)
1299         {
1300             set_trxframe_ePBC(&fr, ePBC);
1301
1302             natoms = fr.natoms;
1303
1304             if (bSetTime)
1305             {
1306                 tshift = tzero-fr.time;
1307             }
1308             else
1309             {
1310                 tzero = fr.time;
1311             }
1312
1313             bCopy = FALSE;
1314             if (bIndex)
1315             {
1316                 /* check if index is meaningful */
1317                 for (i = 0; i < nout; i++)
1318                 {
1319                     if (index[i] >= natoms)
1320                     {
1321                         gmx_fatal(FARGS,
1322                                   "Index[%d] %d is larger than the number of atoms in the\n"
1323                                   "trajectory file (%d). There is a mismatch in the contents\n"
1324                                   "of your -f, -s and/or -n files.", i, index[i]+1, natoms);
1325                     }
1326                     bCopy = bCopy || (i != index[i]);
1327                 }
1328             }
1329
1330             /* open output for writing */
1331             strcpy(filemode, "w");
1332             switch (ftp)
1333             {
1334                 case efTNG:
1335                     trjtools_gmx_prepare_tng_writing(out_file,
1336                                                      filemode[0],
1337                                                      trxin,
1338                                                      &trxout,
1339                                                      NULL,
1340                                                      nout,
1341                                                      mtop,
1342                                                      index,
1343                                                      grpnm);
1344                     break;
1345                 case efXTC:
1346                 case efTRR:
1347                     out = NULL;
1348                     if (!bSplit && !bSubTraj)
1349                     {
1350                         trxout = open_trx(out_file, filemode);
1351                     }
1352                     break;
1353                 case efGRO:
1354                 case efG96:
1355                 case efPDB:
1356                     if (( !bSeparate && !bSplit ) && !bSubTraj)
1357                     {
1358                         out = gmx_ffopen(out_file, filemode);
1359                     }
1360                     break;
1361                 default:
1362                     gmx_incons("Illegal output file format");
1363             }
1364
1365             if (bCopy)
1366             {
1367                 snew(xmem, nout);
1368                 if (bVels)
1369                 {
1370                     snew(vmem, nout);
1371                 }
1372                 if (bForce)
1373                 {
1374                     snew(fmem, nout);
1375                 }
1376             }
1377
1378             /* Start the big loop over frames */
1379             file_nr  =  0;
1380             frame    =  0;
1381             outframe =  0;
1382             model_nr =  0;
1383             bDTset   = FALSE;
1384
1385             /* Main loop over frames */
1386             do
1387             {
1388                 if (!fr.bStep)
1389                 {
1390                     /* set the step */
1391                     fr.step = newstep;
1392                     newstep++;
1393                 }
1394                 if (bSubTraj)
1395                 {
1396                     /*if (frame >= clust->clust->nra)
1397                        gmx_fatal(FARGS,"There are more frames in the trajectory than in the cluster index file\n");*/
1398                     if (frame > clust->maxframe)
1399                     {
1400                         my_clust = -1;
1401                     }
1402                     else
1403                     {
1404                         my_clust = clust->inv_clust[frame];
1405                     }
1406                     if ((my_clust < 0) || (my_clust >= clust->clust->nr) ||
1407                         (my_clust == NO_ATID))
1408                     {
1409                         my_clust = -1;
1410                     }
1411                 }
1412
1413                 if (bSetBox)
1414                 {
1415                     /* generate new box */
1416                     if (fr.bBox == FALSE)
1417                     {
1418                         clear_mat(fr.box);
1419                     }
1420                     for (m = 0; m < DIM; m++)
1421                     {
1422                         if (newbox[m] >= 0)
1423                         {
1424                             fr.box[m][m] = newbox[m];
1425                         }
1426                         else
1427                         {
1428                             if (fr.bBox == FALSE)
1429                             {
1430                                 gmx_fatal(FARGS, "Cannot preserve a box that does not exist.\n");
1431                             }
1432                         }
1433                     }
1434                 }
1435
1436                 if (bTrans)
1437                 {
1438                     for (i = 0; i < natoms; i++)
1439                     {
1440                         rvec_inc(fr.x[i], trans);
1441                     }
1442                 }
1443
1444                 if (bTDump)
1445                 {
1446                     /* determine timestep */
1447                     if (t0 == -1)
1448                     {
1449                         t0 = fr.time;
1450                     }
1451                     else
1452                     {
1453                         if (!bDTset)
1454                         {
1455                             dt     = fr.time-t0;
1456                             bDTset = TRUE;
1457                         }
1458                     }
1459                     /* This is not very elegant, as one can not dump a frame after
1460                      * a timestep with is more than twice as small as the first one. */
1461                     bDumpFrame = (fr.time > tdump-0.5*dt) && (fr.time <= tdump+0.5*dt);
1462                 }
1463                 else
1464                 {
1465                     bDumpFrame = FALSE;
1466                 }
1467
1468                 /* determine if an atom jumped across the box and reset it if so */
1469                 if (bNoJump && (bTPS || frame != 0))
1470                 {
1471                     for (d = 0; d < DIM; d++)
1472                     {
1473                         hbox[d] = 0.5*fr.box[d][d];
1474                     }
1475                     for (i = 0; i < natoms; i++)
1476                     {
1477                         if (bReset)
1478                         {
1479                             rvec_dec(fr.x[i], x_shift);
1480                         }
1481                         for (m = DIM-1; m >= 0; m--)
1482                         {
1483                             if (hbox[m] > 0)
1484                             {
1485                                 while (fr.x[i][m]-xp[i][m] <= -hbox[m])
1486                                 {
1487                                     for (d = 0; d <= m; d++)
1488                                     {
1489                                         fr.x[i][d] += fr.box[m][d];
1490                                     }
1491                                 }
1492                                 while (fr.x[i][m]-xp[i][m] > hbox[m])
1493                                 {
1494                                     for (d = 0; d <= m; d++)
1495                                     {
1496                                         fr.x[i][d] -= fr.box[m][d];
1497                                     }
1498                                 }
1499                             }
1500                         }
1501                     }
1502                 }
1503                 else if (bCluster)
1504                 {
1505                     calc_pbc_cluster(ecenter, ifit, &top, ePBC, fr.x, ind_fit, fr.box);
1506                 }
1507
1508                 if (bPFit)
1509                 {
1510                     /* Now modify the coords according to the flags,
1511                        for normal fit, this is only done for output frames */
1512                     if (bRmPBC)
1513                     {
1514                         gmx_rmpbc_trxfr(gpbc, &fr);
1515                     }
1516
1517                     reset_x_ndim(nfitdim, ifit, ind_fit, natoms, NULL, fr.x, w_rls);
1518                     do_fit(natoms, w_rls, xp, fr.x);
1519                 }
1520
1521                 /* store this set of coordinates for future use */
1522                 if (bPFit || bNoJump)
1523                 {
1524                     if (xp == NULL)
1525                     {
1526                         snew(xp, natoms);
1527                     }
1528                     for (i = 0; (i < natoms); i++)
1529                     {
1530                         copy_rvec(fr.x[i], xp[i]);
1531                         rvec_inc(fr.x[i], x_shift);
1532                     }
1533                 }
1534
1535                 if (frindex)
1536                 {
1537                     /* see if we have a frame from the frame index group */
1538                     for (i = 0; i < nrfri && !bDumpFrame; i++)
1539                     {
1540                         bDumpFrame = frame == frindex[i];
1541                     }
1542                 }
1543                 if (debug && bDumpFrame)
1544                 {
1545                     fprintf(debug, "dumping %d\n", frame);
1546                 }
1547
1548                 bWriteFrame =
1549                     ( ( !bTDump && !frindex && frame % skip_nr == 0 ) || bDumpFrame );
1550
1551                 if (bWriteFrame && (bDropUnder || bDropOver))
1552                 {
1553                     while (dropval[0][drop1] < fr.time && drop1+1 < ndrop)
1554                     {
1555                         drop0 = drop1;
1556                         drop1++;
1557                     }
1558                     if (fabs(dropval[0][drop0] - fr.time)
1559                         < fabs(dropval[0][drop1] - fr.time))
1560                     {
1561                         dropuse = drop0;
1562                     }
1563                     else
1564                     {
1565                         dropuse = drop1;
1566                     }
1567                     if ((bDropUnder && dropval[1][dropuse] < dropunder) ||
1568                         (bDropOver && dropval[1][dropuse] > dropover))
1569                     {
1570                         bWriteFrame = FALSE;
1571                     }
1572                 }
1573
1574                 if (bWriteFrame)
1575                 {
1576                     /* We should avoid modifying the input frame,
1577                      * but since here we don't have the output frame yet,
1578                      * we introduce a temporary output frame time variable.
1579                      */
1580                     real frout_time;
1581
1582                     frout_time = fr.time;
1583
1584                     /* calc new time */
1585                     if (bTimeStep)
1586                     {
1587                         frout_time = tzero + frame*timestep;
1588                     }
1589                     else
1590                     if (bSetTime)
1591                     {
1592                         frout_time += tshift;
1593                     }
1594
1595                     if (bTDump)
1596                     {
1597                         fprintf(stderr, "\nDumping frame at t= %g %s\n",
1598                                 output_env_conv_time(oenv, frout_time), output_env_get_time_unit(oenv));
1599                     }
1600
1601                     /* check for writing at each delta_t */
1602                     bDoIt = (delta_t == 0);
1603                     if (!bDoIt)
1604                     {
1605                         if (!bRound)
1606                         {
1607                             bDoIt = bRmod(frout_time, tzero, delta_t);
1608                         }
1609                         else
1610                         {
1611                             /* round() is not C89 compatible, so we do this:  */
1612                             bDoIt = bRmod(floor(frout_time+0.5), floor(tzero+0.5),
1613                                           floor(delta_t+0.5));
1614                         }
1615                     }
1616
1617                     if (bDoIt || bTDump)
1618                     {
1619                         /* print sometimes */
1620                         if ( ((outframe % SKIP) == 0) || (outframe < SKIP) )
1621                         {
1622                             fprintf(stderr, " ->  frame %6d time %8.3f      \r",
1623                                     outframe, output_env_conv_time(oenv, frout_time));
1624                         }
1625
1626                         if (!bPFit)
1627                         {
1628                             /* Now modify the coords according to the flags,
1629                                for PFit we did this already! */
1630
1631                             if (bRmPBC)
1632                             {
1633                                 gmx_rmpbc_trxfr(gpbc, &fr);
1634                             }
1635
1636                             if (bReset)
1637                             {
1638                                 reset_x_ndim(nfitdim, ifit, ind_fit, natoms, NULL, fr.x, w_rls);
1639                                 if (bFit)
1640                                 {
1641                                     do_fit_ndim(nfitdim, natoms, w_rls, xp, fr.x);
1642                                 }
1643                                 if (!bCenter)
1644                                 {
1645                                     for (i = 0; i < natoms; i++)
1646                                     {
1647                                         rvec_inc(fr.x[i], x_shift);
1648                                     }
1649                                 }
1650                             }
1651
1652                             if (bCenter)
1653                             {
1654                                 center_x(ecenter, fr.x, fr.box, natoms, ncent, cindex);
1655                             }
1656                         }
1657
1658                         if (bPBCcomAtom)
1659                         {
1660                             switch (unitcell_enum)
1661                             {
1662                                 case euRect:
1663                                     put_atoms_in_box(ePBC, fr.box, natoms, fr.x);
1664                                     break;
1665                                 case euTric:
1666                                     put_atoms_in_triclinic_unitcell(ecenter, fr.box, natoms, fr.x);
1667                                     break;
1668                                 case euCompact:
1669                                     warn = put_atoms_in_compact_unitcell(ePBC, ecenter, fr.box,
1670                                                                          natoms, fr.x);
1671                                     if (warn && !bWarnCompact)
1672                                     {
1673                                         fprintf(stderr, "\n%s\n", warn);
1674                                         bWarnCompact = TRUE;
1675                                     }
1676                                     break;
1677                             }
1678                         }
1679                         if (bPBCcomRes)
1680                         {
1681                             put_residue_com_in_box(unitcell_enum, ecenter,
1682                                                    natoms, atoms->atom, ePBC, fr.box, fr.x);
1683                         }
1684                         if (bPBCcomMol)
1685                         {
1686                             put_molecule_com_in_box(unitcell_enum, ecenter,
1687                                                     &top.mols,
1688                                                     natoms, atoms->atom, ePBC, fr.box, fr.x);
1689                         }
1690                         /* Copy the input trxframe struct to the output trxframe struct */
1691                         frout        = fr;
1692                         frout.time   = frout_time;
1693                         frout.bV     = (frout.bV && bVels);
1694                         frout.bF     = (frout.bF && bForce);
1695                         frout.natoms = nout;
1696                         if (bNeedPrec && (bSetPrec || !fr.bPrec))
1697                         {
1698                             frout.bPrec = TRUE;
1699                             frout.prec  = prec;
1700                         }
1701                         if (bCopy)
1702                         {
1703                             frout.x = xmem;
1704                             if (frout.bV)
1705                             {
1706                                 frout.v = vmem;
1707                             }
1708                             if (frout.bF)
1709                             {
1710                                 frout.f = fmem;
1711                             }
1712                             for (i = 0; i < nout; i++)
1713                             {
1714                                 copy_rvec(fr.x[index[i]], frout.x[i]);
1715                                 if (frout.bV)
1716                                 {
1717                                     copy_rvec(fr.v[index[i]], frout.v[i]);
1718                                 }
1719                                 if (frout.bF)
1720                                 {
1721                                     copy_rvec(fr.f[index[i]], frout.f[i]);
1722                                 }
1723                             }
1724                         }
1725
1726                         if (opt2parg_bSet("-shift", NPA, pa))
1727                         {
1728                             for (i = 0; i < nout; i++)
1729                             {
1730                                 for (d = 0; d < DIM; d++)
1731                                 {
1732                                     frout.x[i][d] += outframe*shift[d];
1733                                 }
1734                             }
1735                         }
1736
1737                         if (!bRound)
1738                         {
1739                             bSplitHere = bSplit && bRmod(frout.time, tzero, split_t);
1740                         }
1741                         else
1742                         {
1743                             /* round() is not C89 compatible, so we do this: */
1744                             bSplitHere = bSplit && bRmod(floor(frout.time+0.5),
1745                                                          floor(tzero+0.5),
1746                                                          floor(split_t+0.5));
1747                         }
1748                         if (bSeparate || bSplitHere)
1749                         {
1750                             mk_filenm(outf_base, ftp2ext(ftp), nzero, file_nr, out_file2);
1751                         }
1752
1753                         switch (ftp)
1754                         {
1755                             case efTNG:
1756                                 write_tng_frame(trxout, &frout);
1757                                 // TODO when trjconv behaves better: work how to read and write lambda
1758                                 break;
1759                             case efTRR:
1760                             case efXTC:
1761                                 if (bSplitHere)
1762                                 {
1763                                     if (trxout)
1764                                     {
1765                                         close_trx(trxout);
1766                                     }
1767                                     trxout = open_trx(out_file2, filemode);
1768                                 }
1769                                 if (bSubTraj)
1770                                 {
1771                                     if (my_clust != -1)
1772                                     {
1773                                         char buf[STRLEN];
1774                                         if (clust_status_id[my_clust] == -1)
1775                                         {
1776                                             sprintf(buf, "%s.%s", clust->grpname[my_clust], ftp2ext(ftp));
1777                                             clust_status[my_clust]    = open_trx(buf, "w");
1778                                             clust_status_id[my_clust] = 1;
1779                                             ntrxopen++;
1780                                         }
1781                                         else if (clust_status_id[my_clust] == -2)
1782                                         {
1783                                             gmx_fatal(FARGS, "File %s.xtc should still be open (%d open .xtc files)\n" "in order to write frame %d. my_clust = %d",
1784                                                       clust->grpname[my_clust], ntrxopen, frame,
1785                                                       my_clust);
1786                                         }
1787                                         write_trxframe(clust_status[my_clust], &frout, gc);
1788                                         nfwritten[my_clust]++;
1789                                         if (nfwritten[my_clust] ==
1790                                             (clust->clust->index[my_clust+1]-
1791                                              clust->clust->index[my_clust]))
1792                                         {
1793                                             close_trx(clust_status[my_clust]);
1794                                             clust_status[my_clust]    = NULL;
1795                                             clust_status_id[my_clust] = -2;
1796                                             ntrxopen--;
1797                                             if (ntrxopen < 0)
1798                                             {
1799                                                 gmx_fatal(FARGS, "Less than zero open .xtc files!");
1800                                             }
1801                                         }
1802                                     }
1803                                 }
1804                                 else
1805                                 {
1806                                     write_trxframe(trxout, &frout, gc);
1807                                 }
1808                                 break;
1809                             case efGRO:
1810                             case efG96:
1811                             case efPDB:
1812                                 sprintf(title, "Generated by trjconv : %s t= %9.5f",
1813                                         top_title, frout.time);
1814                                 if (bSeparate || bSplitHere)
1815                                 {
1816                                     out = gmx_ffopen(out_file2, "w");
1817                                 }
1818                                 switch (ftp)
1819                                 {
1820                                     case efGRO:
1821                                         write_hconf_p(out, title, &useatoms, prec2ndec(frout.prec),
1822                                                       frout.x, frout.bV ? frout.v : NULL, frout.box);
1823                                         break;
1824                                     case efPDB:
1825                                         fprintf(out, "REMARK    GENERATED BY TRJCONV\n");
1826                                         sprintf(title, "%s t= %9.5f", top_title, frout.time);
1827                                         /* if reading from pdb, we want to keep the original
1828                                            model numbering else we write the output frame
1829                                            number plus one, because model 0 is not allowed in pdb */
1830                                         if (ftpin == efPDB && fr.bStep && fr.step > model_nr)
1831                                         {
1832                                             model_nr = fr.step;
1833                                         }
1834                                         else
1835                                         {
1836                                             model_nr++;
1837                                         }
1838                                         write_pdbfile(out, title, &useatoms, frout.x,
1839                                                       frout.ePBC, frout.box, ' ', model_nr, gc, TRUE);
1840                                         break;
1841                                     case efG96:
1842                                         frout.title = title;
1843                                         if (bSeparate || bTDump)
1844                                         {
1845                                             frout.bTitle = TRUE;
1846                                             if (bTPS)
1847                                             {
1848                                                 frout.bAtoms = TRUE;
1849                                             }
1850                                             frout.atoms  = &useatoms;
1851                                             frout.bStep  = FALSE;
1852                                             frout.bTime  = FALSE;
1853                                         }
1854                                         else
1855                                         {
1856                                             frout.bTitle = (outframe == 0);
1857                                             frout.bAtoms = FALSE;
1858                                             frout.bStep  = TRUE;
1859                                             frout.bTime  = TRUE;
1860                                         }
1861                                         write_g96_conf(out, &frout, -1, NULL);
1862                                 }
1863                                 if (bSeparate || bSplitHere)
1864                                 {
1865                                     gmx_ffclose(out);
1866                                     out = NULL;
1867                                 }
1868                                 break;
1869                             default:
1870                                 gmx_fatal(FARGS, "DHE, ftp=%d\n", ftp);
1871                         }
1872                         if (bSeparate || bSplitHere)
1873                         {
1874                             file_nr++;
1875                         }
1876
1877                         /* execute command */
1878                         if (bExec)
1879                         {
1880                             char c[255];
1881                             sprintf(c, "%s  %d", exec_command, file_nr-1);
1882                             /*fprintf(stderr,"Executing '%s'\n",c);*/
1883                             if (0 != system(c))
1884                             {
1885                                 gmx_fatal(FARGS, "Error executing command: %s", c);
1886                             }
1887                         }
1888                         outframe++;
1889                     }
1890                 }
1891                 frame++;
1892                 bHaveNextFrame = read_next_frame(oenv, trxin, &fr);
1893             }
1894             while (!(bTDump && bDumpFrame) && bHaveNextFrame);
1895         }
1896
1897         if (!bHaveFirstFrame || (bTDump && !bDumpFrame))
1898         {
1899             fprintf(stderr, "\nWARNING no output, "
1900                     "last frame read at t=%g\n", fr.time);
1901         }
1902         fprintf(stderr, "\n");
1903
1904         close_trj(trxin);
1905         sfree(outf_base);
1906
1907         if (bRmPBC)
1908         {
1909             gmx_rmpbc_done(gpbc);
1910         }
1911
1912         if (trxout)
1913         {
1914             close_trx(trxout);
1915         }
1916         else if (out != NULL)
1917         {
1918             gmx_ffclose(out);
1919         }
1920         if (bSubTraj)
1921         {
1922             for (i = 0; (i < clust->clust->nr); i++)
1923             {
1924                 if (clust_status_id[i] >= 0)
1925                 {
1926                     close_trx(clust_status[i]);
1927                 }
1928             }
1929         }
1930     }
1931
1932     sfree(mtop);
1933
1934     do_view(oenv, out_file, NULL);
1935
1936     return 0;
1937 }