src/gromacs/legacyheaders/txtdump.h

   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, 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
  38 #ifndef _txtdump_h
  39 #define _txtdump_h
  40
  41
  42 #include <stdio.h>
  43
  44 #include "gromacs/fileio/tpxio.h"
  45 #include "gromacs/legacyheaders/typedefs.h"
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51
  52 #define LINE_WIDTH  80
  53 #define RMARGIN     10
  54 #define USE_WIDTH   ((LINE_WIDTH)-(RMARGIN))
  55 #define INDENT      3
  56
  57 int pr_indent(FILE *fp, int n);
  58 int available(FILE *fp, void *p, int indent, const char *title);
  59 int pr_title(FILE *fp, int indent, const char *title);
  60 int pr_title_n(FILE *fp, int indent, const char *title, int n);
  61 int pr_title_nxn(FILE *fp, int indent, const char *title, int n1, int n2);
  62 void pr_ivec(FILE *fp, int indent, const char *title, int vec[], int n, gmx_bool bShowNumbers);
  63 void pr_ivecs(FILE *fp, int indent, const char *title, ivec vec[], int n, gmx_bool bShowNumbers);
  64 void pr_bvec(FILE *fp, int indent, const char *title, gmx_bool vec[], int n, gmx_bool bShowNnumbers);
  65 void pr_rvec(FILE *fp, int indent, const char *title, real vec[], int n, gmx_bool bShowNumbers);
  66 void pr_rvecs_of_dim(FILE *fp, int indent, const char *title, rvec vec[], int n, int dim);
  67 void pr_dvec(FILE *fp, int indent, const char *title, double vec[], int n, gmx_bool bShowNumbers);
  68 void pr_rvecs(FILE *fp, int indent, const char *title, rvec vec[], int n);
  69 void pr_rvecs_len(FILE *fp, int indent, const char *title, rvec vec[], int n);
  70 void pr_reals(FILE *fp, int indent, const char *title, real vec[], int n);
  71 void pr_doubles(FILE *fp, int indent, const char *title, double *vec, int n);
  72 void pr_reals_of_dim(FILE *fp, int indent, const char *title, real *vec, int n, int dim);
  73 void pr_block(FILE *fp, int indent, const char *title, t_block *block, gmx_bool bShowNumbers);
  74 void pr_blocka(FILE *fp, int indent, const char *title, t_blocka *block, gmx_bool bShowNumbers);
  75 void pr_ilist(FILE *fp, int indent, const char *title,
  76               t_functype *functype, t_ilist *ilist, gmx_bool bShowNumbers);
  77 void pr_iparams(FILE *fp, t_functype ftype, t_iparams *iparams);
  78 void pr_idef(FILE *fp, int indent, const char *title, t_idef *idef, gmx_bool bShowNumbers);
  79 void pr_inputrec(FILE *fp, int indent, const char *title, t_inputrec *ir,
  80                  gmx_bool bMDPformat);
  81 void pr_atoms(FILE *fp, int indent, const char *title, t_atoms *atoms,
  82               gmx_bool bShownumbers);
  83 void pr_atomtypes(FILE *fp, int indent, const char *title,
  84                   t_atomtypes *atomtypes, gmx_bool bShowNumbers);
  85 void pr_mtop(FILE *fp, int indent, const char *title, gmx_mtop_t *mtop,
  86              gmx_bool bShowNumbers);
  87 void pr_top(FILE *fp, int indent, const char *title, t_topology *top, gmx_bool bShowNumbers);
  88 /*
  89  * This routine prints out a (human) readable representation of
  90  * the topology to the file fp. Ident specifies the number of
  91  * spaces the text should be indented. Title is used to print a
  92  * header text.
  93  */
  94 void pr_header(FILE *fp, int indent, const char *title, t_tpxheader *sh);
  95 /*
  96  * This routine prints out a (human) readable representation of
  97  * a header to the file fp. Ident specifies the number of spaces
  98  * the text should be indented. Title is used to print a header text.
  99  */
 100
 101 void pr_commrec(FILE *fp, int indent, t_commrec *cr);
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #endif  /* _txtdump_h */