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