include/ebin.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 _ebin_h
  40 #define _ebin_h
  41
  42 #include "sysstuff.h"
  43 #include "typedefs.h"
  44 #include "enxio.h"
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50
  51 /* This is a running averaging structure ('energy bin') for use during mdrun. */
  52 typedef struct {
  53     int             nener;
  54     gmx_enxnm_t    *enm;
  55     gmx_large_int_t nsteps;
  56     gmx_large_int_t nsum;
  57     t_energy       *e;
  58     gmx_large_int_t nsteps_sim;
  59     gmx_large_int_t nsum_sim;
  60     t_energy       *e_sim;
  61 } t_ebin;
  62
  63 enum {
  64     eprNORMAL, eprAVER, eprRMS, eprNR
  65 };
  66
  67 t_ebin *mk_ebin(void);
  68 /* Create an energy bin */
  69
  70 int get_ebin_space(t_ebin *eb, int nener, const char *enm[], const char *unit);
  71
  72 /* Create space in the energy bin and register names.
  73  * The enm array must be static, because the contents are not copied,
  74  * but only the pointers.
  75  * Function returns an index number that must be used in subsequent
  76  * calls to add_ebin.
  77  */
  78
  79 void add_ebin(t_ebin *eb, int index, int nener, real ener[], gmx_bool bSum);
  80 /* Add nener reals (eg. energies, box-lengths, pressures) to the
  81  * energy bin at position index.
  82  * If bSum is TRUE then the reals are also added to the sum
  83  * and sum of squares.
  84  */
  85
  86 void ebin_increase_count(t_ebin *eb, gmx_bool bSum);
  87 /* Increase the counters for the sums.
  88  * This routine should be called AFTER all add_ebin calls for this step.
  89  */
  90
  91 void reset_ebin_sums(t_ebin *eb);
  92 /* Reset the average and fluctuation sums */
  93
  94 void pr_ebin(FILE *fp, t_ebin *eb, int index, int nener, int nperline,
  95              int prmode, gmx_bool bPrHead);
  96 /* Print the contents of the energy bin. If nener = -1 ALL energies from
  97  * index to the end will be printed. We will print nperline entries on a text
  98  * line (advisory <= 5). prmode may be any of the above listed enum values.
  99  * tsteps is used only when eprAVER or eprRMS is set.
 100  * If bPrHead than the header is printed.
 101  */
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #endif  /* _ebin_h */