src/gromacs/mdtypes/forcerec.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,2015,2016,2017 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #ifndef GMX_MDTYPES_TYPES_FORCEREC_H
  39 #define GMX_MDTYPES_TYPES_FORCEREC_H
  40
  41 #include <array>
  42 #include <memory>
  43 #include <vector>
  44
  45 #include "gromacs/math/vectypes.h"
  46 #include "gromacs/mdtypes/interaction_const.h"
  47 #include "gromacs/mdtypes/md_enums.h"
  48 #include "gromacs/pbcutil/pbc.h"
  49 #include "gromacs/utility/basedefinitions.h"
  50 #include "gromacs/utility/real.h"
  51
  52 /* Abstract type for PME that is defined only in the routine that use them. */
  53 struct gmx_ns_t;
  54 struct gmx_pme_t;
  55 struct nonbonded_verlet_t;
  56 struct bonded_threading_t;
  57 class DispersionCorrection;
  58 struct t_forcetable;
  59 struct t_QMMMrec;
  60
  61 namespace gmx
  62 {
  63 class GpuBonded;
  64 class ForceProviders;
  65 class StatePropagatorDataGpu;
  66 class PmePpCommGpu;
  67 } // namespace gmx
  68
  69 /* macros for the cginfo data in forcerec
  70  *
  71  * Since the tpx format support max 256 energy groups, we do the same here.
  72  * Note that we thus have bits 8-14 still unused.
  73  *
  74  * The maximum cg size in cginfo is 63
  75  * because we only have space for 6 bits in cginfo,
  76  * this cg size entry is actually only read with domain decomposition.
  77  */
  78 #define SET_CGINFO_GID(cgi, gid) (cgi) = (((cgi) & ~255) | (gid))
  79 #define GET_CGINFO_GID(cgi) ((cgi)&255)
  80 #define SET_CGINFO_FEP(cgi) (cgi) = ((cgi) | (1 << 15))
  81 #define GET_CGINFO_FEP(cgi) ((cgi) & (1 << 15))
  82 #define SET_CGINFO_EXCL_INTER(cgi) (cgi) = ((cgi) | (1 << 17))
  83 #define GET_CGINFO_EXCL_INTER(cgi) ((cgi) & (1 << 17))
  84 #define SET_CGINFO_CONSTR(cgi) (cgi) = ((cgi) | (1 << 20))
  85 #define GET_CGINFO_CONSTR(cgi) ((cgi) & (1 << 20))
  86 #define SET_CGINFO_SETTLE(cgi) (cgi) = ((cgi) | (1 << 21))
  87 #define GET_CGINFO_SETTLE(cgi) ((cgi) & (1 << 21))
  88 /* This bit is only used with bBondComm in the domain decomposition */
  89 #define SET_CGINFO_BOND_INTER(cgi) (cgi) = ((cgi) | (1 << 22))
  90 #define GET_CGINFO_BOND_INTER(cgi) ((cgi) & (1 << 22))
  91 #define SET_CGINFO_HAS_VDW(cgi) (cgi) = ((cgi) | (1 << 23))
  92 #define GET_CGINFO_HAS_VDW(cgi) ((cgi) & (1 << 23))
  93 #define SET_CGINFO_HAS_Q(cgi) (cgi) = ((cgi) | (1 << 24))
  94 #define GET_CGINFO_HAS_Q(cgi) ((cgi) & (1 << 24))
  95
  96
  97 /* Value to be used in mdrun for an infinite cut-off.
  98  * Since we need to compare with the cut-off squared,
  99  * this value should be slighlty smaller than sqrt(GMX_FLOAT_MAX).
 100  */
 101 #define GMX_CUTOFF_INF 1E+18
 102
 103 /* enums for the neighborlist type */
 104 enum
 105 {
 106     enbvdwNONE,
 107     enbvdwLJ,
 108     enbvdwBHAM,
 109     enbvdwTAB,
 110     enbvdwNR
 111 };
 112
 113 struct cginfo_mb_t
 114 {
 115     int              cg_start = 0;
 116     int              cg_end   = 0;
 117     int              cg_mod   = 0;
 118     std::vector<int> cginfo;
 119 };
 120
 121
 122 /* Forward declaration of type for managing Ewald tables */
 123 struct gmx_ewald_tab_t;
 124
 125 struct ewald_corr_thread_t;
 126
 127 struct t_forcerec
 128 { // NOLINT (clang-analyzer-optin.performance.Padding)
 129     // Declare an explicit constructor and destructor, so they can be
 130     // implemented in a single source file, so that not every source
 131     // file that includes this one needs to understand how to find the
 132     // destructors of the objects pointed to by unique_ptr members.
 133     t_forcerec();
 134     ~t_forcerec();
 135
 136     struct interaction_const_t* ic = nullptr;
 137
 138     /* PBC stuff */
 139     PbcType pbcType = PbcType::Xyz;
 140     //! Tells whether atoms inside a molecule can be in different periodic images,
 141     //  i.e. whether we need to take into account PBC when computing distances inside molecules.
 142     //  This determines whether PBC must be considered for e.g. bonded interactions.
 143     gmx_bool bMolPBC     = FALSE;
 144     int      rc_scaling  = 0;
 145     rvec     posres_com  = { 0 };
 146     rvec     posres_comB = { 0 };
 147
 148     gmx_bool use_simd_kernels = FALSE;
 149
 150     /* Interaction for calculated in kernels. In many cases this is similar to
 151      * the electrostatics settings in the inputrecord, but the difference is that
 152      * these variables always specify the actual interaction in the kernel - if
 153      * we are tabulating reaction-field the inputrec will say reaction-field, but
 154      * the kernel interaction will say cubic-spline-table. To be safe we also
 155      * have a kernel-specific setting for the modifiers - if the interaction is
 156      * tabulated we already included the inputrec modification there, so the kernel
 157      * modification setting will say 'none' in that case.
 158      */
 159     int nbkernel_elec_interaction = 0;
 160     int nbkernel_vdw_interaction  = 0;
 161     int nbkernel_elec_modifier    = 0;
 162     int nbkernel_vdw_modifier     = 0;
 163
 164     /* Cut-Off stuff.
 165      * Infinite cut-off's will be GMX_CUTOFF_INF (unlike in t_inputrec: 0).
 166      */
 167     real rlist = 0;
 168
 169     /* Charge sum and dipole for topology A/B ([0]/[1]) for Ewald corrections */
 170     double qsum[2]   = { 0 };
 171     double q2sum[2]  = { 0 };
 172     double c6sum[2]  = { 0 };
 173     rvec   mu_tot[2] = { { 0 } };
 174
 175     /* Dispersion correction stuff */
 176     std::unique_ptr<DispersionCorrection> dispersionCorrection;
 177
 178     /* Fudge factors */
 179     real fudgeQQ = 0;
 180
 181     /* Table stuff */
 182     gmx_bool bcoultab = FALSE;
 183     gmx_bool bvdwtab  = FALSE;
 184
 185     t_forcetable* pairsTable = nullptr; /* for 1-4 interactions, [pairs] and [pairs_nb] */
 186
 187     /* Free energy */
 188     int  efep          = 0;
 189     real sc_alphavdw   = 0;
 190     real sc_alphacoul  = 0;
 191     int  sc_power      = 0;
 192     real sc_r_power    = 0;
 193     real sc_sigma6_def = 0;
 194     real sc_sigma6_min = 0;
 195
 196     /* Information about atom properties for the molecule blocks in the system */
 197     std::vector<cginfo_mb_t> cginfo_mb;
 198     /* Information about atom properties for local and non-local atoms */
 199     std::vector<int> cginfo;
 200
 201     rvec* shift_vec = nullptr;
 202
 203     int      cutoff_scheme = 0;     /* group- or Verlet-style cutoff */
 204     gmx_bool bNonbonded    = FALSE; /* true if nonbonded calculations are *not* turned off */
 205
 206     /* The Nbnxm Verlet non-bonded machinery */
 207     std::unique_ptr<nonbonded_verlet_t> nbv;
 208
 209     /* The wall tables (if used) */
 210     int             nwall    = 0;
 211     t_forcetable*** wall_tab = nullptr;
 212
 213     /* The number of atoms participating in do_force_lowlevel */
 214     int natoms_force = 0;
 215     /* The number of atoms participating in force and constraints */
 216     int natoms_force_constr = 0;
 217     /* The allocation size of vectors of size natoms_force */
 218     int nalloc_force = 0;
 219
 220     /* Forces that should not enter into the coord x force virial summation:
 221      * PPPM/PME/Ewald/posres/ForceProviders
 222      */
 223     /* True when we have contributions that are directly added to the virial */
 224     bool haveDirectVirialContributions = false;
 225     /* Force buffer for force computation with direct virial contributions */
 226     std::vector<gmx::RVec> forceBufferForDirectVirialContributions;
 227
 228     /* Data for PPPM/PME/Ewald */
 229     struct gmx_pme_t* pmedata                = nullptr;
 230     int               ljpme_combination_rule = 0;
 231
 232     /* PME/Ewald stuff */
 233     struct gmx_ewald_tab_t* ewald_table = nullptr;
 234
 235     /* Shift force array for computing the virial, size SHIFTS */
 236     std::vector<gmx::RVec> shiftForces;
 237
 238     /* Non bonded Parameter lists */
 239     int               ntype = 0; /* Number of atom types */
 240     gmx_bool          bBHAM = FALSE;
 241     std::vector<real> nbfp;
 242     real*             ljpme_c6grid = nullptr; /* C6-values used on grid in LJPME */
 243
 244     /* Energy group pair flags */
 245     int* egp_flags = nullptr;
 246
 247     /* Shell molecular dynamics flexible constraints */
 248     real fc_stepsize = 0;
 249
 250     /* If > 0 signals Test Particle Insertion,
 251      * the value is the number of atoms of the molecule to insert
 252      * Only the energy difference due to the addition of the last molecule
 253      * should be calculated.
 254      */
 255     int n_tpi = 0;
 256
 257     /* QMMM stuff */
 258     gmx_bool          bQMMM = FALSE;
 259     struct t_QMMMrec* qr    = nullptr;
 260
 261     /* QM-MM neighborlists */
 262     struct t_nblist* QMMMlist = nullptr;
 263
 264     /* Limit for printing large forces, negative is don't print */
 265     real print_force = 0;
 266
 267     /* User determined parameters, copied from the inputrec */
 268     int  userint1  = 0;
 269     int  userint2  = 0;
 270     int  userint3  = 0;
 271     int  userint4  = 0;
 272     real userreal1 = 0;
 273     real userreal2 = 0;
 274     real userreal3 = 0;
 275     real userreal4 = 0;
 276
 277     /* Pointer to struct for managing threading of bonded force calculation */
 278     struct bonded_threading_t* bondedThreading = nullptr;
 279
 280     /* TODO: Replace the pointer by an object once we got rid of C */
 281     gmx::GpuBonded* gpuBonded = nullptr;
 282
 283     /* Ewald correction thread local virial and energy data */
 284     int                         nthread_ewc = 0;
 285     struct ewald_corr_thread_t* ewc_t       = nullptr;
 286
 287     gmx::ForceProviders* forceProviders = nullptr;
 288
 289     // The stateGpu object is created in runner, forcerec just keeps the copy of the pointer.
 290     // TODO: This is not supposed to be here. StatePropagatorDataGpu should be a part of
 291     //       general StatePropagatorData object that is passed around
 292     gmx::StatePropagatorDataGpu* stateGpu = nullptr;
 293
 294     /* For PME-PP GPU communication */
 295     std::unique_ptr<gmx::PmePpCommGpu> pmePpCommGpu;
 296 };
 297
 298 /* Important: Starting with Gromacs-4.6, the values of c6 and c12 in the nbfp array have
 299  * been scaled by 6.0 or 12.0 to save flops in the kernels. We have corrected this everywhere
 300  * in the code, but beware if you are using these macros externally.
 301  */
 302 #define C6(nbfp, ntp, ai, aj) (nbfp)[2 * ((ntp) * (ai) + (aj))]
 303 #define C12(nbfp, ntp, ai, aj) (nbfp)[2 * ((ntp) * (ai) + (aj)) + 1]
 304 #define BHAMC(nbfp, ntp, ai, aj) (nbfp)[3 * ((ntp) * (ai) + (aj))]
 305 #define BHAMA(nbfp, ntp, ai, aj) (nbfp)[3 * ((ntp) * (ai) + (aj)) + 1]
 306 #define BHAMB(nbfp, ntp, ai, aj) (nbfp)[3 * ((ntp) * (ai) + (aj)) + 2]
 307
 308 #endif