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 { enbvdwNONE,enbvdwLJ,enbvdwBHAM,enbvdwTAB,enbvdwNR};
 129 /* OOR is "one over r" -- standard coul */
 130 enum { enbcoulNONE,enbcoulOOR,enbcoulRF,enbcoulTAB,enbcoulGB,enbcoulFEWALD,enbcoulNR};
 131
 132 enum { egCOULSR, egLJSR, egBHAMSR, egCOULLR, egLJLR, egBHAMLR,
 133        egCOUL14, egLJ14, egGB, egNR };
 134
 135 typedef struct {
 136   int  nener;        /* The number of energy group pairs     */
 137   real *ener[egNR];  /* Energy terms for each pair of groups */
 138 } gmx_grppairener_t;
 139
 140 typedef struct {
 141   real term[F_NRE];    /* The energies for all different interaction types */
 142   gmx_grppairener_t grpp;
 143   double dvdl_lin[efptNR];       /* Contributions to dvdl with linear lam-dependence */
 144   double dvdl_nonlin[efptNR];    /* Idem, but non-linear dependence                  */
 145   int    n_lambda;
 146   int    fep_state;              /*current fep state -- just for printing */
 147   double *enerpart_lambda; /* Partial energy for lambda and flambda[] */
 148   real foreign_term[F_NRE];    /* alternate array for storing foreign lambda energies */
 149   gmx_grppairener_t foreign_grpp;  /* alternate array for storing foreign lambda energies */
 150 } gmx_enerdata_t;
 151 /* The idea is that dvdl terms with linear lambda dependence will be added
 152  * automatically to enerpart_lambda. Terms with non-linear lambda dependence
 153  * should explicitly determine the energies at foreign lambda points
 154  * when n_lambda > 0.
 155  */
 156
 157 typedef struct {
 158   int cg_start;
 159   int cg_end;
 160   int cg_mod;
 161   int *cginfo;
 162 } cginfo_mb_t;
 163
 164
 165 /* ewald table type */
 166 typedef struct ewald_tab *ewald_tab_t;
 167
 168 typedef struct {
 169     rvec *f;
 170     int  f_nalloc;
 171     unsigned red_mask; /* Mask for marking which parts of f are filled */
 172     rvec *fshift;
 173     real ener[F_NRE];
 174     gmx_grppairener_t grpp;
 175     real Vcorr;
 176     real dvdl[efptNR];
 177     tensor vir;
 178 } f_thread_t;
 179
 180 typedef struct {
 181   interaction_const_t *ic;
 182
 183   /* Domain Decomposition */
 184   gmx_bool bDomDec;
 185
 186   /* PBC stuff */
 187   int  ePBC;
 188   gmx_bool bMolPBC;
 189   int  rc_scaling;
 190   rvec posres_com;
 191   rvec posres_comB;
 192
 193   gmx_hw_info_t *hwinfo;
 194   gmx_bool      use_cpu_acceleration;
 195
 196   /* Interaction for calculated in kernels. In many cases this is similar to
 197    * the electrostatics settings in the inputrecord, but the difference is that
 198    * these variables always specify the actual interaction in the kernel - if
 199    * we are tabulating reaction-field the inputrec will say reaction-field, but
 200    * the kernel interaction will say cubic-spline-table. To be safe we also
 201    * have a kernel-specific setting for the modifiers - if the interaction is
 202    * tabulated we already included the inputrec modification there, so the kernel
 203    * modification setting will say 'none' in that case.
 204    */
 205   int nbkernel_elec_interaction;
 206   int nbkernel_vdw_interaction;
 207   int nbkernel_elec_modifier;
 208   int nbkernel_vdw_modifier;
 209
 210   /* Use special N*N kernels? */
 211   gmx_bool bAllvsAll;
 212   /* Private work data */
 213   void *AllvsAll_work;
 214   void *AllvsAll_workgb;
 215
 216   /* Cut-Off stuff.
 217    * Infinite cut-off's will be GMX_CUTOFF_INF (unlike in t_inputrec: 0).
 218    */
 219   real rlist,rlistlong;
 220
 221   /* Dielectric constant resp. multiplication factor for charges */
 222   real zsquare,temp;
 223   real epsilon_r,epsilon_rf,epsfac;
 224
 225   /* Constants for reaction fields */
 226   real kappa,k_rf,c_rf;
 227
 228   /* Charge sum and dipole for topology A/B ([0]/[1]) for Ewald corrections */
 229   double qsum[2];
 230   double q2sum[2];
 231   rvec   mu_tot[2];
 232
 233   /* Dispersion correction stuff */
 234   int  eDispCorr;
 235
 236   /* The shift of the shift or user potentials */
 237   real enershiftsix;
 238   real enershifttwelve;
 239   /* Integrated differces for energy and virial with cut-off functions */
 240   real enerdiffsix;
 241   real enerdifftwelve;
 242   real virdiffsix;
 243   real virdifftwelve;
 244   /* Constant for long range dispersion correction (average dispersion)
 245    * for topology A/B ([0]/[1]) */
 246   real avcsix[2];
 247   /* Constant for long range repulsion term. Relative difference of about
 248    * 0.1 percent with 0.8 nm cutoffs. But hey, it's cheap anyway...
 249    */
 250   real avctwelve[2];
 251
 252   /* Fudge factors */
 253   real fudgeQQ;
 254
 255   /* Table stuff */
 256   gmx_bool bcoultab;
 257   gmx_bool bvdwtab;
 258   /* The normal tables are in the nblists struct(s) below */
 259   t_forcetable tab14; /* for 1-4 interactions only */
 260
 261   /* PPPM & Shifting stuff */
 262   int coulomb_modifier;
 263   real rcoulomb_switch,rcoulomb;
 264   real *phi;
 265
 266   /* VdW stuff */
 267   int vdw_modifier;
 268   double reppow;
 269   real rvdw_switch,rvdw;
 270   real bham_b_max;
 271
 272   /* Free energy */
 273   int  efep;
 274   real sc_alphavdw;
 275   real sc_alphacoul;
 276   int  sc_power;
 277   real sc_r_power;
 278   real sc_sigma6_def;
 279   real sc_sigma6_min;
 280   gmx_bool bSepDVDL;
 281
 282   /* NS Stuff */
 283   int  eeltype;
 284   int  vdwtype;
 285   int  cg0,hcg;
 286   /* solvent_opt contains the enum for the most common solvent
 287    * in the system, which will be optimized.
 288    * It can be set to esolNO to disable all water optimization */
 289   int  solvent_opt;
 290   int  nWatMol;
 291   gmx_bool bGrid;
 292   gmx_bool bExcl_IntraCGAll_InterCGNone;
 293   cginfo_mb_t *cginfo_mb;
 294   int  *cginfo;
 295   rvec *cg_cm;
 296   int  cg_nalloc;
 297   rvec *shift_vec;
 298
 299   /* The neighborlists including tables */
 300   int  nnblists;
 301   int  *gid2nblists;
 302   t_nblists *nblists;
 303
 304   int cutoff_scheme; /* group- or Verlet-style cutoff */
 305   gmx_bool bNonbonded;    /* true if nonbonded calculations are *not* turned off */
 306   nonbonded_verlet_t *nbv;
 307
 308   /* The wall tables (if used) */
 309   int  nwall;
 310   t_forcetable **wall_tab;
 311
 312   /* The number of charge groups participating in do_force_lowlevel */
 313   int ncg_force;
 314   /* The number of atoms participating in do_force_lowlevel */
 315   int natoms_force;
 316   /* The number of atoms participating in force and constraints */
 317   int natoms_force_constr;
 318   /* The allocation size of vectors of size natoms_force */
 319   int nalloc_force;
 320
 321   /* Twin Range stuff, f_twin has size natoms_force */
 322   gmx_bool bTwinRange;
 323   int  nlr;
 324   rvec *f_twin;
 325
 326   /* Forces that should not enter into the virial summation:
 327    * PPPM/PME/Ewald/posres
 328    */
 329   gmx_bool bF_NoVirSum;
 330   int  f_novirsum_n;
 331   int  f_novirsum_nalloc;
 332   rvec *f_novirsum_alloc;
 333   /* Pointer that points to f_novirsum_alloc when pressure is calcaluted,
 334    * points to the normal force vectors wen pressure is not requested.
 335    */
 336   rvec *f_novirsum;
 337
 338   /* Long-range forces and virial for PPPM/PME/Ewald */
 339   gmx_pme_t pmedata;
 340   tensor    vir_el_recip;
 341
 342   /* PME/Ewald stuff */
 343   gmx_bool bEwald;
 344   real ewaldcoeff;
 345   ewald_tab_t ewald_table;
 346
 347   /* Virial Stuff */
 348   rvec *fshift;
 349   rvec vir_diag_posres;
 350   dvec vir_wall_z;
 351
 352   /* Non bonded Parameter lists */
 353   int  ntype; /* Number of atom types */
 354   gmx_bool bBHAM;
 355   real *nbfp;
 356
 357   /* Energy group pair flags */
 358   int *egp_flags;
 359
 360   /* xmdrun flexible constraints */
 361   real fc_stepsize;
 362
 363   /* Generalized born implicit solvent */
 364   gmx_bool bGB;
 365   /* Generalized born stuff */
 366   real gb_epsilon_solvent;
 367   /* Table data for GB */
 368   t_forcetable gbtab;
 369   /* VdW radius for each atomtype (dim is thus ntype) */
 370   real *atype_radius;
 371   /* Effective radius (derived from effective volume) for each type */
 372   real *atype_vol;
 373   /* Implicit solvent - surface tension for each atomtype */
 374   real *atype_surftens;
 375   /* Implicit solvent - radius for GB calculation */
 376   real *atype_gb_radius;
 377   /* Implicit solvent - overlap for HCT model */
 378   real *atype_S_hct;
 379   /* Generalized born interaction data */
 380   gmx_genborn_t *born;
 381
 382   /* Table scale for GB */
 383   real gbtabscale;
 384   /* Table range for GB */
 385   real gbtabr;
 386   /* GB neighborlists (the sr list will contain for each atom all other atoms
 387    * (for use in the SA calculation) and the lr list will contain
 388    * for each atom all atoms 1-4 or greater (for use in the GB calculation)
 389    */
 390   t_nblist gblist_sr;
 391   t_nblist gblist_lr;
 392   t_nblist gblist;
 393
 394   /* Inverse square root of the Born radii for implicit solvent */
 395   real *invsqrta;
 396   /* Derivatives of the potential with respect to the Born radii */
 397   real *dvda;
 398   /* Derivatives of the Born radii with respect to coordinates */
 399   real *dadx;
 400   real *dadx_rawptr;
 401   int   nalloc_dadx; /* Allocated size of dadx */
 402
 403   /* If > 0 signals Test Particle Insertion,
 404    * the value is the number of atoms of the molecule to insert
 405    * Only the energy difference due to the addition of the last molecule
 406    * should be calculated.
 407    */
 408   gmx_bool n_tpi;
 409
 410   /* Neighbor searching stuff */
 411   gmx_ns_t ns;
 412
 413   /* QMMM stuff */
 414   gmx_bool         bQMMM;
 415   t_QMMMrec    *qr;
 416
 417   /* QM-MM neighborlists */
 418   t_nblist QMMMlist;
 419
 420   /* Limit for printing large forces, negative is don't print */
 421   real print_force;
 422
 423   /* coarse load balancing time measurement */
 424   double t_fnbf;
 425   double t_wait;
 426   int timesteps;
 427
 428   /* parameter needed for AdResS simulation */
 429   int  adress_type;
 430   gmx_bool badress_tf_full_box;
 431   real adress_const_wf;
 432   real adress_ex_width;
 433   real adress_hy_width;
 434   int  adress_icor;
 435   int  adress_site;
 436   rvec adress_refs;
 437   int n_adress_tf_grps;
 438   int * adress_tf_table_index;
 439   int *adress_group_explicit;
 440   t_forcetable *  atf_tabs;
 441   real adress_ex_forcecap;
 442   gmx_bool adress_do_hybridpairs;
 443
 444   /* User determined parameters, copied from the inputrec */
 445   int  userint1;
 446   int  userint2;
 447   int  userint3;
 448   int  userint4;
 449   real userreal1;
 450   real userreal2;
 451   real userreal3;
 452   real userreal4;
 453
 454   /* Thread local force and energy data */
 455   /* FIXME move to bonded_thread_data_t */
 456   int  nthreads;
 457   int  red_ashift;
 458   int  red_nblock;
 459   f_thread_t *f_t;
 460
 461   /* Exclusion load distribution over the threads */
 462   int  *excl_load;
 463 } t_forcerec;
 464
 465 /* Important: Starting with Gromacs-4.6, the values of c6 and c12 in the nbfp array have
 466  * been scaled by 6.0 or 12.0 to save flops in the kernels. We have corrected this everywhere
 467  * in the code, but beware if you are using these macros externally.
 468  */
 469 #define C6(nbfp,ntp,ai,aj)     (nbfp)[2*((ntp)*(ai)+(aj))]
 470 #define C12(nbfp,ntp,ai,aj)    (nbfp)[2*((ntp)*(ai)+(aj))+1]
 471 #define BHAMC(nbfp,ntp,ai,aj)  (nbfp)[3*((ntp)*(ai)+(aj))]
 472 #define BHAMA(nbfp,ntp,ai,aj)  (nbfp)[3*((ntp)*(ai)+(aj))+1]
 473 #define BHAMB(nbfp,ntp,ai,aj)  (nbfp)[3*((ntp)*(ai)+(aj))+2]
 474
 475 #ifdef __cplusplus
 476 }
 477 #endif
 478