Split lines with many copyright years
[alexxy/gromacs.git] / src / gromacs / tools / dump.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-2013, The GROMACS development team.
6  * Copyright (c) 2013,2014,2015,2016,2017 by the GROMACS development team.
7  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
9  * and including many others, as listed in the AUTHORS file in the
10  * top-level source directory and at http://www.gromacs.org.
11  *
12  * GROMACS is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU Lesser General Public License
14  * as published by the Free Software Foundation; either version 2.1
15  * of the License, or (at your option) any later version.
16  *
17  * GROMACS is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20  * Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with GROMACS; if not, see
24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
26  *
27  * If you want to redistribute modifications to GROMACS, please
28  * consider that scientific software is very special. Version
29  * control is crucial - bugs must be traceable. We will be happy to
30  * consider code for inclusion in the official distribution, but
31  * derived work must not be called official GROMACS. Details are found
32  * in the README & COPYING files - if they are missing, get the
33  * official version at http://www.gromacs.org.
34  *
35  * To help us fund GROMACS development, we humbly ask that you cite
36  * the research papers on the package. Check out http://www.gromacs.org.
37  */
38 /*! \internal \file
39  * \brief Implements gmx dump utility.
40  *
41  * \ingroup module_tools
42  */
43 #include "gmxpre.h"
44
45 #include "dump.h"
46
47 #include "config.h"
48
49 #include <cassert>
50 #include <cmath>
51 #include <cstdio>
52 #include <cstring>
53
54 #include "gromacs/commandline/cmdlineoptionsmodule.h"
55 #include "gromacs/fileio/checkpoint.h"
56 #include "gromacs/fileio/enxio.h"
57 #include "gromacs/fileio/filetypes.h"
58 #include "gromacs/fileio/gmxfio.h"
59 #include "gromacs/fileio/mtxio.h"
60 #include "gromacs/fileio/tngio.h"
61 #include "gromacs/fileio/tpxio.h"
62 #include "gromacs/fileio/trrio.h"
63 #include "gromacs/fileio/xtcio.h"
64 #include "gromacs/gmxpreprocess/gmxcpp.h"
65 #include "gromacs/math/vecdump.h"
66 #include "gromacs/mdrun/mdmodules.h"
67 #include "gromacs/mdtypes/forcerec.h"
68 #include "gromacs/mdtypes/inputrec.h"
69 #include "gromacs/mdtypes/md_enums.h"
70 #include "gromacs/mdtypes/state.h"
71 #include "gromacs/options/basicoptions.h"
72 #include "gromacs/options/filenameoption.h"
73 #include "gromacs/options/ioptionscontainer.h"
74 #include "gromacs/topology/mtop_util.h"
75 #include "gromacs/topology/topology.h"
76 #include "gromacs/trajectory/energyframe.h"
77 #include "gromacs/trajectory/trajectoryframe.h"
78 #include "gromacs/utility/arraysize.h"
79 #include "gromacs/utility/basedefinitions.h"
80 #include "gromacs/utility/fatalerror.h"
81 #include "gromacs/utility/futil.h"
82 #include "gromacs/utility/smalloc.h"
83 #include "gromacs/utility/txtdump.h"
84
85 namespace gmx
86 {
87
88 namespace
89 {
90
91 //! Dump a TPR file
92 void list_tpr(const char* fn,
93               gmx_bool    bShowNumbers,
94               gmx_bool    bShowParameters,
95               const char* mdpfn,
96               gmx_bool    bSysTop,
97               gmx_bool    bOriginalInputrec)
98 {
99     FILE*      gp;
100     int        indent, atot;
101     t_state    state;
102     gmx_mtop_t mtop;
103     t_topology top;
104
105     TpxFileHeader tpx = readTpxHeader(fn, true);
106     t_inputrec    ir;
107
108     read_tpx_state(fn, tpx.bIr ? &ir : nullptr, &state, tpx.bTop ? &mtop : nullptr);
109     if (tpx.bIr && !bOriginalInputrec)
110     {
111         MDModules().adjustInputrecBasedOnModules(&ir);
112     }
113
114     if (mdpfn && tpx.bIr)
115     {
116         gp = gmx_fio_fopen(mdpfn, "w");
117         pr_inputrec(gp, 0, nullptr, &ir, TRUE);
118         gmx_fio_fclose(gp);
119     }
120
121     if (!mdpfn)
122     {
123         if (bSysTop)
124         {
125             top = gmx_mtop_t_to_t_topology(&mtop, false);
126         }
127
128         if (available(stdout, &tpx, 0, fn))
129         {
130             indent = 0;
131             pr_title(stdout, indent, fn);
132             pr_inputrec(stdout, 0, "inputrec", tpx.bIr ? &ir : nullptr, FALSE);
133
134             pr_tpxheader(stdout, indent, "header", &(tpx));
135
136             if (!bSysTop)
137             {
138                 pr_mtop(stdout, indent, "topology", &(mtop), bShowNumbers, bShowParameters);
139             }
140             else
141             {
142                 pr_top(stdout, indent, "topology", &(top), bShowNumbers, bShowParameters);
143             }
144
145             pr_rvecs(stdout, indent, "box", tpx.bBox ? state.box : nullptr, DIM);
146             pr_rvecs(stdout, indent, "box_rel", tpx.bBox ? state.box_rel : nullptr, DIM);
147             pr_rvecs(stdout, indent, "boxv", tpx.bBox ? state.boxv : nullptr, DIM);
148             pr_rvecs(stdout, indent, "pres_prev", tpx.bBox ? state.pres_prev : nullptr, DIM);
149             pr_rvecs(stdout, indent, "svir_prev", tpx.bBox ? state.svir_prev : nullptr, DIM);
150             pr_rvecs(stdout, indent, "fvir_prev", tpx.bBox ? state.fvir_prev : nullptr, DIM);
151             /* leave nosehoover_xi in for now to match the tpr version */
152             pr_doubles(stdout, indent, "nosehoover_xi", state.nosehoover_xi.data(), state.ngtc);
153             /*pr_doubles(stdout,indent,"nosehoover_vxi",state.nosehoover_vxi,state.ngtc);*/
154             /*pr_doubles(stdout,indent,"therm_integral",state.therm_integral,state.ngtc);*/
155             pr_rvecs(stdout, indent, "x", tpx.bX ? state.x.rvec_array() : nullptr, state.natoms);
156             pr_rvecs(stdout, indent, "v", tpx.bV ? state.v.rvec_array() : nullptr, state.natoms);
157         }
158
159         const SimulationGroups& groups = mtop.groups;
160
161         gmx::EnumerationArray<SimulationAtomGroupType, std::vector<int>> gcount;
162         for (auto group : keysOf(gcount))
163         {
164             gcount[group].resize(groups.groups[group].size());
165         }
166
167         for (int i = 0; (i < mtop.natoms); i++)
168         {
169             for (auto group : keysOf(gcount))
170             {
171                 gcount[group][getGroupType(groups, group, i)]++;
172             }
173         }
174         printf("Group statistics\n");
175         for (auto group : keysOf(gcount))
176         {
177             atot = 0;
178             printf("%-12s: ", shortName(group));
179             for (const auto& entry : gcount[group])
180             {
181                 printf("  %5d", entry);
182                 atot += entry;
183             }
184             printf("  (total %d atoms)\n", atot);
185         }
186     }
187 }
188
189 //! Dump a topology file
190 void list_top(const char* fn)
191 {
192     int status, done;
193     // Legacy string length macro
194     char      buf[STRLEN];
195     gmx_cpp_t handle;
196     char*     cppopts[] = { nullptr };
197
198     status = cpp_open_file(fn, &handle, cppopts);
199     if (status != 0)
200     {
201         gmx_fatal(FARGS, "%s", cpp_error(&handle, status));
202     }
203     do
204     {
205         status = cpp_read_line(&handle, STRLEN, buf);
206         done   = static_cast<int>(status == eCPP_EOF);
207         if (!done)
208         {
209             if (status != eCPP_OK)
210             {
211                 gmx_fatal(FARGS, "%s", cpp_error(&handle, status));
212             }
213             else
214             {
215                 printf("%s\n", buf);
216             }
217         }
218     } while (done == 0);
219     status = cpp_close_file(&handle);
220     if (status != eCPP_OK)
221     {
222         gmx_fatal(FARGS, "%s", cpp_error(&handle, status));
223     }
224 }
225
226 //! Dump a TRR file
227 void list_trr(const char* fn)
228 {
229     t_fileio*        fpread;
230     int              nframe, indent;
231     char             buf[256];
232     rvec *           x, *v, *f;
233     matrix           box;
234     gmx_trr_header_t trrheader;
235     gmx_bool         bOK;
236
237     fpread = gmx_trr_open(fn, "r");
238
239     nframe = 0;
240     while (gmx_trr_read_frame_header(fpread, &trrheader, &bOK))
241     {
242         snew(x, trrheader.natoms);
243         snew(v, trrheader.natoms);
244         snew(f, trrheader.natoms);
245         if (gmx_trr_read_frame_data(fpread, &trrheader, trrheader.box_size ? box : nullptr,
246                                     trrheader.x_size ? x : nullptr, trrheader.v_size ? v : nullptr,
247                                     trrheader.f_size ? f : nullptr))
248         {
249             sprintf(buf, "%s frame %d", fn, nframe);
250             indent = 0;
251             indent = pr_title(stdout, indent, buf);
252             pr_indent(stdout, indent);
253             fprintf(stdout, "natoms=%10d  step=%10" PRId64 "  time=%12.7e  lambda=%10g\n",
254                     trrheader.natoms, trrheader.step, trrheader.t, trrheader.lambda);
255             if (trrheader.box_size)
256             {
257                 pr_rvecs(stdout, indent, "box", box, DIM);
258             }
259             if (trrheader.x_size)
260             {
261                 pr_rvecs(stdout, indent, "x", x, trrheader.natoms);
262             }
263             if (trrheader.v_size)
264             {
265                 pr_rvecs(stdout, indent, "v", v, trrheader.natoms);
266             }
267             if (trrheader.f_size)
268             {
269                 pr_rvecs(stdout, indent, "f", f, trrheader.natoms);
270             }
271         }
272         else
273         {
274             fprintf(stderr, "\nWARNING: Incomplete frame: nr %d, t=%g\n", nframe, trrheader.t);
275         }
276
277         sfree(x);
278         sfree(v);
279         sfree(f);
280         nframe++;
281     }
282     if (!bOK)
283     {
284         fprintf(stderr, "\nWARNING: Incomplete frame header: nr %d, t=%g\n", nframe, trrheader.t);
285     }
286     gmx_trr_close(fpread);
287 }
288
289 //! Dump an xtc file
290 void list_xtc(const char* fn)
291 {
292     t_fileio* xd;
293     int       indent;
294     char      buf[256];
295     rvec*     x;
296     matrix    box;
297     int       nframe, natoms;
298     int64_t   step;
299     real      prec, time;
300     gmx_bool  bOK;
301
302     xd = open_xtc(fn, "r");
303     read_first_xtc(xd, &natoms, &step, &time, box, &x, &prec, &bOK);
304
305     nframe = 0;
306     do
307     {
308         sprintf(buf, "%s frame %d", fn, nframe);
309         indent = 0;
310         indent = pr_title(stdout, indent, buf);
311         pr_indent(stdout, indent);
312         fprintf(stdout, "natoms=%10d  step=%10" PRId64 "  time=%12.7e  prec=%10g\n", natoms, step,
313                 time, prec);
314         pr_rvecs(stdout, indent, "box", box, DIM);
315         pr_rvecs(stdout, indent, "x", x, natoms);
316         nframe++;
317     } while (read_next_xtc(xd, natoms, &step, &time, box, x, &prec, &bOK) != 0);
318     if (!bOK)
319     {
320         fprintf(stderr, "\nWARNING: Incomplete frame at time %g\n", time);
321     }
322     sfree(x);
323     close_xtc(xd);
324 }
325
326 #if GMX_USE_TNG
327
328 /*! \brief Callback used by list_tng_for_gmx_dump. */
329 void list_tng_inner(const char* fn,
330                     gmx_bool    bFirstFrame,
331                     real*       values,
332                     int64_t     step,
333                     double      frame_time,
334                     int64_t     n_values_per_frame,
335                     int64_t     n_atoms,
336                     real        prec,
337                     int64_t     nframe,
338                     char*       block_name)
339 {
340     char buf[256];
341     int  indent = 0;
342
343     if (bFirstFrame)
344     {
345         sprintf(buf, "%s frame %" PRId64, fn, nframe);
346         indent = 0;
347         indent = pr_title(stdout, indent, buf);
348         pr_indent(stdout, indent);
349         fprintf(stdout, "natoms=%10" PRId64 "  step=%10" PRId64 "  time=%12.7e", n_atoms, step, frame_time);
350         if (prec > 0)
351         {
352             fprintf(stdout, "  prec=%10g", prec);
353         }
354         fprintf(stdout, "\n");
355     }
356     pr_reals_of_dim(stdout, indent, block_name, values, n_atoms, n_values_per_frame);
357 }
358
359 #endif
360
361 //! Dump a TNG file
362 void list_tng(const char* fn)
363 {
364 #if GMX_USE_TNG
365     gmx_tng_trajectory_t tng;
366     int64_t              nframe = 0;
367     int64_t              i, *block_ids = nullptr, step, ndatablocks;
368     gmx_bool             bOK;
369     real*                values = nullptr;
370
371     gmx_tng_open(fn, 'r', &tng);
372     gmx_print_tng_molecule_system(tng, stdout);
373
374     bOK = gmx_get_tng_data_block_types_of_next_frame(tng, -1, 0, nullptr, &step, &ndatablocks, &block_ids);
375     do
376     {
377         for (i = 0; i < ndatablocks; i++)
378         {
379             double  frame_time;
380             real    prec;
381             int64_t n_values_per_frame, n_atoms;
382             char    block_name[STRLEN];
383
384             gmx_get_tng_data_next_frame_of_block_type(tng, block_ids[i], &values, &step,
385                                                       &frame_time, &n_values_per_frame, &n_atoms,
386                                                       &prec, block_name, STRLEN, &bOK);
387             if (!bOK)
388             {
389                 /* Can't write any output because we don't know what
390                    arrays are valid. */
391                 fprintf(stderr, "\nWARNING: Incomplete frame at time %g, will not write output\n",
392                         frame_time);
393             }
394             else
395             {
396                 list_tng_inner(fn, (0 == i), values, step, frame_time, n_values_per_frame, n_atoms,
397                                prec, nframe, block_name);
398             }
399         }
400         nframe++;
401     } while (gmx_get_tng_data_block_types_of_next_frame(tng, step, 0, nullptr, &step, &ndatablocks,
402                                                         &block_ids));
403
404     if (block_ids)
405     {
406         sfree(block_ids);
407     }
408     sfree(values);
409     gmx_tng_close(&tng);
410 #else
411     GMX_UNUSED_VALUE(fn);
412 #endif
413 }
414
415 //! Dump a trajectory file
416 void list_trx(const char* fn)
417 {
418     switch (fn2ftp(fn))
419     {
420         case efXTC: list_xtc(fn); break;
421         case efTRR: list_trr(fn); break;
422         case efTNG: list_tng(fn); break;
423         default:
424             fprintf(stderr, "File %s is of an unsupported type. Try using the command\n 'less %s'\n",
425                     fn, fn);
426     }
427 }
428
429 //! Dump an energy file
430 void list_ene(const char* fn)
431 {
432     ener_file_t  in;
433     gmx_bool     bCont;
434     gmx_enxnm_t* enm = nullptr;
435     t_enxframe*  fr;
436     int          i, j, nre, b;
437     char         buf[22];
438
439     printf("gmx dump: %s\n", fn);
440     in = open_enx(fn, "r");
441     do_enxnms(in, &nre, &enm);
442     assert(enm);
443
444     printf("energy components:\n");
445     for (i = 0; (i < nre); i++)
446     {
447         printf("%5d  %-24s (%s)\n", i, enm[i].name, enm[i].unit);
448     }
449
450     snew(fr, 1);
451     do
452     {
453         bCont = do_enx(in, fr);
454
455         if (bCont)
456         {
457             printf("\n%24s  %12.5e  %12s  %12s\n", "time:", fr->t, "step:", gmx_step_str(fr->step, buf));
458             printf("%24s  %12s  %12s  %12s\n", "", "", "nsteps:", gmx_step_str(fr->nsteps, buf));
459             printf("%24s  %12.5e  %12s  %12s\n", "delta_t:", fr->dt,
460                    "sum steps:", gmx_step_str(fr->nsum, buf));
461             if (fr->nre == nre)
462             {
463                 printf("%24s  %12s  %12s  %12s\n", "Component", "Energy", "Av. Energy",
464                        "Sum Energy");
465                 if (fr->nsum > 0)
466                 {
467                     for (i = 0; (i < nre); i++)
468                     {
469                         printf("%24s  %12.5e  %12.5e  %12.5e\n", enm[i].name, fr->ener[i].e,
470                                fr->ener[i].eav, fr->ener[i].esum);
471                     }
472                 }
473                 else
474                 {
475                     for (i = 0; (i < nre); i++)
476                     {
477                         printf("%24s  %12.5e\n", enm[i].name, fr->ener[i].e);
478                     }
479                 }
480             }
481             for (b = 0; b < fr->nblock; b++)
482             {
483                 const char* typestr = "";
484
485                 t_enxblock* eb = &(fr->block[b]);
486                 printf("Block data %2d (%3d subblocks, id=%d)\n", b, eb->nsub, eb->id);
487
488                 if (eb->id < enxNR)
489                 {
490                     typestr = enx_block_id_name[eb->id];
491                 }
492                 printf("  id='%s'\n", typestr);
493                 for (i = 0; i < eb->nsub; i++)
494                 {
495                     t_enxsubblock* sb = &(eb->sub[i]);
496                     printf("  Sub block %3d (%5d elems, type=%s) values:\n", i, sb->nr,
497                            xdr_datatype_names[sb->type]);
498
499                     switch (sb->type)
500                     {
501                         case xdr_datatype_float:
502                             for (j = 0; j < sb->nr; j++)
503                             {
504                                 printf("%14d   %8.4f\n", j, sb->fval[j]);
505                             }
506                             break;
507                         case xdr_datatype_double:
508                             for (j = 0; j < sb->nr; j++)
509                             {
510                                 printf("%14d   %10.6f\n", j, sb->dval[j]);
511                             }
512                             break;
513                         case xdr_datatype_int:
514                             for (j = 0; j < sb->nr; j++)
515                             {
516                                 printf("%14d %10d\n", j, sb->ival[j]);
517                             }
518                             break;
519                         case xdr_datatype_int64:
520                             for (j = 0; j < sb->nr; j++)
521                             {
522                                 printf("%14d %s\n", j, gmx_step_str(sb->lval[j], buf));
523                             }
524                             break;
525                         case xdr_datatype_char:
526                             for (j = 0; j < sb->nr; j++)
527                             {
528                                 printf("%14d %1c\n", j, sb->cval[j]);
529                             }
530                             break;
531                         case xdr_datatype_string:
532                             for (j = 0; j < sb->nr; j++)
533                             {
534                                 printf("%14d %80s\n", j, sb->sval[j]);
535                             }
536                             break;
537                         default: gmx_incons("Unknown subblock type");
538                     }
539                 }
540             }
541         }
542     } while (bCont);
543
544     close_enx(in);
545
546     free_enxframe(fr);
547     sfree(fr);
548     sfree(enm);
549 }
550
551 //! Dump a (Hessian) matrix file
552 void list_mtx(const char* fn)
553 {
554     int                 nrow, ncol, i, j, k;
555     real *              full   = nullptr, value;
556     gmx_sparsematrix_t* sparse = nullptr;
557
558     gmx_mtxio_read(fn, &nrow, &ncol, &full, &sparse);
559
560     if (full == nullptr)
561     {
562         snew(full, nrow * ncol);
563         for (i = 0; i < nrow * ncol; i++)
564         {
565             full[i] = 0;
566         }
567
568         for (i = 0; i < sparse->nrow; i++)
569         {
570             for (j = 0; j < sparse->ndata[i]; j++)
571             {
572                 k                  = sparse->data[i][j].col;
573                 value              = sparse->data[i][j].value;
574                 full[i * ncol + k] = value;
575                 full[k * ncol + i] = value;
576             }
577         }
578         gmx_sparsematrix_destroy(sparse);
579     }
580
581     printf("%d %d\n", nrow, ncol);
582     for (i = 0; i < nrow; i++)
583     {
584         for (j = 0; j < ncol; j++)
585         {
586             printf(" %g", full[i * ncol + j]);
587         }
588         printf("\n");
589     }
590
591     sfree(full);
592 }
593
594 class Dump : public ICommandLineOptionsModule
595 {
596 public:
597     Dump() {}
598
599     // From ICommandLineOptionsModule
600     void init(CommandLineModuleSettings* /*settings*/) override {}
601
602     void initOptions(IOptionsContainer* options, ICommandLineOptionsModuleSettings* settings) override;
603
604     void optionsFinished() override;
605
606     int run() override;
607
608 private:
609     //! Commandline options
610     //! \{
611     bool bShowNumbers_      = true;
612     bool bShowParams_       = false;
613     bool bSysTop_           = false;
614     bool bOriginalInputrec_ = false;
615     //! \}
616     //! Commandline file options
617     //! \{
618     std::string inputTprFilename_;
619     std::string inputTrajectoryFilename_;
620     std::string inputEnergyFilename_;
621     std::string inputCheckpointFilename_;
622     std::string inputTopologyFilename_;
623     std::string inputMatrixFilename_;
624     std::string outputMdpFilename_;
625     //! \}
626 };
627
628 void Dump::initOptions(IOptionsContainer* options, ICommandLineOptionsModuleSettings* settings)
629 {
630     const char* desc[] = { "[THISMODULE] reads a run input file ([REF].tpr[ref]),",
631                            "a trajectory ([REF].trr[ref]/[REF].xtc[ref]/[TT]tng[tt]), an energy",
632                            "file ([REF].edr[ref]), a checkpoint file ([REF].cpt[ref])",
633                            "or topology file ([REF].top[ref])",
634                            "and prints that to standard output in a readable format.",
635                            "This program is essential for checking your run input file in case of",
636                            "problems." };
637     settings->setHelpText(desc);
638
639     const char* bugs[] = {
640         "The [REF].mdp[ref] file produced by [TT]-om[tt] can not be read by grompp."
641     };
642     settings->setBugText(bugs);
643     // TODO If this ancient note acknowledging a bug is still true,
644     // fix it or block that run path:
645     //   Position restraint output from -sys -s is broken
646
647     options->addOption(
648             FileNameOption("s").filetype(eftRunInput).inputFile().store(&inputTprFilename_).description("Run input file to dump"));
649     options->addOption(FileNameOption("f")
650                                .filetype(eftTrajectory)
651                                .inputFile()
652                                .store(&inputTrajectoryFilename_)
653                                .description("Trajectory file to dump"));
654     options->addOption(
655             FileNameOption("e").filetype(eftEnergy).inputFile().store(&inputEnergyFilename_).description("Energy file to dump"));
656     options->addOption(
657             FileNameOption("cp").legacyType(efCPT).inputFile().store(&inputCheckpointFilename_).description("Checkpoint file to dump"));
658     options->addOption(
659             FileNameOption("p").legacyType(efTOP).inputFile().store(&inputTopologyFilename_).description("Topology file to dump"));
660     options->addOption(
661             FileNameOption("mtx").legacyType(efMTX).inputFile().store(&inputMatrixFilename_).description("Hessian matrix to dump"));
662     options->addOption(FileNameOption("om")
663                                .legacyType(efMDP)
664                                .outputFile()
665                                .store(&outputMdpFilename_)
666                                .description("grompp input file from run input file"));
667
668     options->addOption(
669             BooleanOption("nr").store(&bShowNumbers_).defaultValue(true).description("Show index numbers in output (leaving them out makes comparison easier, but creates a useless topology)"));
670     options->addOption(
671             BooleanOption("param").store(&bShowParams_).defaultValue(false).description("Show parameters for each bonded interaction (for comparing dumps, it is useful to combine this with -nonr)"));
672     options->addOption(
673             BooleanOption("sys").store(&bShowParams_).defaultValue(false).description("List the atoms and bonded interactions for the whole system instead of for each molecule type"));
674     options->addOption(
675             BooleanOption("orgir").store(&bShowParams_).defaultValue(false).description("Show input parameters from tpr as they were written by the version that produced the file, instead of how the current version reads them"));
676 }
677
678 void Dump::optionsFinished()
679 {
680     // TODO Currently gmx dump ignores user input that seeks to dump
681     // multiple files. Here, we could enforce that the user only asks
682     // to dump one file.
683 }
684
685 int Dump::run()
686 {
687     if (!inputTprFilename_.empty())
688     {
689         list_tpr(inputTprFilename_.c_str(), bShowNumbers_, bShowParams_,
690                  outputMdpFilename_.empty() ? nullptr : outputMdpFilename_.c_str(), bSysTop_,
691                  bOriginalInputrec_);
692     }
693     else if (!inputTrajectoryFilename_.empty())
694     {
695         list_trx(inputTrajectoryFilename_.c_str());
696     }
697     else if (!inputEnergyFilename_.empty())
698     {
699         list_ene(inputEnergyFilename_.c_str());
700     }
701     else if (!inputCheckpointFilename_.empty())
702     {
703         list_checkpoint(inputCheckpointFilename_.c_str(), stdout);
704     }
705     else if (!inputTopologyFilename_.empty())
706     {
707         list_top(inputTopologyFilename_.c_str());
708     }
709     else if (!inputMatrixFilename_.empty())
710     {
711         list_mtx(inputMatrixFilename_.c_str());
712     }
713
714     return 0;
715 }
716
717 } // namespace
718
719 const char                       DumpInfo::name[]             = "dump";
720 const char                       DumpInfo::shortDescription[] = "Make binary files human readable";
721 ICommandLineOptionsModulePointer DumpInfo::create()
722 {
723     return std::make_unique<Dump>();
724 }
725
726 } // namespace gmx