src/gromacs/tools/dump.c

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