Update user documentation overview
[alexxy/gromacs.git] / src / gromacs / mdtypes / enerdata.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2018, by the GROMACS development team, led by
5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6  * and including many others, as listed in the AUTHORS file in the
7  * top-level source directory and at http://www.gromacs.org.
8  *
9  * GROMACS is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public License
11  * as published by the Free Software Foundation; either version 2.1
12  * of the License, or (at your option) any later version.
13  *
14  * GROMACS is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with GROMACS; if not, see
21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
23  *
24  * If you want to redistribute modifications to GROMACS, please
25  * consider that scientific software is very special. Version
26  * control is crucial - bugs must be traceable. We will be happy to
27  * consider code for inclusion in the official distribution, but
28  * derived work must not be called official GROMACS. Details are found
29  * in the README & COPYING files - if they are missing, get the
30  * official version at http://www.gromacs.org.
31  *
32  * To help us fund GROMACS development, we humbly ask that you cite
33  * the research papers on the package. Check out http://www.gromacs.org.
34  */
35 #ifndef GMX_MDTYPES_TYPES_ENERDATA_H
36 #define GMX_MDTYPES_TYPES_ENERDATA_H
37
38 #include "gromacs/mdtypes/md_enums.h"
39 #include "gromacs/topology/idef.h"
40 #include "gromacs/utility/real.h"
41
42 enum {
43     egCOULSR, egLJSR, egBHAMSR,
44     egCOUL14, egLJ14, egNR
45 };
46
47 struct gmx_grppairener_t
48 {
49     int   nener;      /* The number of energy group pairs     */
50     real *ener[egNR]; /* Energy terms for each pair of groups */
51 };
52
53 struct gmx_enerdata_t
54 {
55     real                     term[F_NRE];         /* The energies for all different interaction types */
56     struct gmx_grppairener_t grpp;
57     double                   dvdl_lin[efptNR];    /* Contributions to dvdl with linear lam-dependence */
58     double                   dvdl_nonlin[efptNR]; /* Idem, but non-linear dependence                  */
59     int                      n_lambda;
60     int                      fep_state;           /*current fep state -- just for printing */
61     double                  *enerpart_lambda;     /* Partial energy for lambda and flambda[] */
62     real                     foreign_term[F_NRE]; /* alternate array for storing foreign lambda energies */
63     struct gmx_grppairener_t foreign_grpp;        /* alternate array for storing foreign lambda energies */
64 };
65
66 #endif