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_MDTYPES_TYPES_FORCEREC_H
38 #define GMX_MDTYPES_TYPES_FORCEREC_H
44 #include "gromacs/math/vectypes.h"
45 #include "gromacs/mdtypes/interaction_const.h"
46 #include "gromacs/mdtypes/md_enums.h"
47 #include "gromacs/utility/basedefinitions.h"
48 #include "gromacs/utility/real.h"
50 /* Abstract type for PME that is defined only in the routine that use them. */
53 struct nonbonded_verlet_t
;
54 struct bonded_threading_t
;
55 class DispersionCorrection
;
63 class StatePropagatorDataGpu
;
66 /* macros for the cginfo data in forcerec
68 * Since the tpx format support max 256 energy groups, we do the same here.
69 * Note that we thus have bits 8-14 still unused.
71 * The maximum cg size in cginfo is 63
72 * because we only have space for 6 bits in cginfo,
73 * this cg size entry is actually only read with domain decomposition.
75 #define SET_CGINFO_GID(cgi, gid) (cgi) = (((cgi) & ~255) | (gid))
76 #define GET_CGINFO_GID(cgi) ( (cgi) & 255)
77 #define SET_CGINFO_FEP(cgi) (cgi) = ((cgi) | (1<<15))
78 #define GET_CGINFO_FEP(cgi) ( (cgi) & (1<<15))
79 #define SET_CGINFO_EXCL_INTER(cgi) (cgi) = ((cgi) | (1<<17))
80 #define GET_CGINFO_EXCL_INTER(cgi) ( (cgi) & (1<<17))
81 #define SET_CGINFO_CONSTR(cgi) (cgi) = ((cgi) | (1<<20))
82 #define GET_CGINFO_CONSTR(cgi) ( (cgi) & (1<<20))
83 #define SET_CGINFO_SETTLE(cgi) (cgi) = ((cgi) | (1<<21))
84 #define GET_CGINFO_SETTLE(cgi) ( (cgi) & (1<<21))
85 /* This bit is only used with bBondComm in the domain decomposition */
86 #define SET_CGINFO_BOND_INTER(cgi) (cgi) = ((cgi) | (1<<22))
87 #define GET_CGINFO_BOND_INTER(cgi) ( (cgi) & (1<<22))
88 #define SET_CGINFO_HAS_VDW(cgi) (cgi) = ((cgi) | (1<<23))
89 #define GET_CGINFO_HAS_VDW(cgi) ( (cgi) & (1<<23))
90 #define SET_CGINFO_HAS_Q(cgi) (cgi) = ((cgi) | (1<<24))
91 #define GET_CGINFO_HAS_Q(cgi) ( (cgi) & (1<<24))
94 /* Value to be used in mdrun for an infinite cut-off.
95 * Since we need to compare with the cut-off squared,
96 * this value should be slighlty smaller than sqrt(GMX_FLOAT_MAX).
98 #define GMX_CUTOFF_INF 1E+18
100 /* enums for the neighborlist type */
102 enbvdwNONE
, enbvdwLJ
, enbvdwBHAM
, enbvdwTAB
, enbvdwNR
114 /* Forward declaration of type for managing Ewald tables */
115 struct gmx_ewald_tab_t
;
117 struct ewald_corr_thread_t
;
119 struct t_forcerec
{ // NOLINT (clang-analyzer-optin.performance.Padding)
120 struct interaction_const_t
*ic
= nullptr;
124 //! Tells whether atoms inside a molecule can be in different periodic images,
125 // i.e. whether we need to take into account PBC when computing distances inside molecules.
126 // This determines whether PBC must be considered for e.g. bonded interactions.
127 gmx_bool bMolPBC
= FALSE
;
129 rvec posres_com
= { 0 };
130 rvec posres_comB
= { 0 };
132 gmx_bool use_simd_kernels
= FALSE
;
134 /* Interaction for calculated in kernels. In many cases this is similar to
135 * the electrostatics settings in the inputrecord, but the difference is that
136 * these variables always specify the actual interaction in the kernel - if
137 * we are tabulating reaction-field the inputrec will say reaction-field, but
138 * the kernel interaction will say cubic-spline-table. To be safe we also
139 * have a kernel-specific setting for the modifiers - if the interaction is
140 * tabulated we already included the inputrec modification there, so the kernel
141 * modification setting will say 'none' in that case.
143 int nbkernel_elec_interaction
= 0;
144 int nbkernel_vdw_interaction
= 0;
145 int nbkernel_elec_modifier
= 0;
146 int nbkernel_vdw_modifier
= 0;
149 * Infinite cut-off's will be GMX_CUTOFF_INF (unlike in t_inputrec: 0).
153 /* Charge sum and dipole for topology A/B ([0]/[1]) for Ewald corrections */
154 double qsum
[2] = { 0 };
155 double q2sum
[2] = { 0 };
156 double c6sum
[2] = { 0 };
157 rvec mu_tot
[2] = { { 0 } };
159 /* Dispersion correction stuff */
160 std::unique_ptr
<DispersionCorrection
> dispersionCorrection
;
166 gmx_bool bcoultab
= FALSE
;
167 gmx_bool bvdwtab
= FALSE
;
169 t_forcetable
*pairsTable
= nullptr; /* for 1-4 interactions, [pairs] and [pairs_nb] */
173 real sc_alphavdw
= 0;
174 real sc_alphacoul
= 0;
177 real sc_sigma6_def
= 0;
178 real sc_sigma6_min
= 0;
180 /* Information about atom properties for the molecule blocks in the system */
181 struct cginfo_mb_t
*cginfo_mb
= nullptr;
182 /* Information about atom properties for local and non-local atoms */
183 std::vector
<int> cginfo
;
185 rvec
*shift_vec
= nullptr;
187 int cutoff_scheme
= 0; /* group- or Verlet-style cutoff */
188 gmx_bool bNonbonded
= FALSE
; /* true if nonbonded calculations are *not* turned off */
190 /* The Nbnxm Verlet non-bonded machinery */
191 std::unique_ptr
<nonbonded_verlet_t
> nbv
;
193 /* The wall tables (if used) */
195 t_forcetable
***wall_tab
= nullptr;
197 /* The number of atoms participating in do_force_lowlevel */
198 int natoms_force
= 0;
199 /* The number of atoms participating in force and constraints */
200 int natoms_force_constr
= 0;
201 /* The allocation size of vectors of size natoms_force */
202 int nalloc_force
= 0;
204 /* Forces that should not enter into the coord x force virial summation:
205 * PPPM/PME/Ewald/posres/ForceProviders
207 /* True when we have contributions that are directly added to the virial */
208 bool haveDirectVirialContributions
= false;
209 /* Force buffer for force computation with direct virial contributions */
210 std::vector
<gmx::RVec
> forceBufferForDirectVirialContributions
;
212 /* Data for PPPM/PME/Ewald */
213 struct gmx_pme_t
*pmedata
= nullptr;
214 int ljpme_combination_rule
= 0;
216 /* PME/Ewald stuff */
217 struct gmx_ewald_tab_t
*ewald_table
= nullptr;
219 /* Shift force array for computing the virial, size SHIFTS */
220 std::vector
<gmx::RVec
> shiftForces
;
222 /* Non bonded Parameter lists */
223 int ntype
= 0; /* Number of atom types */
224 gmx_bool bBHAM
= FALSE
;
225 real
*nbfp
= nullptr;
226 real
*ljpme_c6grid
= nullptr; /* C6-values used on grid in LJPME */
228 /* Energy group pair flags */
229 int *egp_flags
= nullptr;
231 /* Shell molecular dynamics flexible constraints */
232 real fc_stepsize
= 0;
234 /* If > 0 signals Test Particle Insertion,
235 * the value is the number of atoms of the molecule to insert
236 * Only the energy difference due to the addition of the last molecule
237 * should be calculated.
242 gmx_bool bQMMM
= FALSE
;
243 struct t_QMMMrec
*qr
= nullptr;
245 /* QM-MM neighborlists */
246 struct t_nblist
*QMMMlist
= nullptr;
248 /* Limit for printing large forces, negative is don't print */
249 real print_force
= 0;
251 /* User determined parameters, copied from the inputrec */
261 /* Pointer to struct for managing threading of bonded force calculation */
262 struct bonded_threading_t
*bondedThreading
= nullptr;
264 /* TODO: Replace the pointer by an object once we got rid of C */
265 gmx::GpuBonded
*gpuBonded
= nullptr;
267 /* Ewald correction thread local virial and energy data */
269 struct ewald_corr_thread_t
*ewc_t
= nullptr;
271 gmx::ForceProviders
*forceProviders
= nullptr;
273 // The stateGpu object is created in runner, forcerec just keeps the copy of the pointer.
274 // TODO: This is not supposed to be here. StatePropagatorDataGpu should be a part of
275 // general StatePropagatorData object that is passed around
276 gmx::StatePropagatorDataGpu
*stateGpu
= nullptr;
279 /* Important: Starting with Gromacs-4.6, the values of c6 and c12 in the nbfp array have
280 * been scaled by 6.0 or 12.0 to save flops in the kernels. We have corrected this everywhere
281 * in the code, but beware if you are using these macros externally.
283 #define C6(nbfp, ntp, ai, aj) (nbfp)[2*((ntp)*(ai)+(aj))]
284 #define C12(nbfp, ntp, ai, aj) (nbfp)[2*((ntp)*(ai)+(aj))+1]
285 #define BHAMC(nbfp, ntp, ai, aj) (nbfp)[3*((ntp)*(ai)+(aj))]
286 #define BHAMA(nbfp, ntp, ai, aj) (nbfp)[3*((ntp)*(ai)+(aj))+1]
287 #define BHAMB(nbfp, ntp, ai, aj) (nbfp)[3*((ntp)*(ai)+(aj))+2]