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,2018, 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.
  10  *
  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.
  15  *
  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.
  20  *
  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.
  25  *
  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.
  33  *
  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.
  36  */
  37 #ifndef GMX_MDTYPES_TYPES_FORCEREC_H
  38 #define GMX_MDTYPES_TYPES_FORCEREC_H
  39
  40 #include "gromacs/math/vectypes.h"
  41 #ifdef __cplusplus
  42 #include "gromacs/math/paddedvector.h"
  43 #endif
  44 #include "gromacs/mdtypes/interaction_const.h"
  45 #include "gromacs/mdtypes/md_enums.h"
  46 #include "gromacs/topology/idef.h"
  47 #include "gromacs/utility/basedefinitions.h"
  48 #include "gromacs/utility/real.h"
  49
  50 struct ForceProviders;
  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 struct t_forcetable;
  58 struct t_nblist;
  59 struct t_nblists;
  60 struct t_QMMMrec;
  61
  62 #ifdef __cplusplus
  63 extern "C" {
  64 #endif
  65
  66 /* macros for the cginfo data in forcerec
  67  *
  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.
  70  *
  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.
  74  * But there is a smaller limit due to the t_excl data structure
  75  * which is defined in nblist.h.
  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_INTRA(cgi)   (cgi) =  ((cgi)  |  (1<<16))
  82 #define GET_CGINFO_EXCL_INTRA(cgi) ( (cgi)            &  (1<<16))
  83 #define SET_CGINFO_EXCL_INTER(cgi)   (cgi) =  ((cgi)  |  (1<<17))
  84 #define GET_CGINFO_EXCL_INTER(cgi) ( (cgi)            &  (1<<17))
  85 #define SET_CGINFO_SOLOPT(cgi, opt)  (cgi) = (((cgi)  & ~(3<<18)) | ((opt)<<18))
  86 #define GET_CGINFO_SOLOPT(cgi)     (((cgi)>>18)       &   3)
  87 #define SET_CGINFO_CONSTR(cgi)       (cgi) =  ((cgi)  |  (1<<20))
  88 #define GET_CGINFO_CONSTR(cgi)     ( (cgi)            &  (1<<20))
  89 #define SET_CGINFO_SETTLE(cgi)       (cgi) =  ((cgi)  |  (1<<21))
  90 #define GET_CGINFO_SETTLE(cgi)     ( (cgi)            &  (1<<21))
  91 /* This bit is only used with bBondComm in the domain decomposition */
  92 #define SET_CGINFO_BOND_INTER(cgi)   (cgi) =  ((cgi)  |  (1<<22))
  93 #define GET_CGINFO_BOND_INTER(cgi) ( (cgi)            &  (1<<22))
  94 #define SET_CGINFO_HAS_VDW(cgi)      (cgi) =  ((cgi)  |  (1<<23))
  95 #define GET_CGINFO_HAS_VDW(cgi)    ( (cgi)            &  (1<<23))
  96 #define SET_CGINFO_HAS_Q(cgi)        (cgi) =  ((cgi)  |  (1<<24))
  97 #define GET_CGINFO_HAS_Q(cgi)      ( (cgi)            &  (1<<24))
  98 #define SET_CGINFO_NATOMS(cgi, opt)  (cgi) = (((cgi)  & ~(63<<25)) | ((opt)<<25))
  99 #define GET_CGINFO_NATOMS(cgi)     (((cgi)>>25)       &   63)
 100
 101
 102 /* Value to be used in mdrun for an infinite cut-off.
 103  * Since we need to compare with the cut-off squared,
 104  * this value should be slighlty smaller than sqrt(GMX_FLOAT_MAX).
 105  */
 106 #define GMX_CUTOFF_INF 1E+18
 107
 108 /* enums for the neighborlist type */
 109 enum {
 110     enbvdwNONE, enbvdwLJ, enbvdwBHAM, enbvdwTAB, enbvdwNR
 111 };
 112
 113 enum {
 114     egCOULSR, egLJSR, egBHAMSR,
 115     egCOUL14, egLJ14, egNR
 116 };
 117 extern const char *egrp_nm[egNR+1];
 118
 119 struct gmx_grppairener_t
 120 {
 121     int   nener;      /* The number of energy group pairs     */
 122     real *ener[egNR]; /* Energy terms for each pair of groups */
 123 };
 124
 125 struct gmx_enerdata_t
 126 {
 127     real                     term[F_NRE];         /* The energies for all different interaction types */
 128     struct gmx_grppairener_t grpp;
 129     double                   dvdl_lin[efptNR];    /* Contributions to dvdl with linear lam-dependence */
 130     double                   dvdl_nonlin[efptNR]; /* Idem, but non-linear dependence                  */
 131     int                      n_lambda;
 132     int                      fep_state;           /*current fep state -- just for printing */
 133     double                  *enerpart_lambda;     /* Partial energy for lambda and flambda[] */
 134     real                     foreign_term[F_NRE]; /* alternate array for storing foreign lambda energies */
 135     struct gmx_grppairener_t foreign_grpp;        /* alternate array for storing foreign lambda energies */
 136 };
 137 /* The idea is that dvdl terms with linear lambda dependence will be added
 138  * automatically to enerpart_lambda. Terms with non-linear lambda dependence
 139  * should explicitly determine the energies at foreign lambda points
 140  * when n_lambda > 0.
 141  */
 142
 143 struct cginfo_mb_t
 144 {
 145     int  cg_start;
 146     int  cg_end;
 147     int  cg_mod;
 148     int *cginfo;
 149 };
 150
 151
 152 /* Forward declaration of type for managing Ewald tables */
 153 struct gmx_ewald_tab_t;
 154
 155 struct ewald_corr_thread_t;
 156
 157 struct t_forcerec {
 158     struct interaction_const_t *ic;
 159
 160     /* PBC stuff */
 161     int                         ePBC;
 162     //! Whether PBC must be considered for bonded interactions.
 163     gmx_bool                    bMolPBC;
 164     int                         rc_scaling;
 165     rvec                        posres_com;
 166     rvec                        posres_comB;
 167
 168     gmx_bool                    use_simd_kernels;
 169
 170     /* Interaction for calculated in kernels. In many cases this is similar to
 171      * the electrostatics settings in the inputrecord, but the difference is that
 172      * these variables always specify the actual interaction in the kernel - if
 173      * we are tabulating reaction-field the inputrec will say reaction-field, but
 174      * the kernel interaction will say cubic-spline-table. To be safe we also
 175      * have a kernel-specific setting for the modifiers - if the interaction is
 176      * tabulated we already included the inputrec modification there, so the kernel
 177      * modification setting will say 'none' in that case.
 178      */
 179     int nbkernel_elec_interaction;
 180     int nbkernel_vdw_interaction;
 181     int nbkernel_elec_modifier;
 182     int nbkernel_vdw_modifier;
 183
 184     /* Use special N*N kernels? */
 185     gmx_bool bAllvsAll;
 186     /* Private work data */
 187     void    *AllvsAll_work;
 188
 189     /* Cut-Off stuff.
 190      * Infinite cut-off's will be GMX_CUTOFF_INF (unlike in t_inputrec: 0).
 191      */
 192     real rlist;
 193
 194     /* Parameters for generalized reaction field */
 195     real zsquare, temp;
 196
 197     /* Charge sum and dipole for topology A/B ([0]/[1]) for Ewald corrections */
 198     double qsum[2];
 199     double q2sum[2];
 200     double c6sum[2];
 201     rvec   mu_tot[2];
 202
 203     /* Dispersion correction stuff */
 204     int                  eDispCorr;
 205     int                  numAtomsForDispersionCorrection;
 206     struct t_forcetable *dispersionCorrectionTable;
 207
 208     /* The shift of the shift or user potentials */
 209     real enershiftsix;
 210     real enershifttwelve;
 211     /* Integrated differces for energy and virial with cut-off functions */
 212     real enerdiffsix;
 213     real enerdifftwelve;
 214     real virdiffsix;
 215     real virdifftwelve;
 216     /* Constant for long range dispersion correction (average dispersion)
 217      * for topology A/B ([0]/[1]) */
 218     real avcsix[2];
 219     /* Constant for long range repulsion term. Relative difference of about
 220      * 0.1 percent with 0.8 nm cutoffs. But hey, it's cheap anyway...
 221      */
 222     real avctwelve[2];
 223
 224     /* Fudge factors */
 225     real fudgeQQ;
 226
 227     /* Table stuff */
 228     gmx_bool             bcoultab;
 229     gmx_bool             bvdwtab;
 230     /* The normal tables are in the nblists struct(s) below */
 231
 232     struct t_forcetable *pairsTable; /* for 1-4 interactions, [pairs] and [pairs_nb] */
 233
 234     /* Free energy */
 235     int      efep;
 236     real     sc_alphavdw;
 237     real     sc_alphacoul;
 238     int      sc_power;
 239     real     sc_r_power;
 240     real     sc_sigma6_def;
 241     real     sc_sigma6_min;
 242
 243     /* NS Stuff */
 244     int  cg0, hcg;
 245     /* solvent_opt contains the enum for the most common solvent
 246      * in the system, which will be optimized.
 247      * It can be set to esolNO to disable all water optimization */
 248     int                 solvent_opt;
 249     int                 nWatMol;
 250     gmx_bool            bGrid;
 251     gmx_bool            bExcl_IntraCGAll_InterCGNone;
 252     struct cginfo_mb_t *cginfo_mb;
 253     int                *cginfo;
 254     rvec               *cg_cm;
 255     int                 cg_nalloc;
 256     rvec               *shift_vec;
 257
 258     /* The neighborlists including tables */
 259     int                        nnblists;
 260     int                       *gid2nblists;
 261     struct t_nblists          *nblists;
 262
 263     int                        cutoff_scheme; /* group- or Verlet-style cutoff */
 264     gmx_bool                   bNonbonded;    /* true if nonbonded calculations are *not* turned off */
 265     struct nonbonded_verlet_t *nbv;
 266
 267     /* The wall tables (if used) */
 268     int                    nwall;
 269     struct t_forcetable ***wall_tab;
 270
 271     /* The number of charge groups participating in do_force_lowlevel */
 272     int ncg_force;
 273     /* The number of atoms participating in do_force_lowlevel */
 274     int natoms_force;
 275     /* The number of atoms participating in force and constraints */
 276     int natoms_force_constr;
 277     /* The allocation size of vectors of size natoms_force */
 278     int nalloc_force;
 279
 280     /* Forces that should not enter into the coord x force virial summation:
 281      * PPPM/PME/Ewald/posres/ForceProviders
 282      */
 283     /* True when we have contributions that are directly added to the virial */
 284     gmx_bool          haveDirectVirialContributions;
 285 #ifdef __cplusplus
 286     /* TODO: Replace the pointer by an object once we got rid of C */
 287     std::vector<gmx::RVec>  *forceBufferForDirectVirialContributions;
 288 #else
 289     void                    *forceBufferForDirectVirialContributions_dummy;
 290 #endif
 291
 292     /* Data for PPPM/PME/Ewald */
 293     struct gmx_pme_t *pmedata;
 294     int               ljpme_combination_rule;
 295
 296     /* PME/Ewald stuff */
 297     struct gmx_ewald_tab_t *ewald_table;
 298
 299     /* Virial Stuff */
 300     rvec *fshift;
 301     dvec  vir_wall_z;
 302
 303     /* Non bonded Parameter lists */
 304     int      ntype; /* Number of atom types */
 305     gmx_bool bBHAM;
 306     real    *nbfp;
 307     real    *ljpme_c6grid; /* C6-values used on grid in LJPME */
 308
 309     /* Energy group pair flags */
 310     int *egp_flags;
 311
 312     /* Shell molecular dynamics flexible constraints */
 313     real fc_stepsize;
 314
 315     /* If > 0 signals Test Particle Insertion,
 316      * the value is the number of atoms of the molecule to insert
 317      * Only the energy difference due to the addition of the last molecule
 318      * should be calculated.
 319      */
 320     gmx_bool n_tpi;
 321
 322     /* Neighbor searching stuff */
 323     struct gmx_ns_t *ns;
 324
 325     /* QMMM stuff */
 326     gmx_bool          bQMMM;
 327     struct t_QMMMrec *qr;
 328
 329     /* QM-MM neighborlists */
 330     struct t_nblist        *QMMMlist;
 331
 332     /* Limit for printing large forces, negative is don't print */
 333     real print_force;
 334
 335     /* coarse load balancing time measurement */
 336     double t_fnbf;
 337     double t_wait;
 338     int    timesteps;
 339
 340     /* User determined parameters, copied from the inputrec */
 341     int  userint1;
 342     int  userint2;
 343     int  userint3;
 344     int  userint4;
 345     real userreal1;
 346     real userreal2;
 347     real userreal3;
 348     real userreal4;
 349
 350     /* Pointer to struct for managing threading of bonded force calculation */
 351     struct bonded_threading_t *bondedThreading;
 352
 353     /* Ewald correction thread local virial and energy data */
 354     int                         nthread_ewc;
 355     struct ewald_corr_thread_t *ewc_t;
 356
 357     struct ForceProviders      *forceProviders;
 358 };
 359
 360 /* Important: Starting with Gromacs-4.6, the values of c6 and c12 in the nbfp array have
 361  * been scaled by 6.0 or 12.0 to save flops in the kernels. We have corrected this everywhere
 362  * in the code, but beware if you are using these macros externally.
 363  */
 364 #define C6(nbfp, ntp, ai, aj)     (nbfp)[2*((ntp)*(ai)+(aj))]
 365 #define C12(nbfp, ntp, ai, aj)    (nbfp)[2*((ntp)*(ai)+(aj))+1]
 366 #define BHAMC(nbfp, ntp, ai, aj)  (nbfp)[3*((ntp)*(ai)+(aj))]
 367 #define BHAMA(nbfp, ntp, ai, aj)  (nbfp)[3*((ntp)*(ai)+(aj))+1]
 368 #define BHAMB(nbfp, ntp, ai, aj)  (nbfp)[3*((ntp)*(ai)+(aj))+2]
 369
 370 #ifdef __cplusplus
 371 }
 372 #endif
 373
 374 #endif