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:[BR]",
 588         "* from one format to another[BR]",
 589         "* select a subset of atoms[BR]",
 590         "* change the periodicity representation[BR]",
 591         "* keep multimeric molecules together[BR]",
 592         "* center atoms in the box[BR]",
 593         "* fit atoms to reference structure[BR]",
 594         "* reduce the number of frames[BR]",
 595         "* change the timestamps of the frames ([TT]-t0[tt] and [TT]-timestep[tt])[BR]",
 596         "[TT]*[tt] cut the trajectory in small subtrajectories according",
 597         "to information in an index file. This allows subsequent analysis of",
 598         "the subtrajectories that could, for example, be the result of a",
 599         "cluster analysis. Use option [TT]-sub[tt].",
 600         "This assumes that the entries in the index file are frame numbers and",
 601         "dumps each group in the index file to a separate trajectory file.[BR]",
 602         "[TT]*[tt] select frames within a certain range of a quantity given",
 603         "in an [REF].xvg[ref] file.[PAR]",
 604
 605         "[gmx-trjcat] is better suited for concatenating multiple trajectory files.",
 606         "[PAR]",
 607
 608         "The following formats are supported for input and output:",
 609         "[REF].xtc[ref], [REF].trr[ref], [REF].gro[ref], [TT].g96[tt]",
 610         "and [REF].pdb[ref].",
 611         "The file formats are detected from the file extension.",
 612         "The precision of [REF].xtc[ref] and [REF].gro[ref] output is taken from the",
 613         "input file for [REF].xtc[ref], [REF].gro[ref] and [REF].pdb[ref],",
 614         "and from the [TT]-ndec[tt] option for other input formats. The precision",
 615         "is always taken from [TT]-ndec[tt], when this option is set.",
 616         "All other formats have fixed precision. [REF].trr[ref]",
 617         "output can be single or double precision, depending on the precision",
 618         "of the [THISMODULE] binary.",
 619         "Note that velocities are only supported in",
 620         "[REF].trr[ref], [REF].gro[ref] and [TT].g96[tt] files.[PAR]",
 621
 622         "Option [TT]-sep[tt] can be used to write every frame to a separate",
 623         "[TT].gro, .g96[tt] or [REF].pdb[ref] file. By default, all frames all written to one file.",
 624         "[REF].pdb[ref] files with all frames concatenated can be viewed with",
 625         "[TT]rasmol -nmrpdb[tt].[PAR]",
 626
 627         "It is possible to select part of your trajectory and write it out",
 628         "to a new trajectory file in order to save disk space, e.g. for leaving",
 629         "out the water from a trajectory of a protein in water.",
 630         "[BB]ALWAYS[bb] put the original trajectory on tape!",
 631         "We recommend to use the portable [REF].xtc[ref] format for your analysis",
 632         "to save disk space and to have portable files.[PAR]",
 633
 634         "There are two options for fitting the trajectory to a reference",
 635         "either for essential dynamics analysis, etc.",
 636         "The first option is just plain fitting to a reference structure",
 637         "in the structure file. The second option is a progressive fit",
 638         "in which the first timeframe is fitted to the reference structure ",
 639         "in the structure file to obtain and each subsequent timeframe is ",
 640         "fitted to the previously fitted structure. This way a continuous",
 641         "trajectory is generated, which might not be the case when using the",
 642         "regular fit method, e.g. when your protein undergoes large",
 643         "conformational transitions.[PAR]",
 644
 645         "Option [TT]-pbc[tt] sets the type of periodic boundary condition",
 646         "treatment:[BR]",
 647         "[TT]* mol[tt] puts the center of mass of molecules in the box,",
 648         "and requires a run input file to be supplied with [TT]-s[tt].[BR]",
 649         "[TT]* res[tt] puts the center of mass of residues in the box.[BR]",
 650         "[TT]* atom[tt] puts all the atoms in the box.[BR]",
 651         "[TT]* nojump[tt] checks if atoms jump across the box and then puts",
 652         "them back. This has the effect that all molecules",
 653         "will remain whole (provided they were whole in the initial",
 654         "conformation). [BB]Note[bb] that this ensures a continuous trajectory but",
 655         "molecules may diffuse out of the box. The starting configuration",
 656         "for this procedure is taken from the structure file, if one is",
 657         "supplied, otherwise it is the first frame.[BR]",
 658         "[TT]* cluster[tt] clusters all the atoms in the selected index",
 659         "such that they are all closest to the center of mass of the cluster,",
 660         "which is iteratively updated. [BB]Note[bb] that this will only give meaningful",
 661         "results if you in fact have a cluster. Luckily that can be checked",
 662         "afterwards using a trajectory viewer. Note also that if your molecules",
 663         "are broken this will not work either.[BR]",
 664         "The separate option [TT]-clustercenter[tt] can be used to specify an",
 665         "approximate center for the cluster. This is useful e.g. if you have",
 666         "two big vesicles, and you want to maintain their relative positions.[BR]",
 667         "[TT]* whole[tt] only makes broken molecules whole.[PAR]",
 668
 669         "Option [TT]-ur[tt] sets the unit cell representation for options",
 670         "[TT]mol[tt], [TT]res[tt] and [TT]atom[tt] of [TT]-pbc[tt].",
 671         "All three options give different results for triclinic boxes and",
 672         "identical results for rectangular boxes.",
 673         "[TT]rect[tt] is the ordinary brick shape.",
 674         "[TT]tric[tt] is the triclinic unit cell.",
 675         "[TT]compact[tt] puts all atoms at the closest distance from the center",
 676         "of the box. This can be useful for visualizing e.g. truncated octahedra",
 677         "or rhombic dodecahedra. The center for options [TT]tric[tt] and [TT]compact[tt]",
 678         "is [TT]tric[tt] (see below), unless the option [TT]-boxcenter[tt]",
 679         "is set differently.[PAR]",
 680
 681         "Option [TT]-center[tt] centers the system in the box. The user can",
 682         "select the group which is used to determine the geometrical center.",
 683         "Option [TT]-boxcenter[tt] sets the location of the center of the box",
 684         "for options [TT]-pbc[tt] and [TT]-center[tt]. The center options are:",
 685         "[TT]tric[tt]: half of the sum of the box vectors,",
 686         "[TT]rect[tt]: half of the box diagonal,",
 687         "[TT]zero[tt]: zero.",
 688         "Use option [TT]-pbc mol[tt] in addition to [TT]-center[tt] when you",
 689         "want all molecules in the box after the centering.[PAR]",
 690
 691         "Option [TT]-box[tt] sets the size of the new box. If you want to"
 692         "modify only some of the dimensions, e.g. when reading from a trajectory,"
 693         "you can use -1 for those dimensions that should stay the same"
 694
 695         "It is not always possible to use combinations of [TT]-pbc[tt],",
 696         "[TT]-fit[tt], [TT]-ur[tt] and [TT]-center[tt] to do exactly what",
 697         "you want in one call to [THISMODULE]. Consider using multiple",
 698         "calls, and check out the GROMACS website for suggestions.[PAR]",
 699
 700         "With [TT]-dt[tt], it is possible to reduce the number of ",
 701         "frames in the output. This option relies on the accuracy of the times",
 702         "in your input trajectory, so if these are inaccurate use the",
 703         "[TT]-timestep[tt] option to modify the time (this can be done",
 704         "simultaneously). For making smooth movies, the program [gmx-filter]",
 705         "can reduce the number of frames while using low-pass frequency",
 706         "filtering, this reduces aliasing of high frequency motions.[PAR]",
 707
 708         "Using [TT]-trunc[tt] [THISMODULE] can truncate [REF].trr[ref] in place, i.e.",
 709         "without copying the file. This is useful when a run has crashed",
 710         "during disk I/O (i.e. full disk), or when two contiguous",
 711         "trajectories must be concatenated without having double frames.[PAR]",
 712
 713         "Option [TT]-dump[tt] can be used to extract a frame at or near",
 714         "one specific time from your trajectory.[PAR]",
 715
 716         "Option [TT]-drop[tt] reads an [REF].xvg[ref] file with times and values.",
 717         "When options [TT]-dropunder[tt] and/or [TT]-dropover[tt] are set,",
 718         "frames with a value below and above the value of the respective options",
 719         "will not be written."
 720     };
 721
 722     int         pbc_enum;
 723     enum
 724     {
 725         epSel,
 726         epNone,
 727         epComMol,
 728         epComRes,
 729         epComAtom,
 730         epNojump,
 731         epCluster,
 732         epWhole,
 733         epNR
 734     };
 735     const char *pbc_opt[epNR + 1] =
 736     {
 737         NULL, "none", "mol", "res", "atom", "nojump", "cluster", "whole",
 738         NULL
 739     };
 740
 741     int         unitcell_enum;
 742     const char *unitcell_opt[euNR+1] =
 743     { NULL, "rect", "tric", "compact", NULL };
 744
 745     enum
 746     {
 747         ecSel, ecTric, ecRect, ecZero, ecNR
 748     };
 749     const char *center_opt[ecNR+1] =
 750     { NULL, "tric", "rect", "zero", NULL };
 751     int         ecenter;
 752
 753     int         fit_enum;
 754     enum
 755     {
 756         efSel, efNone, efFit, efFitXY, efReset, efResetXY, efPFit, efNR
 757     };
 758     const char *fit[efNR + 1] =
 759     {
 760         NULL, "none", "rot+trans", "rotxy+transxy", "translation", "transxy",
 761         "progressive", NULL
 762     };
 763
 764     static gmx_bool  bSeparate     = FALSE, bVels = TRUE, bForce = FALSE, bCONECT = FALSE;
 765     static gmx_bool  bCenter       = FALSE;
 766     static int       skip_nr       = 1, ndec = 3, nzero = 0;
 767     static real      tzero         = 0, delta_t = 0, timestep = 0, ttrunc = -1, tdump = -1, split_t = 0;
 768     static rvec      newbox        = {0, 0, 0}, shift = {0, 0, 0}, trans = {0, 0, 0};
 769     static char     *exec_command  = NULL;
 770     static real      dropunder     = 0, dropover = 0;
 771     static gmx_bool  bRound        = FALSE;
 772
 773     t_pargs
 774         pa[] =
 775     {
 776         { "-skip", FALSE, etINT,
 777           { &skip_nr }, "Only write every nr-th frame" },
 778         { "-dt", FALSE, etTIME,
 779           { &delta_t },
 780           "Only write frame when t MOD dt = first time (%t)" },
 781         { "-round", FALSE, etBOOL,
 782           { &bRound }, "Round measurements to nearest picosecond"},
 783         { "-dump", FALSE, etTIME,
 784           { &tdump }, "Dump frame nearest specified time (%t)" },
 785         { "-t0", FALSE, etTIME,
 786           { &tzero },
 787           "Starting time (%t) (default: don't change)" },
 788         { "-timestep", FALSE, etTIME,
 789           { &timestep },
 790           "Change time step between input frames (%t)" },
 791         { "-pbc", FALSE, etENUM,
 792           { pbc_opt },
 793           "PBC treatment (see help text for full description)" },
 794         { "-ur", FALSE, etENUM,
 795           { unitcell_opt }, "Unit-cell representation" },
 796         { "-center", FALSE, etBOOL,
 797           { &bCenter }, "Center atoms in box" },
 798         { "-boxcenter", FALSE, etENUM,
 799           { center_opt }, "Center for -pbc and -center" },
 800         { "-box", FALSE, etRVEC,
 801           { newbox },
 802           "Size for new cubic box (default: read from input)" },
 803         { "-trans", FALSE, etRVEC,
 804           { trans },
 805           "All coordinates will be translated by trans. This "
 806           "can advantageously be combined with -pbc mol -ur "
 807           "compact." },
 808         { "-shift", FALSE, etRVEC,
 809           { shift },
 810           "All coordinates will be shifted by framenr*shift" },
 811         { "-fit", FALSE, etENUM,
 812           { fit },
 813           "Fit molecule to ref structure in the structure file" },
 814         { "-ndec", FALSE, etINT,
 815           { &ndec },
 816           "Precision for .xtc and .gro writing in number of "
 817           "decimal places" },
 818         { "-vel", FALSE, etBOOL,
 819           { &bVels }, "Read and write velocities if possible" },
 820         { "-force", FALSE, etBOOL,
 821           { &bForce }, "Read and write forces if possible" },
 822         { "-trunc", FALSE, etTIME,
 823           { &ttrunc },
 824           "Truncate input trajectory file after this time (%t)" },
 825         { "-exec", FALSE, etSTR,
 826           { &exec_command },
 827           "Execute command for every output frame with the "
 828           "frame number as argument" },
 829         { "-split", FALSE, etTIME,
 830           { &split_t },
 831           "Start writing new file when t MOD split = first "
 832           "time (%t)" },
 833         { "-sep", FALSE, etBOOL,
 834           { &bSeparate },
 835           "Write each frame to a separate .gro, .g96 or .pdb "
 836           "file" },
 837         { "-nzero", FALSE, etINT,
 838           { &nzero },
 839           "If the -sep flag is set, use these many digits "
 840           "for the file numbers and prepend zeros as needed" },
 841         { "-dropunder", FALSE, etREAL,
 842           { &dropunder }, "Drop all frames below this value" },
 843         { "-dropover", FALSE, etREAL,
 844           { &dropover }, "Drop all frames above this value" },
 845         { "-conect", FALSE, etBOOL,
 846           { &bCONECT },
 847           "Add conect records when writing [REF].pdb[ref] files. Useful "
 848           "for visualization of non-standard molecules, e.g. "
 849           "coarse grained ones" }
 850     };
 851 #define NPA asize(pa)
 852
 853     FILE            *out    = NULL;
 854     t_trxstatus     *trxout = NULL;
 855     t_trxstatus     *trxin;
 856     int              ftp, ftpin = 0, file_nr;
 857     t_trxframe       fr, frout;
 858     int              flags;
 859     rvec            *xmem = NULL, *vmem = NULL, *fmem = NULL;
 860     rvec            *xp   = NULL, x_shift, hbox, box_center, dx;
 861     real             xtcpr, lambda, *w_rls = NULL;
 862     int              m, i, d, frame, outframe, natoms, nout, ncent, nre, newstep = 0, model_nr;
 863 #define SKIP 10
 864     t_topology       top;
 865     gmx_mtop_t      *mtop  = NULL;
 866     gmx_conect       gc    = NULL;
 867     int              ePBC  = -1;
 868     t_atoms         *atoms = NULL, useatoms;
 869     matrix           top_box;
 870     atom_id         *index, *cindex;
 871     char            *grpnm;
 872     int             *frindex, nrfri;
 873     char            *frname;
 874     int              ifit, irms, my_clust = -1;
 875     atom_id         *ind_fit, *ind_rms;
 876     char            *gn_fit, *gn_rms;
 877     t_cluster_ndx   *clust           = NULL;
 878     t_trxstatus    **clust_status    = NULL;
 879     int             *clust_status_id = NULL;
 880     int              ntrxopen        = 0;
 881     int             *nfwritten       = NULL;
 882     int              ndrop           = 0, ncol, drop0 = 0, drop1 = 0, dropuse = 0;
 883     double         **dropval;
 884     real             tshift = 0, t0 = -1, dt = 0.001, prec;
 885     gmx_bool         bFit, bFitXY, bPFit, bReset;
 886     int              nfitdim;
 887     gmx_rmpbc_t      gpbc = NULL;
 888     gmx_bool         bRmPBC, bPBCWhole, bPBCcomRes, bPBCcomMol, bPBCcomAtom, bPBC, bNoJump, bCluster;
 889     gmx_bool         bCopy, bDoIt, bIndex, bTDump, bSetTime, bTPS = FALSE, bDTset = FALSE;
 890     gmx_bool         bExec, bTimeStep = FALSE, bDumpFrame = FALSE, bSetPrec, bNeedPrec;
 891     gmx_bool         bHaveFirstFrame, bHaveNextFrame, bSetBox, bSetUR, bSplit = FALSE;
 892     gmx_bool         bSubTraj = FALSE, bDropUnder = FALSE, bDropOver = FALSE, bTrans = FALSE;
 893     gmx_bool         bWriteFrame, bSplitHere;
 894     const char      *top_file, *in_file, *out_file = NULL;
 895     char             out_file2[256], *charpt;
 896     char            *outf_base = NULL;
 897     const char      *outf_ext  = NULL;
 898     char             top_title[256], title[256], command[256], filemode[5];
 899     int              xdr          = 0;
 900     gmx_bool         bWarnCompact = FALSE;
 901     const char      *warn;
 902     output_env_t     oenv;
 903
 904     t_filenm         fnm[] = {
 905         { efTRX, "-f",   NULL,      ffREAD  },
 906         { efTRO, "-o",   NULL,      ffWRITE },
 907         { efTPS, NULL,   NULL,      ffOPTRD },
 908         { efNDX, NULL,   NULL,      ffOPTRD },
 909         { efNDX, "-fr",  "frames",  ffOPTRD },
 910         { efNDX, "-sub", "cluster", ffOPTRD },
 911         { efXVG, "-drop", "drop",    ffOPTRD }
 912     };
 913 #define NFILE asize(fnm)
 914
 915     if (!parse_common_args(&argc, argv,
 916                            PCA_CAN_BEGIN | PCA_CAN_END | PCA_CAN_VIEW |
 917                            PCA_TIME_UNIT,
 918                            NFILE, fnm, NPA, pa, asize(desc), desc,
 919                            0, NULL, &oenv))
 920     {
 921         return 0;
 922     }
 923
 924     top_file = ftp2fn(efTPS, NFILE, fnm);
 925     init_top(&top);
 926
 927     /* Check command line */
 928     in_file = opt2fn("-f", NFILE, fnm);
 929
 930     if (ttrunc != -1)
 931     {
 932         do_trunc(in_file, ttrunc);
 933     }
 934     else
 935     {
 936         /* mark active cmdline options */
 937         bSetBox    = opt2parg_bSet("-box", NPA, pa);
 938         bSetTime   = opt2parg_bSet("-t0", NPA, pa);
 939         bSetPrec   = opt2parg_bSet("-ndec", NPA, pa);
 940         bSetUR     = opt2parg_bSet("-ur", NPA, pa);
 941         bExec      = opt2parg_bSet("-exec", NPA, pa);
 942         bTimeStep  = opt2parg_bSet("-timestep", NPA, pa);
 943         bTDump     = opt2parg_bSet("-dump", NPA, pa);
 944         bDropUnder = opt2parg_bSet("-dropunder", NPA, pa);
 945         bDropOver  = opt2parg_bSet("-dropover", NPA, pa);
 946         bTrans     = opt2parg_bSet("-trans", NPA, pa);
 947         bSplit     = (split_t != 0);
 948
 949         /* parse enum options */
 950         fit_enum      = nenum(fit);
 951         bFit          = (fit_enum == efFit || fit_enum == efFitXY);
 952         bFitXY        = fit_enum == efFitXY;
 953         bReset        = (fit_enum == efReset || fit_enum == efResetXY);
 954         bPFit         = fit_enum == efPFit;
 955         pbc_enum      = nenum(pbc_opt);
 956         bPBCWhole     = pbc_enum == epWhole;
 957         bPBCcomRes    = pbc_enum == epComRes;
 958         bPBCcomMol    = pbc_enum == epComMol;
 959         bPBCcomAtom   = pbc_enum == epComAtom;
 960         bNoJump       = pbc_enum == epNojump;
 961         bCluster      = pbc_enum == epCluster;
 962         bPBC          = pbc_enum != epNone;
 963         unitcell_enum = nenum(unitcell_opt);
 964         ecenter       = nenum(center_opt) - ecTric;
 965
 966         /* set and check option dependencies */
 967         if (bPFit)
 968         {
 969             bFit = TRUE;        /* for pfit, fit *must* be set */
 970         }
 971         if (bFit)
 972         {
 973             bReset = TRUE;       /* for fit, reset *must* be set */
 974         }
 975         nfitdim = 0;
 976         if (bFit || bReset)
 977         {
 978             nfitdim = (fit_enum == efFitXY || fit_enum == efResetXY) ? 2 : 3;
 979         }
 980         bRmPBC = bFit || bPBCWhole || bPBCcomRes || bPBCcomMol;
 981
 982         if (bSetUR)
 983         {
 984             if (!(bPBCcomRes || bPBCcomMol ||  bPBCcomAtom))
 985             {
 986                 fprintf(stderr,
 987                         "WARNING: Option for unitcell representation (-ur %s)\n"
 988                         "         only has effect in combination with -pbc %s, %s or %s.\n"
 989                         "         Ingoring unitcell representation.\n\n",
 990                         unitcell_opt[0], pbc_opt[2], pbc_opt[3], pbc_opt[4]);
 991                 bSetUR = FALSE;
 992             }
 993         }
 994         if (bFit && bPBC)
 995         {
 996             gmx_fatal(FARGS, "PBC condition treatment does not work together with rotational fit.\n"
 997                       "Please do the PBC condition treatment first and then run trjconv in a second step\n"
 998                       "for the rotational fit.\n"
 999                       "First doing the rotational fit and then doing the PBC treatment gives incorrect\n"
1000                       "results!");
1001         }
1002
1003         /* ndec is in nr of decimal places, prec is a multiplication factor: */
1004         prec = 1;
1005         for (i = 0; i < ndec; i++)
1006         {
1007             prec *= 10;
1008         }
1009
1010         bIndex = ftp2bSet(efNDX, NFILE, fnm);
1011
1012
1013         /* Determine output type */
1014         out_file = opt2fn("-o", NFILE, fnm);
1015         ftp      = fn2ftp(out_file);
1016         fprintf(stderr, "Will write %s: %s\n", ftp2ext(ftp), ftp2desc(ftp));
1017         bNeedPrec = (ftp == efXTC || ftp == efGRO);
1018         if (bVels)
1019         {
1020             /* check if velocities are possible in input and output files */
1021             ftpin = fn2ftp(in_file);
1022             bVels = (ftp == efTRR || ftp == efGRO ||
1023                      ftp == efG96 || ftp == efTNG)
1024                 && (ftpin == efTRR || ftpin == efGRO ||
1025                     ftpin == efG96 || ftpin == efTNG || ftpin == efCPT);
1026         }
1027         if (bSeparate || bSplit)
1028         {
1029             outf_ext = strrchr(out_file, '.');
1030             if (outf_ext == NULL)
1031             {
1032                 gmx_fatal(FARGS, "Output file name '%s' does not contain a '.'", out_file);
1033             }
1034             outf_base = gmx_strdup(out_file);
1035             outf_base[outf_ext - out_file] = '\0';
1036         }
1037
1038         bSubTraj = opt2bSet("-sub", NFILE, fnm);
1039         if (bSubTraj)
1040         {
1041             if ((ftp != efXTC) && (ftp != efTRR))
1042             {
1043                 /* It seems likely that other trajectory file types
1044                  * could work here. */
1045                 gmx_fatal(FARGS, "Can only use the sub option with output file types "
1046                           "xtc and trr");
1047             }
1048             clust = cluster_index(NULL, opt2fn("-sub", NFILE, fnm));
1049
1050             /* Check for number of files disabled, as FOPEN_MAX is not the correct
1051              * number to check for. In my linux box it is only 16.
1052              */
1053             if (0 && (clust->clust->nr > FOPEN_MAX-4))
1054             {
1055                 gmx_fatal(FARGS, "Can not open enough (%d) files to write all the"
1056                           " trajectories.\ntry splitting the index file in %d parts.\n"
1057                           "FOPEN_MAX = %d",
1058                           clust->clust->nr, 1+clust->clust->nr/FOPEN_MAX, FOPEN_MAX);
1059             }
1060             gmx_warning("The -sub option could require as many open output files as there are\n"
1061                         "index groups in the file (%d). If you get I/O errors opening new files,\n"
1062                         "try reducing the number of index groups in the file, and perhaps\n"
1063                         "using trjconv -sub several times on different chunks of your index file.\n",
1064                         clust->clust->nr);
1065
1066             snew(clust_status, clust->clust->nr);
1067             snew(clust_status_id, clust->clust->nr);
1068             snew(nfwritten, clust->clust->nr);
1069             for (i = 0; (i < clust->clust->nr); i++)
1070             {
1071                 clust_status[i]    = NULL;
1072                 clust_status_id[i] = -1;
1073             }
1074             bSeparate = bSplit = FALSE;
1075         }
1076         /* skipping */
1077         if (skip_nr <= 0)
1078         {
1079         }
1080
1081         mtop = read_mtop_for_tng(top_file, in_file, out_file);
1082
1083         /* Determine whether to read a topology */
1084         bTPS = (ftp2bSet(efTPS, NFILE, fnm) ||
1085                 bRmPBC || bReset || bPBCcomMol || bCluster ||
1086                 (ftp == efGRO) || (ftp == efPDB) || bCONECT);
1087
1088         /* Determine if when can read index groups */
1089         bIndex = (bIndex || bTPS);
1090
1091         if (bTPS)
1092         {
1093             read_tps_conf(top_file, top_title, &top, &ePBC, &xp, NULL, top_box,
1094                           bReset || bPBCcomRes);
1095             atoms = &top.atoms;
1096
1097             if (0 == top.mols.nr && (bCluster || bPBCcomMol))
1098             {
1099                 gmx_fatal(FARGS, "Option -pbc %s requires a .tpr file for the -s option", pbc_opt[pbc_enum]);
1100             }
1101
1102             /* top_title is only used for gro and pdb,
1103              * the header in such a file is top_title t= ...
1104              * to prevent a double t=, remove it from top_title
1105              */
1106             if ((charpt = strstr(top_title, " t= ")))
1107             {
1108                 charpt[0] = '\0';
1109             }
1110
1111             if (bCONECT)
1112             {
1113                 gc = gmx_conect_generate(&top);
1114             }
1115             if (bRmPBC)
1116             {
1117                 gpbc = gmx_rmpbc_init(&top.idef, ePBC, top.atoms.nr);
1118             }
1119         }
1120
1121         /* get frame number index */
1122         frindex = NULL;
1123         if (opt2bSet("-fr", NFILE, fnm))
1124         {
1125             printf("Select groups of frame number indices:\n");
1126             rd_index(opt2fn("-fr", NFILE, fnm), 1, &nrfri, (atom_id **)&frindex, &frname);
1127             if (debug)
1128             {
1129                 for (i = 0; i < nrfri; i++)
1130                 {
1131                     fprintf(debug, "frindex[%4d]=%4d\n", i, frindex[i]);
1132                 }
1133             }
1134         }
1135
1136         /* get index groups etc. */
1137         if (bReset)
1138         {
1139             printf("Select group for %s fit\n",
1140                    bFit ? "least squares" : "translational");
1141             get_index(atoms, ftp2fn_null(efNDX, NFILE, fnm),
1142                       1, &ifit, &ind_fit, &gn_fit);
1143
1144             if (bFit)
1145             {
1146                 if (ifit < 2)
1147                 {
1148                     gmx_fatal(FARGS, "Need at least 2 atoms to fit!\n");
1149                 }
1150                 else if (ifit == 3)
1151                 {
1152                     fprintf(stderr, "WARNING: fitting with only 2 atoms is not unique\n");
1153                 }
1154             }
1155         }
1156         else if (bCluster)
1157         {
1158             printf("Select group for clustering\n");
1159             get_index(atoms, ftp2fn_null(efNDX, NFILE, fnm),
1160                       1, &ifit, &ind_fit, &gn_fit);
1161         }
1162
1163         if (bIndex)
1164         {
1165             if (bCenter)
1166             {
1167                 printf("Select group for centering\n");
1168                 get_index(atoms, ftp2fn_null(efNDX, NFILE, fnm),
1169                           1, &ncent, &cindex, &grpnm);
1170             }
1171             printf("Select group for output\n");
1172             get_index(atoms, ftp2fn_null(efNDX, NFILE, fnm),
1173                       1, &nout, &index, &grpnm);
1174         }
1175         else
1176         {
1177             /* no index file, so read natoms from TRX */
1178             if (!read_first_frame(oenv, &trxin, in_file, &fr, TRX_DONT_SKIP))
1179             {
1180                 gmx_fatal(FARGS, "Could not read a frame from %s", in_file);
1181             }
1182             natoms = fr.natoms;
1183             close_trj(trxin);
1184             sfree(fr.x);
1185             snew(index, natoms);
1186             for (i = 0; i < natoms; i++)
1187             {
1188                 index[i] = i;
1189             }
1190             nout = natoms;
1191             if (bCenter)
1192             {
1193                 ncent  = nout;
1194                 cindex = index;
1195             }
1196         }
1197
1198         if (bReset)
1199         {
1200             snew(w_rls, atoms->nr);
1201             for (i = 0; (i < ifit); i++)
1202             {
1203                 w_rls[ind_fit[i]] = atoms->atom[ind_fit[i]].m;
1204             }
1205
1206             /* Restore reference structure and set to origin,
1207                store original location (to put structure back) */
1208             if (bRmPBC)
1209             {
1210                 gmx_rmpbc(gpbc, top.atoms.nr, top_box, xp);
1211             }
1212             copy_rvec(xp[index[0]], x_shift);
1213             reset_x_ndim(nfitdim, ifit, ind_fit, atoms->nr, NULL, xp, w_rls);
1214             rvec_dec(x_shift, xp[index[0]]);
1215         }
1216         else
1217         {
1218             clear_rvec(x_shift);
1219         }
1220
1221         if (bDropUnder || bDropOver)
1222         {
1223             /* Read the .xvg file with the drop values */
1224             fprintf(stderr, "\nReading drop file ...");
1225             ndrop = read_xvg(opt2fn("-drop", NFILE, fnm), &dropval, &ncol);
1226             fprintf(stderr, " %d time points\n", ndrop);
1227             if (ndrop == 0 || ncol < 2)
1228             {
1229                 gmx_fatal(FARGS, "Found no data points in %s",
1230                           opt2fn("-drop", NFILE, fnm));
1231             }
1232             drop0 = 0;
1233             drop1 = 0;
1234         }
1235
1236         /* Make atoms struct for output in GRO or PDB files */
1237         if ((ftp == efGRO) || ((ftp == efG96) && bTPS) || (ftp == efPDB))
1238         {
1239             /* get memory for stuff to go in .pdb file, and initialize
1240              * the pdbinfo structure part if the input has it.
1241              */
1242             init_t_atoms(&useatoms, atoms->nr, (atoms->pdbinfo != NULL));
1243             sfree(useatoms.resinfo);
1244             useatoms.resinfo = atoms->resinfo;
1245             for (i = 0; (i < nout); i++)
1246             {
1247                 useatoms.atomname[i] = atoms->atomname[index[i]];
1248                 useatoms.atom[i]     = atoms->atom[index[i]];
1249                 if (atoms->pdbinfo != NULL)
1250                 {
1251                     useatoms.pdbinfo[i]  = atoms->pdbinfo[index[i]];
1252                 }
1253                 useatoms.nres        = max(useatoms.nres, useatoms.atom[i].resind+1);
1254             }
1255             useatoms.nr = nout;
1256         }
1257         /* select what to read */
1258         if (ftp == efTRR)
1259         {
1260             flags = TRX_READ_X;
1261         }
1262         else
1263         {
1264             flags = TRX_NEED_X;
1265         }
1266         if (bVels)
1267         {
1268             flags = flags | TRX_READ_V;
1269         }
1270         if (bForce)
1271         {
1272             flags = flags | TRX_READ_F;
1273         }
1274
1275         /* open trx file for reading */
1276         bHaveFirstFrame = read_first_frame(oenv, &trxin, in_file, &fr, flags);
1277         if (fr.bPrec)
1278         {
1279             fprintf(stderr, "\nPrecision of %s is %g (nm)\n", in_file, 1/fr.prec);
1280         }
1281         if (bNeedPrec)
1282         {
1283             if (bSetPrec || !fr.bPrec)
1284             {
1285                 fprintf(stderr, "\nSetting output precision to %g (nm)\n", 1/prec);
1286             }
1287             else
1288             {
1289                 fprintf(stderr, "Using output precision of %g (nm)\n", 1/prec);
1290             }
1291         }
1292
1293         if (bHaveFirstFrame)
1294         {
1295             set_trxframe_ePBC(&fr, ePBC);
1296
1297             natoms = fr.natoms;
1298
1299             if (bSetTime)
1300             {
1301                 tshift = tzero-fr.time;
1302             }
1303             else
1304             {
1305                 tzero = fr.time;
1306             }
1307
1308             bCopy = FALSE;
1309             if (bIndex)
1310             {
1311                 /* check if index is meaningful */
1312                 for (i = 0; i < nout; i++)
1313                 {
1314                     if (index[i] >= natoms)
1315                     {
1316                         gmx_fatal(FARGS,
1317                                   "Index[%d] %d is larger than the number of atoms in the\n"
1318                                   "trajectory file (%d). There is a mismatch in the contents\n"
1319                                   "of your -f, -s and/or -n files.", i, index[i]+1, natoms);
1320                     }
1321                     bCopy = bCopy || (i != index[i]);
1322                 }
1323             }
1324
1325             /* open output for writing */
1326             strcpy(filemode, "w");
1327             switch (ftp)
1328             {
1329                 case efTNG:
1330                     trjtools_gmx_prepare_tng_writing(out_file,
1331                                                      filemode[0],
1332                                                      trxin,
1333                                                      &trxout,
1334                                                      NULL,
1335                                                      nout,
1336                                                      mtop,
1337                                                      index,
1338                                                      grpnm);
1339                     break;
1340                 case efXTC:
1341                 case efTRR:
1342                     out = NULL;
1343                     if (!bSplit && !bSubTraj)
1344                     {
1345                         trxout = open_trx(out_file, filemode);
1346                     }
1347                     break;
1348                 case efGRO:
1349                 case efG96:
1350                 case efPDB:
1351                     if (( !bSeparate && !bSplit ) && !bSubTraj)
1352                     {
1353                         out = gmx_ffopen(out_file, filemode);
1354                     }
1355                     break;
1356                 default:
1357                     gmx_incons("Illegal output file format");
1358             }
1359
1360             if (bCopy)
1361             {
1362                 snew(xmem, nout);
1363                 if (bVels)
1364                 {
1365                     snew(vmem, nout);
1366                 }
1367                 if (bForce)
1368                 {
1369                     snew(fmem, nout);
1370                 }
1371             }
1372
1373             /* Start the big loop over frames */
1374             file_nr  =  0;
1375             frame    =  0;
1376             outframe =  0;
1377             model_nr =  0;
1378             bDTset   = FALSE;
1379
1380             /* Main loop over frames */
1381             do
1382             {
1383                 if (!fr.bStep)
1384                 {
1385                     /* set the step */
1386                     fr.step = newstep;
1387                     newstep++;
1388                 }
1389                 if (bSubTraj)
1390                 {
1391                     /*if (frame >= clust->clust->nra)
1392                        gmx_fatal(FARGS,"There are more frames in the trajectory than in the cluster index file\n");*/
1393                     if (frame > clust->maxframe)
1394                     {
1395                         my_clust = -1;
1396                     }
1397                     else
1398                     {
1399                         my_clust = clust->inv_clust[frame];
1400                     }
1401                     if ((my_clust < 0) || (my_clust >= clust->clust->nr) ||
1402                         (my_clust == NO_ATID))
1403                     {
1404                         my_clust = -1;
1405                     }
1406                 }
1407
1408                 if (bSetBox)
1409                 {
1410                     /* generate new box */
1411                     clear_mat(fr.box);
1412                     for (m = 0; m < DIM; m++)
1413                     {
1414                         if (newbox[m] >= 0)
1415                         {
1416                             fr.box[m][m] = newbox[m];
1417                         }
1418                     }
1419                 }
1420
1421                 if (bTrans)
1422                 {
1423                     for (i = 0; i < natoms; i++)
1424                     {
1425                         rvec_inc(fr.x[i], trans);
1426                     }
1427                 }
1428
1429                 if (bTDump)
1430                 {
1431                     /* determine timestep */
1432                     if (t0 == -1)
1433                     {
1434                         t0 = fr.time;
1435                     }
1436                     else
1437                     {
1438                         if (!bDTset)
1439                         {
1440                             dt     = fr.time-t0;
1441                             bDTset = TRUE;
1442                         }
1443                     }
1444                     /* This is not very elegant, as one can not dump a frame after
1445                      * a timestep with is more than twice as small as the first one. */
1446                     bDumpFrame = (fr.time > tdump-0.5*dt) && (fr.time <= tdump+0.5*dt);
1447                 }
1448                 else
1449                 {
1450                     bDumpFrame = FALSE;
1451                 }
1452
1453                 /* determine if an atom jumped across the box and reset it if so */
1454                 if (bNoJump && (bTPS || frame != 0))
1455                 {
1456                     for (d = 0; d < DIM; d++)
1457                     {
1458                         hbox[d] = 0.5*fr.box[d][d];
1459                     }
1460                     for (i = 0; i < natoms; i++)
1461                     {
1462                         if (bReset)
1463                         {
1464                             rvec_dec(fr.x[i], x_shift);
1465                         }
1466                         for (m = DIM-1; m >= 0; m--)
1467                         {
1468                             if (hbox[m] > 0)
1469                             {
1470                                 while (fr.x[i][m]-xp[i][m] <= -hbox[m])
1471                                 {
1472                                     for (d = 0; d <= m; d++)
1473                                     {
1474                                         fr.x[i][d] += fr.box[m][d];
1475                                     }
1476                                 }
1477                                 while (fr.x[i][m]-xp[i][m] > hbox[m])
1478                                 {
1479                                     for (d = 0; d <= m; d++)
1480                                     {
1481                                         fr.x[i][d] -= fr.box[m][d];
1482                                     }
1483                                 }
1484                             }
1485                         }
1486                     }
1487                 }
1488                 else if (bCluster)
1489                 {
1490                     calc_pbc_cluster(ecenter, ifit, &top, ePBC, fr.x, ind_fit, fr.box);
1491                 }
1492
1493                 if (bPFit)
1494                 {
1495                     /* Now modify the coords according to the flags,
1496                        for normal fit, this is only done for output frames */
1497                     if (bRmPBC)
1498                     {
1499                         gmx_rmpbc_trxfr(gpbc, &fr);
1500                     }
1501
1502                     reset_x_ndim(nfitdim, ifit, ind_fit, natoms, NULL, fr.x, w_rls);
1503                     do_fit(natoms, w_rls, xp, fr.x);
1504                 }
1505
1506                 /* store this set of coordinates for future use */
1507                 if (bPFit || bNoJump)
1508                 {
1509                     if (xp == NULL)
1510                     {
1511                         snew(xp, natoms);
1512                     }
1513                     for (i = 0; (i < natoms); i++)
1514                     {
1515                         copy_rvec(fr.x[i], xp[i]);
1516                         rvec_inc(fr.x[i], x_shift);
1517                     }
1518                 }
1519
1520                 if (frindex)
1521                 {
1522                     /* see if we have a frame from the frame index group */
1523                     for (i = 0; i < nrfri && !bDumpFrame; i++)
1524                     {
1525                         bDumpFrame = frame == frindex[i];
1526                     }
1527                 }
1528                 if (debug && bDumpFrame)
1529                 {
1530                     fprintf(debug, "dumping %d\n", frame);
1531                 }
1532
1533                 bWriteFrame =
1534                     ( ( !bTDump && !frindex && frame % skip_nr == 0 ) || bDumpFrame );
1535
1536                 if (bWriteFrame && (bDropUnder || bDropOver))
1537                 {
1538                     while (dropval[0][drop1] < fr.time && drop1+1 < ndrop)
1539                     {
1540                         drop0 = drop1;
1541                         drop1++;
1542                     }
1543                     if (fabs(dropval[0][drop0] - fr.time)
1544                         < fabs(dropval[0][drop1] - fr.time))
1545                     {
1546                         dropuse = drop0;
1547                     }
1548                     else
1549                     {
1550                         dropuse = drop1;
1551                     }
1552                     if ((bDropUnder && dropval[1][dropuse] < dropunder) ||
1553                         (bDropOver && dropval[1][dropuse] > dropover))
1554                     {
1555                         bWriteFrame = FALSE;
1556                     }
1557                 }
1558
1559                 if (bWriteFrame)
1560                 {
1561                     /* We should avoid modifying the input frame,
1562                      * but since here we don't have the output frame yet,
1563                      * we introduce a temporary output frame time variable.
1564                      */
1565                     real frout_time;
1566
1567                     frout_time = fr.time;
1568
1569                     /* calc new time */
1570                     if (bTimeStep)
1571                     {
1572                         frout_time = tzero + frame*timestep;
1573                     }
1574                     else
1575                     if (bSetTime)
1576                     {
1577                         frout_time += tshift;
1578                     }
1579
1580                     if (bTDump)
1581                     {
1582                         fprintf(stderr, "\nDumping frame at t= %g %s\n",
1583                                 output_env_conv_time(oenv, frout_time), output_env_get_time_unit(oenv));
1584                     }
1585
1586                     /* check for writing at each delta_t */
1587                     bDoIt = (delta_t == 0);
1588                     if (!bDoIt)
1589                     {
1590                         if (!bRound)
1591                         {
1592                             bDoIt = bRmod(frout_time, tzero, delta_t);
1593                         }
1594                         else
1595                         {
1596                             /* round() is not C89 compatible, so we do this:  */
1597                             bDoIt = bRmod(floor(frout_time+0.5), floor(tzero+0.5),
1598                                           floor(delta_t+0.5));
1599                         }
1600                     }
1601
1602                     if (bDoIt || bTDump)
1603                     {
1604                         /* print sometimes */
1605                         if ( ((outframe % SKIP) == 0) || (outframe < SKIP) )
1606                         {
1607                             fprintf(stderr, " ->  frame %6d time %8.3f      \r",
1608                                     outframe, output_env_conv_time(oenv, frout_time));
1609                         }
1610
1611                         if (!bPFit)
1612                         {
1613                             /* Now modify the coords according to the flags,
1614                                for PFit we did this already! */
1615
1616                             if (bRmPBC)
1617                             {
1618                                 gmx_rmpbc_trxfr(gpbc, &fr);
1619                             }
1620
1621                             if (bReset)
1622                             {
1623                                 reset_x_ndim(nfitdim, ifit, ind_fit, natoms, NULL, fr.x, w_rls);
1624                                 if (bFit)
1625                                 {
1626                                     do_fit_ndim(nfitdim, natoms, w_rls, xp, fr.x);
1627                                 }
1628                                 if (!bCenter)
1629                                 {
1630                                     for (i = 0; i < natoms; i++)
1631                                     {
1632                                         rvec_inc(fr.x[i], x_shift);
1633                                     }
1634                                 }
1635                             }
1636
1637                             if (bCenter)
1638                             {
1639                                 center_x(ecenter, fr.x, fr.box, natoms, ncent, cindex);
1640                             }
1641                         }
1642
1643                         if (bPBCcomAtom)
1644                         {
1645                             switch (unitcell_enum)
1646                             {
1647                                 case euRect:
1648                                     put_atoms_in_box(ePBC, fr.box, natoms, fr.x);
1649                                     break;
1650                                 case euTric:
1651                                     put_atoms_in_triclinic_unitcell(ecenter, fr.box, natoms, fr.x);
1652                                     break;
1653                                 case euCompact:
1654                                     warn = put_atoms_in_compact_unitcell(ePBC, ecenter, fr.box,
1655                                                                          natoms, fr.x);
1656                                     if (warn && !bWarnCompact)
1657                                     {
1658                                         fprintf(stderr, "\n%s\n", warn);
1659                                         bWarnCompact = TRUE;
1660                                     }
1661                                     break;
1662                             }
1663                         }
1664                         if (bPBCcomRes)
1665                         {
1666                             put_residue_com_in_box(unitcell_enum, ecenter,
1667                                                    natoms, atoms->atom, ePBC, fr.box, fr.x);
1668                         }
1669                         if (bPBCcomMol)
1670                         {
1671                             put_molecule_com_in_box(unitcell_enum, ecenter,
1672                                                     &top.mols,
1673                                                     natoms, atoms->atom, ePBC, fr.box, fr.x);
1674                         }
1675                         /* Copy the input trxframe struct to the output trxframe struct */
1676                         frout        = fr;
1677                         frout.time   = frout_time;
1678                         frout.bV     = (frout.bV && bVels);
1679                         frout.bF     = (frout.bF && bForce);
1680                         frout.natoms = nout;
1681                         if (bNeedPrec && (bSetPrec || !fr.bPrec))
1682                         {
1683                             frout.bPrec = TRUE;
1684                             frout.prec  = prec;
1685                         }
1686                         if (bCopy)
1687                         {
1688                             frout.x = xmem;
1689                             if (frout.bV)
1690                             {
1691                                 frout.v = vmem;
1692                             }
1693                             if (frout.bF)
1694                             {
1695                                 frout.f = fmem;
1696                             }
1697                             for (i = 0; i < nout; i++)
1698                             {
1699                                 copy_rvec(fr.x[index[i]], frout.x[i]);
1700                                 if (frout.bV)
1701                                 {
1702                                     copy_rvec(fr.v[index[i]], frout.v[i]);
1703                                 }
1704                                 if (frout.bF)
1705                                 {
1706                                     copy_rvec(fr.f[index[i]], frout.f[i]);
1707                                 }
1708                             }
1709                         }
1710
1711                         if (opt2parg_bSet("-shift", NPA, pa))
1712                         {
1713                             for (i = 0; i < nout; i++)
1714                             {
1715                                 for (d = 0; d < DIM; d++)
1716                                 {
1717                                     frout.x[i][d] += outframe*shift[d];
1718                                 }
1719                             }
1720                         }
1721
1722                         if (!bRound)
1723                         {
1724                             bSplitHere = bSplit && bRmod(frout.time, tzero, split_t);
1725                         }
1726                         else
1727                         {
1728                             /* round() is not C89 compatible, so we do this: */
1729                             bSplitHere = bSplit && bRmod(floor(frout.time+0.5),
1730                                                          floor(tzero+0.5),
1731                                                          floor(split_t+0.5));
1732                         }
1733                         if (bSeparate || bSplitHere)
1734                         {
1735                             mk_filenm(outf_base, ftp2ext(ftp), nzero, file_nr, out_file2);
1736                         }
1737
1738                         switch (ftp)
1739                         {
1740                             case efTNG:
1741                                 write_tng_frame(trxout, &frout);
1742                                 // TODO when trjconv behaves better: work how to read and write lambda
1743                                 break;
1744                             case efTRR:
1745                             case efXTC:
1746                                 if (bSplitHere)
1747                                 {
1748                                     if (trxout)
1749                                     {
1750                                         close_trx(trxout);
1751                                     }
1752                                     trxout = open_trx(out_file2, filemode);
1753                                 }
1754                                 if (bSubTraj)
1755                                 {
1756                                     if (my_clust != -1)
1757                                     {
1758                                         char buf[STRLEN];
1759                                         if (clust_status_id[my_clust] == -1)
1760                                         {
1761                                             sprintf(buf, "%s.%s", clust->grpname[my_clust], ftp2ext(ftp));
1762                                             clust_status[my_clust]    = open_trx(buf, "w");
1763                                             clust_status_id[my_clust] = 1;
1764                                             ntrxopen++;
1765                                         }
1766                                         else if (clust_status_id[my_clust] == -2)
1767                                         {
1768                                             gmx_fatal(FARGS, "File %s.xtc should still be open (%d open .xtc files)\n" "in order to write frame %d. my_clust = %d",
1769                                                       clust->grpname[my_clust], ntrxopen, frame,
1770                                                       my_clust);
1771                                         }
1772                                         write_trxframe(clust_status[my_clust], &frout, gc);
1773                                         nfwritten[my_clust]++;
1774                                         if (nfwritten[my_clust] ==
1775                                             (clust->clust->index[my_clust+1]-
1776                                              clust->clust->index[my_clust]))
1777                                         {
1778                                             close_trx(clust_status[my_clust]);
1779                                             clust_status[my_clust]    = NULL;
1780                                             clust_status_id[my_clust] = -2;
1781                                             ntrxopen--;
1782                                             if (ntrxopen < 0)
1783                                             {
1784                                                 gmx_fatal(FARGS, "Less than zero open .xtc files!");
1785                                             }
1786                                         }
1787                                     }
1788                                 }
1789                                 else
1790                                 {
1791                                     write_trxframe(trxout, &frout, gc);
1792                                 }
1793                                 break;
1794                             case efGRO:
1795                             case efG96:
1796                             case efPDB:
1797                                 sprintf(title, "Generated by trjconv : %s t= %9.5f",
1798                                         top_title, frout.time);
1799                                 if (bSeparate || bSplitHere)
1800                                 {
1801                                     out = gmx_ffopen(out_file2, "w");
1802                                 }
1803                                 switch (ftp)
1804                                 {
1805                                     case efGRO:
1806                                         write_hconf_p(out, title, &useatoms, prec2ndec(frout.prec),
1807                                                       frout.x, frout.bV ? frout.v : NULL, frout.box);
1808                                         break;
1809                                     case efPDB:
1810                                         fprintf(out, "REMARK    GENERATED BY TRJCONV\n");
1811                                         sprintf(title, "%s t= %9.5f", top_title, frout.time);
1812                                         /* if reading from pdb, we want to keep the original
1813                                            model numbering else we write the output frame
1814                                            number plus one, because model 0 is not allowed in pdb */
1815                                         if (ftpin == efPDB && fr.bStep && fr.step > model_nr)
1816                                         {
1817                                             model_nr = fr.step;
1818                                         }
1819                                         else
1820                                         {
1821                                             model_nr++;
1822                                         }
1823                                         write_pdbfile(out, title, &useatoms, frout.x,
1824                                                       frout.ePBC, frout.box, ' ', model_nr, gc, TRUE);
1825                                         break;
1826                                     case efG96:
1827                                         frout.title = title;
1828                                         if (bSeparate || bTDump)
1829                                         {
1830                                             frout.bTitle = TRUE;
1831                                             if (bTPS)
1832                                             {
1833                                                 frout.bAtoms = TRUE;
1834                                             }
1835                                             frout.atoms  = &useatoms;
1836                                             frout.bStep  = FALSE;
1837                                             frout.bTime  = FALSE;
1838                                         }
1839                                         else
1840                                         {
1841                                             frout.bTitle = (outframe == 0);
1842                                             frout.bAtoms = FALSE;
1843                                             frout.bStep  = TRUE;
1844                                             frout.bTime  = TRUE;
1845                                         }
1846                                         write_g96_conf(out, &frout, -1, NULL);
1847                                 }
1848                                 if (bSeparate || bSplitHere)
1849                                 {
1850                                     gmx_ffclose(out);
1851                                     out = NULL;
1852                                 }
1853                                 break;
1854                             default:
1855                                 gmx_fatal(FARGS, "DHE, ftp=%d\n", ftp);
1856                         }
1857                         if (bSeparate || bSplitHere)
1858                         {
1859                             file_nr++;
1860                         }
1861
1862                         /* execute command */
1863                         if (bExec)
1864                         {
1865                             char c[255];
1866                             sprintf(c, "%s  %d", exec_command, file_nr-1);
1867                             /*fprintf(stderr,"Executing '%s'\n",c);*/
1868                             if (0 != system(c))
1869                             {
1870                                 gmx_fatal(FARGS, "Error executing command: %s", c);
1871                             }
1872                         }
1873                         outframe++;
1874                     }
1875                 }
1876                 frame++;
1877                 bHaveNextFrame = read_next_frame(oenv, trxin, &fr);
1878             }
1879             while (!(bTDump && bDumpFrame) && bHaveNextFrame);
1880         }
1881
1882         if (!bHaveFirstFrame || (bTDump && !bDumpFrame))
1883         {
1884             fprintf(stderr, "\nWARNING no output, "
1885                     "last frame read at t=%g\n", fr.time);
1886         }
1887         fprintf(stderr, "\n");
1888
1889         close_trj(trxin);
1890         sfree(outf_base);
1891
1892         if (bRmPBC)
1893         {
1894             gmx_rmpbc_done(gpbc);
1895         }
1896
1897         if (trxout)
1898         {
1899             close_trx(trxout);
1900         }
1901         else if (out != NULL)
1902         {
1903             gmx_ffclose(out);
1904         }
1905         if (bSubTraj)
1906         {
1907             for (i = 0; (i < clust->clust->nr); i++)
1908             {
1909                 if (clust_status_id[i] >= 0)
1910                 {
1911                     close_trx(clust_status[i]);
1912                 }
1913             }
1914         }
1915     }
1916
1917     sfree(mtop);
1918
1919     do_view(oenv, out_file, NULL);
1920
1921     return 0;
1922 }