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,2015,2016,2017,2018,2019, 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.
37 #ifndef GMX_MDLIB_FORCE_H
38 #define GMX_MDLIB_FORCE_H
40 #include "gromacs/math/arrayrefwithpadding.h"
41 #include "gromacs/math/vectypes.h"
42 #include "gromacs/utility/arrayref.h"
44 class DDBalanceRegionHandler;
46 struct gmx_enerdata_t;
49 struct gmx_grppairener_t;
50 struct gmx_localtop_t;
51 struct gmx_multisim_t;
69 class PpForceWorkload;
70 class ForceWithVirial;
74 void init_enerdata(int ngener, int n_lambda, gmx_enerdata_t *enerd);
75 /* Intializes the energy storage struct */
77 void destroy_enerdata(gmx_enerdata_t *enerd);
78 /* Free all memory associated with enerd */
80 void reset_foreign_enerdata(gmx_enerdata_t *enerd);
81 /* Resets only the foreign energy data */
83 void reset_enerdata(gmx_enerdata_t *enerd);
84 /* Resets the energy data */
86 void sum_epot(gmx_grppairener_t *grpp, real *epot);
87 /* Locally sum the non-bonded potential energy terms */
89 void sum_dhdl(gmx_enerdata_t *enerd, gmx::ArrayRef<const real> lambda, t_lambda *fepvals);
90 /* Sum the free energy contributions */
92 void do_force(FILE *log,
94 const gmx_multisim_t *ms,
95 const t_inputrec *inputrec,
97 gmx_enfrot *enforcedRotation,
100 gmx_wallcycle *wcycle,
101 // TODO top can be const when the group scheme no longer
102 // builds exclusions during neighbor searching within
103 // do_force_cutsGROUP.
105 const gmx_groups_t *groups,
107 gmx::ArrayRefWithPadding<gmx::RVec> coordinates,
109 gmx::ArrayRefWithPadding<gmx::RVec> force,
111 const t_mdatoms *mdatoms,
112 gmx_enerdata_t *enerd,
114 gmx::ArrayRef<real> lambda,
117 gmx::PpForceWorkload *ppForceWorkload,
118 const gmx_vsite_t *vsite,
123 const DDBalanceRegionHandler &ddBalanceRegionHandler);
125 /* Communicate coordinates (if parallel).
126 * Do neighbor searching (if necessary).
128 * Communicate forces (if parallel).
129 * Spread forces for vsites (if present).
131 * f is always required.
137 const gmx_groups_t *groups,
143 /* Call the neighborsearcher */
145 void do_force_lowlevel(t_forcerec *fr,
146 const t_inputrec *ir,
149 const gmx_multisim_t *ms,
151 gmx_wallcycle *wcycle,
156 gmx::ForceWithVirial *forceWithVirial,
157 gmx_enerdata_t *enerd,
162 const t_graph *graph,
163 const t_blocka *excl,
166 const DDBalanceRegionHandler &ddBalanceRegionHandler);
167 /* Call all the force routines */