src/programs/gmx/gmxdump.c

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2013, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gallium Rubidium Oxygen Manganese Argon Carbon Silicon
  34  */
  35 #ifdef HAVE_CONFIG_H
  36 #include <config.h>
  37 #endif
  38
  39 #include <stdio.h>
  40 #include <string.h>
  41 #include <math.h>
  42 #include <assert.h>
  43 #include "main.h"
  44 #include "macros.h"
  45 #include "gromacs/fileio/futil.h"
  46 #include "statutil.h"
  47 #include "sysstuff.h"
  48 #include "txtdump.h"
  49 #include "gmx_fatal.h"
  50 #include "gromacs/fileio/xtcio.h"
  51 #include "gromacs/fileio/enxio.h"
  52 #include "smalloc.h"
  53 #include "names.h"
  54 #include "gromacs/fileio/gmxfio.h"
  55 #include "gromacs/fileio/tpxio.h"
  56 #include "gromacs/fileio/trnio.h"
  57 #include "txtdump.h"
  58 #include "gmxcpp.h"
  59 #include "checkpoint.h"
  60 #include "mtop_util.h"
  61
  62 #include "gromacs/linearalgebra/mtxio.h"
  63 #include "gromacs/linearalgebra/sparsematrix.h"
  64
  65
  66 static void list_tpx(const char *fn, gmx_bool bShowNumbers, const char *mdpfn,
  67                      gmx_bool bSysTop)
  68 {
  69     FILE         *gp;
  70     int           fp, indent, i, j, **gcount, atot;
  71     t_state       state;
  72     rvec         *f = NULL;
  73     t_inputrec    ir;
  74     t_tpxheader   tpx;
  75     gmx_mtop_t    mtop;
  76     gmx_groups_t *groups;
  77     t_topology    top;
  78
  79     read_tpxheader(fn, &tpx, TRUE, NULL, NULL);
  80
  81     read_tpx_state(fn,
  82                    tpx.bIr  ? &ir : NULL,
  83                    &state, tpx.bF ? f : NULL,
  84                    tpx.bTop ? &mtop : NULL);
  85
  86     if (mdpfn && tpx.bIr)
  87     {
  88         gp = gmx_fio_fopen(mdpfn, "w");
  89         pr_inputrec(gp, 0, NULL, &(ir), TRUE);
  90         gmx_fio_fclose(gp);
  91     }
  92
  93     if (!mdpfn)
  94     {
  95         if (bSysTop)
  96         {
  97             top = gmx_mtop_t_to_t_topology(&mtop);
  98         }
  99
 100         if (available(stdout, &tpx, 0, fn))
 101         {
 102             indent = 0;
 103             indent = pr_title(stdout, indent, fn);
 104             pr_inputrec(stdout, 0, "inputrec", tpx.bIr ? &(ir) : NULL, FALSE);
 105
 106             indent = 0;
 107             pr_header(stdout, indent, "header", &(tpx));
 108
 109             if (!bSysTop)
 110             {
 111                 pr_mtop(stdout, indent, "topology", &(mtop), bShowNumbers);
 112             }
 113             else
 114             {
 115                 pr_top(stdout, indent, "topology", &(top), bShowNumbers);
 116             }
 117
 118             pr_rvecs(stdout, indent, "box", tpx.bBox ? state.box : NULL, DIM);
 119             pr_rvecs(stdout, indent, "box_rel", tpx.bBox ? state.box_rel : NULL, DIM);
 120             pr_rvecs(stdout, indent, "boxv", tpx.bBox ? state.boxv : NULL, DIM);
 121             pr_rvecs(stdout, indent, "pres_prev", tpx.bBox ? state.pres_prev : NULL, DIM);
 122             pr_rvecs(stdout, indent, "svir_prev", tpx.bBox ? state.svir_prev : NULL, DIM);
 123             pr_rvecs(stdout, indent, "fvir_prev", tpx.bBox ? state.fvir_prev : NULL, DIM);
 124             /* leave nosehoover_xi in for now to match the tpr version */
 125             pr_doubles(stdout, indent, "nosehoover_xi", state.nosehoover_xi, state.ngtc);
 126             /*pr_doubles(stdout,indent,"nosehoover_vxi",state.nosehoover_vxi,state.ngtc);*/
 127             /*pr_doubles(stdout,indent,"therm_integral",state.therm_integral,state.ngtc);*/
 128             pr_rvecs(stdout, indent, "x", tpx.bX ? state.x : NULL, state.natoms);
 129             pr_rvecs(stdout, indent, "v", tpx.bV ? state.v : NULL, state.natoms);
 130             if (tpx.bF)
 131             {
 132                 pr_rvecs(stdout, indent, "f", f, state.natoms);
 133             }
 134         }
 135
 136         groups = &mtop.groups;
 137
 138         snew(gcount, egcNR);
 139         for (i = 0; (i < egcNR); i++)
 140         {
 141             snew(gcount[i], groups->grps[i].nr);
 142         }
 143
 144         for (i = 0; (i < mtop.natoms); i++)
 145         {
 146             for (j = 0; (j < egcNR); j++)
 147             {
 148                 gcount[j][ggrpnr(groups, j, i)]++;
 149             }
 150         }
 151         printf("Group statistics\n");
 152         for (i = 0; (i < egcNR); i++)
 153         {
 154             atot = 0;
 155             printf("%-12s: ", gtypes[i]);
 156             for (j = 0; (j < groups->grps[i].nr); j++)
 157             {
 158                 printf("  %5d", gcount[i][j]);
 159                 atot += gcount[i][j];
 160             }
 161             printf("  (total %d atoms)\n", atot);
 162             sfree(gcount[i]);
 163         }
 164         sfree(gcount);
 165     }
 166     done_state(&state);
 167     sfree(f);
 168 }
 169
 170 static void list_top(const char *fn)
 171 {
 172     int       status, done;
 173 #define BUFLEN 256
 174     char      buf[BUFLEN];
 175     gmx_cpp_t handle;
 176     char     *cppopts[] = { NULL };
 177
 178     status = cpp_open_file(fn, &handle, cppopts);
 179     if (status != 0)
 180     {
 181         gmx_fatal(FARGS, cpp_error(&handle, status));
 182     }
 183     do
 184     {
 185         status = cpp_read_line(&handle, BUFLEN, buf);
 186         done   = (status == eCPP_EOF);
 187         if (!done)
 188         {
 189             if (status != eCPP_OK)
 190             {
 191                 gmx_fatal(FARGS, cpp_error(&handle, status));
 192             }
 193             else
 194             {
 195                 printf("%s\n", buf);
 196             }
 197         }
 198     }
 199     while (!done);
 200     status = cpp_close_file(&handle);
 201     if (status != eCPP_OK)
 202     {
 203         gmx_fatal(FARGS, cpp_error(&handle, status));
 204     }
 205 }
 206
 207 static void list_trn(const char *fn)
 208 {
 209     t_fileio       *fpread, *fpwrite;
 210     int             nframe, indent;
 211     char            buf[256];
 212     rvec           *x, *v, *f;
 213     matrix          box;
 214     t_trnheader     trn;
 215     gmx_bool        bOK;
 216
 217     fpread  = open_trn(fn, "r");
 218     fpwrite = open_tpx(NULL, "w");
 219     gmx_fio_setdebug(fpwrite, TRUE);
 220
 221     nframe = 0;
 222     while (fread_trnheader(fpread, &trn, &bOK))
 223     {
 224         snew(x, trn.natoms);
 225         snew(v, trn.natoms);
 226         snew(f, trn.natoms);
 227         if (fread_htrn(fpread, &trn,
 228                        trn.box_size ? box : NULL,
 229                        trn.x_size   ? x : NULL,
 230                        trn.v_size   ? v : NULL,
 231                        trn.f_size   ? f : NULL))
 232         {
 233             sprintf(buf, "%s frame %d", fn, nframe);
 234             indent = 0;
 235             indent = pr_title(stdout, indent, buf);
 236             pr_indent(stdout, indent);
 237             fprintf(stdout, "natoms=%10d  step=%10d  time=%12.7e  lambda=%10g\n",
 238                     trn.natoms, trn.step, trn.t, trn.lambda);
 239             if (trn.box_size)
 240             {
 241                 pr_rvecs(stdout, indent, "box", box, DIM);
 242             }
 243             if (trn.x_size)
 244             {
 245                 pr_rvecs(stdout, indent, "x", x, trn.natoms);
 246             }
 247             if (trn.v_size)
 248             {
 249                 pr_rvecs(stdout, indent, "v", v, trn.natoms);
 250             }
 251             if (trn.f_size)
 252             {
 253                 pr_rvecs(stdout, indent, "f", f, trn.natoms);
 254             }
 255         }
 256         else
 257         {
 258             fprintf(stderr, "\nWARNING: Incomplete frame: nr %d, t=%g\n",
 259                     nframe, trn.t);
 260         }
 261
 262         sfree(x);
 263         sfree(v);
 264         sfree(f);
 265         nframe++;
 266     }
 267     if (!bOK)
 268     {
 269         fprintf(stderr, "\nWARNING: Incomplete frame header: nr %d, t=%g\n",
 270                 nframe, trn.t);
 271     }
 272     close_tpx(fpwrite);
 273     close_trn(fpread);
 274 }
 275
 276 void list_xtc(const char *fn, gmx_bool bXVG)
 277 {
 278     t_fileio  *xd;
 279     int        indent;
 280     char       buf[256];
 281     rvec      *x;
 282     matrix     box;
 283     int        nframe, natoms, step;
 284     real       prec, time;
 285     gmx_bool   bOK;
 286
 287     xd = open_xtc(fn, "r");
 288     read_first_xtc(xd, &natoms, &step, &time, box, &x, &prec, &bOK);
 289
 290     nframe = 0;
 291     do
 292     {
 293         if (bXVG)
 294         {
 295             int i, d;
 296
 297             fprintf(stdout, "%g", time);
 298             for (i = 0; i < natoms; i++)
 299             {
 300                 for (d = 0; d < DIM; d++)
 301                 {
 302                     fprintf(stdout, " %g", x[i][d]);
 303                 }
 304             }
 305             fprintf(stdout, "\n");
 306         }
 307         else
 308         {
 309             sprintf(buf, "%s frame %d", fn, nframe);
 310             indent = 0;
 311             indent = pr_title(stdout, indent, buf);
 312             pr_indent(stdout, indent);
 313             fprintf(stdout, "natoms=%10d  step=%10d  time=%12.7e  prec=%10g\n",
 314                     natoms, step, time, prec);
 315             pr_rvecs(stdout, indent, "box", box, DIM);
 316             pr_rvecs(stdout, indent, "x", x, natoms);
 317         }
 318         nframe++;
 319     }
 320     while (read_next_xtc(xd, natoms, &step, &time, box, x, &prec, &bOK));
 321     if (!bOK)
 322     {
 323         fprintf(stderr, "\nWARNING: Incomplete frame at time %g\n", time);
 324     }
 325     sfree(x);
 326     close_xtc(xd);
 327 }
 328
 329 void list_trx(const char *fn, gmx_bool bXVG)
 330 {
 331     int ftp;
 332
 333     ftp = fn2ftp(fn);
 334     if (ftp == efXTC)
 335     {
 336         list_xtc(fn, bXVG);
 337     }
 338     else if ((ftp == efTRR) || (ftp == efTRJ))
 339     {
 340         list_trn(fn);
 341     }
 342     else
 343     {
 344         fprintf(stderr, "File %s is of an unsupported type. Try using the command\n 'less %s'\n",
 345                 fn, fn);
 346     }
 347 }
 348
 349 void list_ene(const char *fn)
 350 {
 351     int            ndr;
 352     ener_file_t    in;
 353     gmx_bool       bCont;
 354     gmx_enxnm_t   *enm = NULL;
 355     t_enxframe    *fr;
 356     int            i, j, nre, b;
 357     real           rav, minthird;
 358     char           buf[22];
 359
 360     printf("gmx dump: %s\n", fn);
 361     in = open_enx(fn, "r");
 362     do_enxnms(in, &nre, &enm);
 363     assert(enm);
 364
 365     printf("energy components:\n");
 366     for (i = 0; (i < nre); i++)
 367     {
 368         printf("%5d  %-24s (%s)\n", i, enm[i].name, enm[i].unit);
 369     }
 370
 371     minthird = -1.0/3.0;
 372     snew(fr, 1);
 373     do
 374     {
 375         bCont = do_enx(in, fr);
 376
 377         if (bCont)
 378         {
 379             printf("\n%24s  %12.5e  %12s  %12s\n", "time:",
 380                    fr->t, "step:", gmx_step_str(fr->step, buf));
 381             printf("%24s  %12s  %12s  %12s\n",
 382                    "", "", "nsteps:", gmx_step_str(fr->nsteps, buf));
 383             printf("%24s  %12.5e  %12s  %12s\n",
 384                    "delta_t:", fr->dt, "sum steps:", gmx_step_str(fr->nsum, buf));
 385             if (fr->nre == nre)
 386             {
 387                 printf("%24s  %12s  %12s  %12s\n",
 388                        "Component", "Energy", "Av. Energy", "Sum Energy");
 389                 if (fr->nsum > 0)
 390                 {
 391                     for (i = 0; (i < nre); i++)
 392                     {
 393                         printf("%24s  %12.5e  %12.5e  %12.5e\n",
 394                                enm[i].name, fr->ener[i].e, fr->ener[i].eav,
 395                                fr->ener[i].esum);
 396                     }
 397                 }
 398                 else
 399                 {
 400                     for (i = 0; (i < nre); i++)
 401                     {
 402                         printf("%24s  %12.5e\n",
 403                                enm[i].name, fr->ener[i].e);
 404                     }
 405                 }
 406             }
 407             for (b = 0; b < fr->nblock; b++)
 408             {
 409                 const char *typestr = "";
 410
 411                 t_enxblock *eb = &(fr->block[b]);
 412                 printf("Block data %2d (%3d subblocks, id=%d)\n",
 413                        b, eb->nsub, eb->id);
 414
 415                 if (eb->id < enxNR)
 416                 {
 417                     typestr = enx_block_id_name[eb->id];
 418                 }
 419                 printf("  id='%s'\n", typestr);
 420                 for (i = 0; i < eb->nsub; i++)
 421                 {
 422                     t_enxsubblock *sb = &(eb->sub[i]);
 423                     printf("  Sub block %3d (%5d elems, type=%s) values:\n",
 424                            i, sb->nr, xdr_datatype_names[sb->type]);
 425
 426                     switch (sb->type)
 427                     {
 428                         case xdr_datatype_float:
 429                             for (j = 0; j < sb->nr; j++)
 430                             {
 431                                 printf("%14d   %8.4f\n", j, sb->fval[j]);
 432                             }
 433                             break;
 434                         case xdr_datatype_double:
 435                             for (j = 0; j < sb->nr; j++)
 436                             {
 437                                 printf("%14d   %10.6f\n", j, sb->dval[j]);
 438                             }
 439                             break;
 440                         case xdr_datatype_int:
 441                             for (j = 0; j < sb->nr; j++)
 442                             {
 443                                 printf("%14d %10d\n", j, sb->ival[j]);
 444                             }
 445                             break;
 446                         case xdr_datatype_large_int:
 447                             for (j = 0; j < sb->nr; j++)
 448                             {
 449                                 printf("%14d %s\n",
 450                                        j, gmx_step_str(sb->lval[j], buf));
 451                             }
 452                             break;
 453                         case xdr_datatype_char:
 454                             for (j = 0; j < sb->nr; j++)
 455                             {
 456                                 printf("%14d %1c\n", j, sb->cval[j]);
 457                             }
 458                             break;
 459                         case xdr_datatype_string:
 460                             for (j = 0; j < sb->nr; j++)
 461                             {
 462                                 printf("%14d %80s\n", j, sb->sval[j]);
 463                             }
 464                             break;
 465                         default:
 466                             gmx_incons("Unknown subblock type");
 467                     }
 468                 }
 469             }
 470         }
 471     }
 472     while (bCont);
 473
 474     close_enx(in);
 475
 476     free_enxframe(fr);
 477     sfree(fr);
 478     sfree(enm);
 479 }
 480
 481 static void list_mtx(const char *fn)
 482 {
 483     int                  nrow, ncol, i, j, k;
 484     real                *full   = NULL, value;
 485     gmx_sparsematrix_t * sparse = NULL;
 486
 487     gmx_mtxio_read(fn, &nrow, &ncol, &full, &sparse);
 488
 489     if (full == NULL)
 490     {
 491         snew(full, nrow*ncol);
 492         for (i = 0; i < nrow*ncol; i++)
 493         {
 494             full[i] = 0;
 495         }
 496
 497         for (i = 0; i < sparse->nrow; i++)
 498         {
 499             for (j = 0; j < sparse->ndata[i]; j++)
 500             {
 501                 k              = sparse->data[i][j].col;
 502                 value          = sparse->data[i][j].value;
 503                 full[i*ncol+k] = value;
 504                 full[k*ncol+i] = value;
 505             }
 506         }
 507         gmx_sparsematrix_destroy(sparse);
 508     }
 509
 510     printf("%d %d\n", nrow, ncol);
 511     for (i = 0; i < nrow; i++)
 512     {
 513         for (j = 0; j < ncol; j++)
 514         {
 515             printf(" %g", full[i*ncol+j]);
 516         }
 517         printf("\n");
 518     }
 519
 520     sfree(full);
 521 }
 522
 523 int gmx_gmxdump(int argc, char *argv[])
 524 {
 525     const char *desc[] = {
 526         "[TT]gmx dump[tt] reads a run input file ([TT].tpa[tt]/[TT].tpr[tt]/[TT].tpb[tt]),",
 527         "a trajectory ([TT].trj[tt]/[TT].trr[tt]/[TT].xtc[tt]), an energy",
 528         "file ([TT].ene[tt]/[TT].edr[tt]), or a checkpoint file ([TT].cpt[tt])",
 529         "and prints that to standard output in a readable format.",
 530         "This program is essential for checking your run input file in case of",
 531         "problems.[PAR]",
 532         "The program can also preprocess a topology to help finding problems.",
 533         "Note that currently setting [TT]GMXLIB[tt] is the only way to customize",
 534         "directories used for searching include files.",
 535     };
 536     const char *bugs[] = {
 537         "Position restraint output from -sys -s is broken"
 538     };
 539     t_filenm    fnm[] = {
 540         { efTPX, "-s", NULL, ffOPTRD },
 541         { efTRX, "-f", NULL, ffOPTRD },
 542         { efEDR, "-e", NULL, ffOPTRD },
 543         { efCPT, NULL, NULL, ffOPTRD },
 544         { efTOP, "-p", NULL, ffOPTRD },
 545         { efMTX, "-mtx", "hessian", ffOPTRD },
 546         { efMDP, "-om", NULL, ffOPTWR }
 547     };
 548 #define NFILE asize(fnm)
 549
 550     output_env_t    oenv;
 551     /* Command line options */
 552     static gmx_bool bXVG         = FALSE;
 553     static gmx_bool bShowNumbers = TRUE;
 554     static gmx_bool bSysTop      = FALSE;
 555     t_pargs         pa[]         = {
 556         { "-xvg", FALSE, etBOOL, {&bXVG}, "HIDDENXVG layout for xtc" },
 557         { "-nr", FALSE, etBOOL, {&bShowNumbers}, "Show index numbers in output (leaving them out makes comparison easier, but creates a useless topology)" },
 558         { "-sys", FALSE, etBOOL, {&bSysTop}, "List the atoms and bonded interactions for the whole system instead of for each molecule type" }
 559     };
 560
 561     if (!parse_common_args(&argc, argv, 0, NFILE, fnm, asize(pa), pa,
 562                            asize(desc), desc, asize(bugs), bugs, &oenv))
 563     {
 564         return 0;
 565     }
 566
 567
 568     if (ftp2bSet(efTPX, NFILE, fnm))
 569     {
 570         list_tpx(ftp2fn(efTPX, NFILE, fnm), bShowNumbers,
 571                  ftp2fn_null(efMDP, NFILE, fnm), bSysTop);
 572     }
 573     else if (ftp2bSet(efTRX, NFILE, fnm))
 574     {
 575         list_trx(ftp2fn(efTRX, NFILE, fnm), bXVG);
 576     }
 577     else if (ftp2bSet(efEDR, NFILE, fnm))
 578     {
 579         list_ene(ftp2fn(efEDR, NFILE, fnm));
 580     }
 581     else if (ftp2bSet(efCPT, NFILE, fnm))
 582     {
 583         list_checkpoint(ftp2fn(efCPT, NFILE, fnm), stdout);
 584     }
 585     else if (ftp2bSet(efTOP, NFILE, fnm))
 586     {
 587         list_top(ftp2fn(efTOP, NFILE, fnm));
 588     }
 589     else if (ftp2bSet(efMTX, NFILE, fnm))
 590     {
 591         list_mtx(ftp2fn(efMTX, NFILE, fnm));
 592     }
 593
 594     return 0;
 595 }