src/gromacs/legacyheaders/types/forcerec.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * GRoups of Organic Molecules in ACtion for Science
  34  */
  35
  36 #include "ns.h"
  37 #include "genborn.h"
  38 #include "qmmmrec.h"
  39 #include "idef.h"
  40 #include "nb_verlet.h"
  41 #include "interaction_const.h"
  42 #include "hw_info.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47 #if 0
  48 } /* fixes auto-indentation problems */
  49 #endif
  50
  51 /* Abstract type for PME that is defined only in the routine that use them. */
  52 typedef struct gmx_pme *gmx_pme_t;
  53
  54
  55
  56 /* Structure describing the data in a single table */
  57 typedef struct
  58 {
  59     enum gmx_table_interaction  interaction; /* Types of interactions stored in this table */
  60     enum gmx_table_format       format;      /* Interpolation type and data format */
  61
  62     real                        r;           /* range of the table */
  63     int                         n;           /* n+1 is the number of table points */
  64     real                        scale;       /* distance (nm) between two table points */
  65     real                        scale_exp;   /* distance for exponential part of VdW table, not always used */
  66     real *                      data;        /* the actual table data */
  67
  68     /* Some information about the table layout. This can also be derived from the interpolation
  69      * type and the table interactions, but it is convenient to have here for sanity checks, and it makes it
  70      * much easier to access the tables in the nonbonded kernels when we can set the data from variables.
  71      * It is always true that stride = formatsize*ninteractions
  72      */
  73     int                         formatsize;    /* Number of fp variables for each table point (1 for F, 2 for VF, 4 for YFGH, etc.) */
  74     int                         ninteractions; /* Number of interactions in table, 1 for coul-only, 3 for coul+rep+disp. */
  75     int                         stride;        /* Distance to next table point (number of fp variables per table point in total) */
  76 } t_forcetable;
  77
  78 typedef struct
  79 {
  80     t_forcetable   table_elec;
  81     t_forcetable   table_vdw;
  82     t_forcetable   table_elec_vdw;
  83
  84     /* The actual neighbor lists, short and long range, see enum above
  85      * for definition of neighborlist indices.
  86      */
  87     t_nblist nlist_sr[eNL_NR];
  88     t_nblist nlist_lr[eNL_NR];
  89 } t_nblists;
  90
  91 /* macros for the cginfo data in forcerec */
  92 /* The maximum cg size in cginfo is 63
  93  * because we only have space for 6 bits in cginfo,
  94  * this cg size entry is actually only read with domain decomposition.
  95  * But there is a smaller limit due to the t_excl data structure
  96  * which is defined in nblist.h.
  97  */
  98 #define SET_CGINFO_GID(cgi, gid)      (cgi) = (((cgi)  &  ~65535)  |  (gid)   )
  99 #define GET_CGINFO_GID(cgi)        ( (cgi)            &   65535)
 100 #define SET_CGINFO_EXCL_INTRA(cgi)   (cgi) =  ((cgi)  |  (1<<16))
 101 #define GET_CGINFO_EXCL_INTRA(cgi) ( (cgi)            &  (1<<16))
 102 #define SET_CGINFO_EXCL_INTER(cgi)   (cgi) =  ((cgi)  |  (1<<17))
 103 #define GET_CGINFO_EXCL_INTER(cgi) ( (cgi)            &  (1<<17))
 104 #define SET_CGINFO_SOLOPT(cgi, opt)   (cgi) = (((cgi)  & ~(3<<18)) | ((opt)<<18))
 105 #define GET_CGINFO_SOLOPT(cgi)     (((cgi)>>18)       &   3)
 106 #define SET_CGINFO_CONSTR(cgi)       (cgi) =  ((cgi)  |  (1<<20))
 107 #define GET_CGINFO_CONSTR(cgi)     ( (cgi)            &  (1<<20))
 108 #define SET_CGINFO_SETTLE(cgi)       (cgi) =  ((cgi)  |  (1<<21))
 109 #define GET_CGINFO_SETTLE(cgi)     ( (cgi)            &  (1<<21))
 110 /* This bit is only used with bBondComm in the domain decomposition */
 111 #define SET_CGINFO_BOND_INTER(cgi)   (cgi) =  ((cgi)  |  (1<<22))
 112 #define GET_CGINFO_BOND_INTER(cgi) ( (cgi)            &  (1<<22))
 113 #define SET_CGINFO_HAS_VDW(cgi)      (cgi) =  ((cgi)  |  (1<<23))
 114 #define GET_CGINFO_HAS_VDW(cgi)    ( (cgi)            &  (1<<23))
 115 #define SET_CGINFO_HAS_Q(cgi)        (cgi) =  ((cgi)  |  (1<<24))
 116 #define GET_CGINFO_HAS_Q(cgi)      ( (cgi)            &  (1<<24))
 117 #define SET_CGINFO_NATOMS(cgi, opt)   (cgi) = (((cgi)  & ~(63<<25)) | ((opt)<<25))
 118 #define GET_CGINFO_NATOMS(cgi)     (((cgi)>>25)       &   63)
 119
 120
 121 /* Value to be used in mdrun for an infinite cut-off.
 122  * Since we need to compare with the cut-off squared,
 123  * this value should be slighlty smaller than sqrt(GMX_FLOAT_MAX).
 124  */
 125 #define GMX_CUTOFF_INF 1E+18
 126
 127 /* enums for the neighborlist type */
 128 enum {
 129     enbvdwNONE, enbvdwLJ, enbvdwBHAM, enbvdwTAB, enbvdwNR
 130 };
 131 /* OOR is "one over r" -- standard coul */
 132 enum {
 133     enbcoulNONE, enbcoulOOR, enbcoulRF, enbcoulTAB, enbcoulGB, enbcoulFEWALD, enbcoulNR
 134 };
 135
 136 enum {
 137     egCOULSR, egLJSR, egBHAMSR, egCOULLR, egLJLR, egBHAMLR,
 138     egCOUL14, egLJ14, egGB, egNR
 139 };
 140
 141 typedef struct {
 142     int   nener;      /* The number of energy group pairs     */
 143     real *ener[egNR]; /* Energy terms for each pair of groups */
 144 } gmx_grppairener_t;
 145
 146 typedef struct {
 147     real              term[F_NRE];         /* The energies for all different interaction types */
 148     gmx_grppairener_t grpp;
 149     double            dvdl_lin[efptNR];    /* Contributions to dvdl with linear lam-dependence */
 150     double            dvdl_nonlin[efptNR]; /* Idem, but non-linear dependence                  */
 151     int               n_lambda;
 152     int               fep_state;           /*current fep state -- just for printing */
 153     double           *enerpart_lambda;     /* Partial energy for lambda and flambda[] */
 154     real              foreign_term[F_NRE]; /* alternate array for storing foreign lambda energies */
 155     gmx_grppairener_t foreign_grpp;        /* alternate array for storing foreign lambda energies */
 156 } gmx_enerdata_t;
 157 /* The idea is that dvdl terms with linear lambda dependence will be added
 158  * automatically to enerpart_lambda. Terms with non-linear lambda dependence
 159  * should explicitly determine the energies at foreign lambda points
 160  * when n_lambda > 0.
 161  */
 162
 163 typedef struct {
 164     int  cg_start;
 165     int  cg_end;
 166     int  cg_mod;
 167     int *cginfo;
 168 } cginfo_mb_t;
 169
 170
 171 /* ewald table type */
 172 typedef struct ewald_tab *ewald_tab_t;
 173
 174 typedef struct {
 175     rvec             *f;
 176     int               f_nalloc;
 177     unsigned          red_mask; /* Mask for marking which parts of f are filled */
 178     rvec             *fshift;
 179     real              ener[F_NRE];
 180     gmx_grppairener_t grpp;
 181     real              Vcorr;
 182     real              dvdl[efptNR];
 183     tensor            vir;
 184 } f_thread_t;
 185
 186 typedef struct {
 187     interaction_const_t *ic;
 188
 189     /* Domain Decomposition */
 190     gmx_bool bDomDec;
 191
 192     /* PBC stuff */
 193     int                  ePBC;
 194     gmx_bool             bMolPBC;
 195     int                  rc_scaling;
 196     rvec                 posres_com;
 197     rvec                 posres_comB;
 198
 199     const gmx_hw_info_t *hwinfo;
 200     gmx_bool             use_cpu_acceleration;
 201
 202     /* Interaction for calculated in kernels. In many cases this is similar to
 203      * the electrostatics settings in the inputrecord, but the difference is that
 204      * these variables always specify the actual interaction in the kernel - if
 205      * we are tabulating reaction-field the inputrec will say reaction-field, but
 206      * the kernel interaction will say cubic-spline-table. To be safe we also
 207      * have a kernel-specific setting for the modifiers - if the interaction is
 208      * tabulated we already included the inputrec modification there, so the kernel
 209      * modification setting will say 'none' in that case.
 210      */
 211     int nbkernel_elec_interaction;
 212     int nbkernel_vdw_interaction;
 213     int nbkernel_elec_modifier;
 214     int nbkernel_vdw_modifier;
 215
 216     /* Use special N*N kernels? */
 217     gmx_bool bAllvsAll;
 218     /* Private work data */
 219     void    *AllvsAll_work;
 220     void    *AllvsAll_workgb;
 221
 222     /* Cut-Off stuff.
 223      * Infinite cut-off's will be GMX_CUTOFF_INF (unlike in t_inputrec: 0).
 224      */
 225     real rlist, rlistlong;
 226
 227     /* Dielectric constant resp. multiplication factor for charges */
 228     real zsquare, temp;
 229     real epsilon_r, epsilon_rf, epsfac;
 230
 231     /* Constants for reaction fields */
 232     real kappa, k_rf, c_rf;
 233
 234     /* Charge sum and dipole for topology A/B ([0]/[1]) for Ewald corrections */
 235     double qsum[2];
 236     double q2sum[2];
 237     rvec   mu_tot[2];
 238
 239     /* Dispersion correction stuff */
 240     int  eDispCorr;
 241
 242     /* The shift of the shift or user potentials */
 243     real enershiftsix;
 244     real enershifttwelve;
 245     /* Integrated differces for energy and virial with cut-off functions */
 246     real enerdiffsix;
 247     real enerdifftwelve;
 248     real virdiffsix;
 249     real virdifftwelve;
 250     /* Constant for long range dispersion correction (average dispersion)
 251      * for topology A/B ([0]/[1]) */
 252     real avcsix[2];
 253     /* Constant for long range repulsion term. Relative difference of about
 254      * 0.1 percent with 0.8 nm cutoffs. But hey, it's cheap anyway...
 255      */
 256     real avctwelve[2];
 257
 258     /* Fudge factors */
 259     real fudgeQQ;
 260
 261     /* Table stuff */
 262     gmx_bool     bcoultab;
 263     gmx_bool     bvdwtab;
 264     /* The normal tables are in the nblists struct(s) below */
 265     t_forcetable tab14; /* for 1-4 interactions only */
 266
 267     /* PPPM & Shifting stuff */
 268     int   coulomb_modifier;
 269     real  rcoulomb_switch, rcoulomb;
 270     real *phi;
 271
 272     /* VdW stuff */
 273     int    vdw_modifier;
 274     double reppow;
 275     real   rvdw_switch, rvdw;
 276     real   bham_b_max;
 277
 278     /* Free energy */
 279     int      efep;
 280     real     sc_alphavdw;
 281     real     sc_alphacoul;
 282     int      sc_power;
 283     real     sc_r_power;
 284     real     sc_sigma6_def;
 285     real     sc_sigma6_min;
 286     gmx_bool bSepDVDL;
 287
 288     /* NS Stuff */
 289     int  eeltype;
 290     int  vdwtype;
 291     int  cg0, hcg;
 292     /* solvent_opt contains the enum for the most common solvent
 293      * in the system, which will be optimized.
 294      * It can be set to esolNO to disable all water optimization */
 295     int          solvent_opt;
 296     int          nWatMol;
 297     gmx_bool     bGrid;
 298     gmx_bool     bExcl_IntraCGAll_InterCGNone;
 299     cginfo_mb_t *cginfo_mb;
 300     int         *cginfo;
 301     rvec        *cg_cm;
 302     int          cg_nalloc;
 303     rvec        *shift_vec;
 304
 305     /* The neighborlists including tables */
 306     int                 nnblists;
 307     int                *gid2nblists;
 308     t_nblists          *nblists;
 309
 310     int                 cutoff_scheme; /* group- or Verlet-style cutoff */
 311     gmx_bool            bNonbonded;    /* true if nonbonded calculations are *not* turned off */
 312     nonbonded_verlet_t *nbv;
 313
 314     /* The wall tables (if used) */
 315     int            nwall;
 316     t_forcetable **wall_tab;
 317
 318     /* The number of charge groups participating in do_force_lowlevel */
 319     int ncg_force;
 320     /* The number of atoms participating in do_force_lowlevel */
 321     int natoms_force;
 322     /* The number of atoms participating in force and constraints */
 323     int natoms_force_constr;
 324     /* The allocation size of vectors of size natoms_force */
 325     int nalloc_force;
 326
 327     /* Twin Range stuff, f_twin has size natoms_force */
 328     gmx_bool bTwinRange;
 329     int      nlr;
 330     rvec    *f_twin;
 331
 332     /* Forces that should not enter into the virial summation:
 333      * PPPM/PME/Ewald/posres
 334      */
 335     gmx_bool bF_NoVirSum;
 336     int      f_novirsum_n;
 337     int      f_novirsum_nalloc;
 338     rvec    *f_novirsum_alloc;
 339     /* Pointer that points to f_novirsum_alloc when pressure is calcaluted,
 340      * points to the normal force vectors wen pressure is not requested.
 341      */
 342     rvec *f_novirsum;
 343
 344     /* Long-range forces and virial for PPPM/PME/Ewald */
 345     gmx_pme_t pmedata;
 346     tensor    vir_el_recip;
 347
 348     /* PME/Ewald stuff */
 349     gmx_bool    bEwald;
 350     real        ewaldcoeff;
 351     ewald_tab_t ewald_table;
 352
 353     /* Virial Stuff */
 354     rvec *fshift;
 355     rvec  vir_diag_posres;
 356     dvec  vir_wall_z;
 357
 358     /* Non bonded Parameter lists */
 359     int      ntype; /* Number of atom types */
 360     gmx_bool bBHAM;
 361     real    *nbfp;
 362
 363     /* Energy group pair flags */
 364     int *egp_flags;
 365
 366     /* xmdrun flexible constraints */
 367     real fc_stepsize;
 368
 369     /* Generalized born implicit solvent */
 370     gmx_bool       bGB;
 371     /* Generalized born stuff */
 372     real           gb_epsilon_solvent;
 373     /* Table data for GB */
 374     t_forcetable   gbtab;
 375     /* VdW radius for each atomtype (dim is thus ntype) */
 376     real          *atype_radius;
 377     /* Effective radius (derived from effective volume) for each type */
 378     real          *atype_vol;
 379     /* Implicit solvent - surface tension for each atomtype */
 380     real          *atype_surftens;
 381     /* Implicit solvent - radius for GB calculation */
 382     real          *atype_gb_radius;
 383     /* Implicit solvent - overlap for HCT model */
 384     real          *atype_S_hct;
 385     /* Generalized born interaction data */
 386     gmx_genborn_t *born;
 387
 388     /* Table scale for GB */
 389     real gbtabscale;
 390     /* Table range for GB */
 391     real gbtabr;
 392     /* GB neighborlists (the sr list will contain for each atom all other atoms
 393      * (for use in the SA calculation) and the lr list will contain
 394      * for each atom all atoms 1-4 or greater (for use in the GB calculation)
 395      */
 396     t_nblist gblist_sr;
 397     t_nblist gblist_lr;
 398     t_nblist gblist;
 399
 400     /* Inverse square root of the Born radii for implicit solvent */
 401     real *invsqrta;
 402     /* Derivatives of the potential with respect to the Born radii */
 403     real *dvda;
 404     /* Derivatives of the Born radii with respect to coordinates */
 405     real *dadx;
 406     real *dadx_rawptr;
 407     int   nalloc_dadx; /* Allocated size of dadx */
 408
 409     /* If > 0 signals Test Particle Insertion,
 410      * the value is the number of atoms of the molecule to insert
 411      * Only the energy difference due to the addition of the last molecule
 412      * should be calculated.
 413      */
 414     gmx_bool n_tpi;
 415
 416     /* Neighbor searching stuff */
 417     gmx_ns_t ns;
 418
 419     /* QMMM stuff */
 420     gmx_bool         bQMMM;
 421     t_QMMMrec       *qr;
 422
 423     /* QM-MM neighborlists */
 424     t_nblist QMMMlist;
 425
 426     /* Limit for printing large forces, negative is don't print */
 427     real print_force;
 428
 429     /* coarse load balancing time measurement */
 430     double t_fnbf;
 431     double t_wait;
 432     int    timesteps;
 433
 434     /* parameter needed for AdResS simulation */
 435     int             adress_type;
 436     gmx_bool        badress_tf_full_box;
 437     real            adress_const_wf;
 438     real            adress_ex_width;
 439     real            adress_hy_width;
 440     int             adress_icor;
 441     int             adress_site;
 442     rvec            adress_refs;
 443     int             n_adress_tf_grps;
 444     int           * adress_tf_table_index;
 445     int            *adress_group_explicit;
 446     t_forcetable *  atf_tabs;
 447     real            adress_ex_forcecap;
 448     gmx_bool        adress_do_hybridpairs;
 449
 450     /* User determined parameters, copied from the inputrec */
 451     int  userint1;
 452     int  userint2;
 453     int  userint3;
 454     int  userint4;
 455     real userreal1;
 456     real userreal2;
 457     real userreal3;
 458     real userreal4;
 459
 460     /* Thread local force and energy data */
 461     /* FIXME move to bonded_thread_data_t */
 462     int         nthreads;
 463     int         red_ashift;
 464     int         red_nblock;
 465     f_thread_t *f_t;
 466
 467     /* Exclusion load distribution over the threads */
 468     int  *excl_load;
 469 } t_forcerec;
 470
 471 /* Important: Starting with Gromacs-4.6, the values of c6 and c12 in the nbfp array have
 472  * been scaled by 6.0 or 12.0 to save flops in the kernels. We have corrected this everywhere
 473  * in the code, but beware if you are using these macros externally.
 474  */
 475 #define C6(nbfp, ntp, ai, aj)     (nbfp)[2*((ntp)*(ai)+(aj))]
 476 #define C12(nbfp, ntp, ai, aj)    (nbfp)[2*((ntp)*(ai)+(aj))+1]
 477 #define BHAMC(nbfp, ntp, ai, aj)  (nbfp)[3*((ntp)*(ai)+(aj))]
 478 #define BHAMA(nbfp, ntp, ai, aj)  (nbfp)[3*((ntp)*(ai)+(aj))+1]
 479 #define BHAMB(nbfp, ntp, ai, aj)  (nbfp)[3*((ntp)*(ai)+(aj))+2]
 480
 481 #ifdef __cplusplus
 482 }
 483 #endif