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