include/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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * 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
  39 #ifndef _txtdump_h
  40 #define _txtdump_h
  41
  42
  43 #include <stdio.h>
  44 #include "visibility.h"
  45 #include "typedefs.h"
  46 #include "tpxio.h"
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52
  53 #define LINE_WIDTH  80
  54 #define RMARGIN     10
  55 #define USE_WIDTH   ((LINE_WIDTH)-(RMARGIN))
  56 #define INDENT      3
  57
  58 GMX_LIBGMX_EXPORT
  59 int pr_indent(FILE *fp, int n);
  60 GMX_LIBGMX_EXPORT
  61 int available(FILE *fp, void *p, int indent, const char *title);
  62 GMX_LIBGMX_EXPORT
  63 int pr_title(FILE *fp, int indent, const char *title);
  64 int pr_title_n(FILE *fp, int indent, const char *title, int n);
  65 int pr_title_nxn(FILE *fp, int indent, const char *title, int n1, int n2);
  66 GMX_LIBGMX_EXPORT
  67 void pr_ivec(FILE *fp, int indent, const char *title, int vec[], int n, gmx_bool bShowNumbers);
  68 void pr_ivecs(FILE *fp, int indent, const char *title, ivec vec[], int n, gmx_bool bShowNumbers);
  69 GMX_LIBGMX_EXPORT
  70 void pr_bvec(FILE *fp, int indent, const char *title, gmx_bool vec[], int n, gmx_bool bShowNnumbers);
  71 GMX_LIBGMX_EXPORT
  72 void pr_rvec(FILE *fp, int indent, const char *title, real vec[], int n, gmx_bool bShowNumbers);
  73 void pr_dvec(FILE *fp, int indent, const char *title, double vec[], int n, gmx_bool bShowNumbers);
  74 GMX_LIBGMX_EXPORT
  75 void pr_rvecs(FILE *fp, int indent, const char *title, rvec vec[], int n);
  76 void pr_rvecs_len(FILE *fp, int indent, const char *title, rvec vec[], int n);
  77 void pr_reals(FILE *fp, int indent, const char *title, real vec[], int n);
  78 GMX_LIBGMX_EXPORT
  79 void pr_doubles(FILE *fp, int indent, const char *title, double *vec, int n);
  80 void pr_block(FILE *fp, int indent, const char *title, t_block *block, gmx_bool bShowNumbers);
  81 GMX_LIBGMX_EXPORT
  82 void pr_blocka(FILE *fp, int indent, const char *title, t_blocka *block, gmx_bool bShowNumbers);
  83 void pr_ilist(FILE *fp, int indent, const char *title,
  84               t_functype *functype, t_ilist *ilist, gmx_bool bShowNumbers);
  85 GMX_LIBGMX_EXPORT
  86 void pr_iparams(FILE *fp, t_functype ftype, t_iparams *iparams);
  87 void pr_idef(FILE *fp, int indent, const char *title, t_idef *idef, gmx_bool bShowNumbers);
  88 GMX_LIBGMX_EXPORT
  89 void pr_inputrec(FILE *fp, int indent, const char *title, t_inputrec *ir,
  90                  gmx_bool bMDPformat);
  91 void pr_atoms(FILE *fp, int indent, const char *title, t_atoms *atoms,
  92               gmx_bool bShownumbers);
  93 void pr_atomtypes(FILE *fp, int indent, const char *title,
  94                   t_atomtypes *atomtypes, gmx_bool bShowNumbers);
  95 GMX_LIBGMX_EXPORT
  96 void pr_mtop(FILE *fp, int indent, const char *title, gmx_mtop_t *mtop,
  97              gmx_bool bShowNumbers);
  98 GMX_LIBGMX_EXPORT
  99 void pr_top(FILE *fp, int indent, const char *title, t_topology *top, gmx_bool bShowNumbers);
 100 /*
 101  * This routine prints out a (human) readable representation of
 102  * the topology to the file fp. Ident specifies the number of
 103  * spaces the text should be indented. Title is used to print a
 104  * header text.
 105  */
 106 GMX_LIBGMX_EXPORT
 107 void pr_header(FILE *fp, int indent, const char *title, t_tpxheader *sh);
 108 /*
 109  * This routine prints out a (human) readable representation of
 110  * a header to the file fp. Ident specifies the number of spaces
 111  * the text should be indented. Title is used to print a header text.
 112  */
 113
 114 void pr_commrec(FILE *fp, int indent, t_commrec *cr);
 115
 116 #ifdef __cplusplus
 117 }
 118 #endif
 119
 120 #endif  /* _txtdump_h */