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