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