2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
44 #include "../fileio/enxio.h"
51 /* This is a running averaging structure ('energy bin') for use during mdrun. */
58 gmx_int64_t nsteps_sim;
64 eprNORMAL, eprAVER, eprRMS, eprNR
67 t_ebin *mk_ebin(void);
68 /* Create an energy bin */
70 int get_ebin_space(t_ebin *eb, int nener, const char *enm[], const char *unit);
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
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
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.
91 void reset_ebin_sums(t_ebin *eb);
92 /* Reset the average and fluctuation sums */
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.