include/force.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  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _force_h
  37 #define _force_h
  38
  39
  40 #include "typedefs.h"
  41 #include "pbc.h"
  42 #include "network.h"
  43 #include "tgroup.h"
  44 #include "vsite.h"
  45 #include "genborn.h"
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 static const char *sepdvdlformat="  %-30s V %12.5e  dVdl %12.5e\n";
  52
  53 void calc_vir(FILE *fplog,int nxf,rvec x[],rvec f[],tensor vir,
  54                      gmx_bool bScrewPBC,matrix box);
  55 /* Calculate virial for nxf atoms, and add it to vir */
  56
  57 void f_calc_vir(FILE *fplog,int i0,int i1,rvec x[],rvec f[],tensor vir,
  58                        t_graph *g,rvec shift_vec[]);
  59 /* Calculate virial taking periodicity into account */
  60
  61 real RF_excl_correction(FILE *fplog,
  62                                const t_forcerec *fr,t_graph *g,
  63                                const t_mdatoms *mdatoms,const t_blocka *excl,
  64                                rvec x[],rvec f[],rvec *fshift,const t_pbc *pbc,
  65                                real lambda,real *dvdlambda);
  66 /* Calculate the reaction-field energy correction for this node:
  67  * epsfac q_i q_j (k_rf r_ij^2 - c_rf)
  68  * and force correction for all excluded pairs, including self pairs.
  69  */
  70
  71 void calc_rffac(FILE *fplog,int eel,real eps_r,real eps_rf,
  72                        real Rc,real Temp,
  73                        real zsq,matrix box,
  74                        real *kappa,real *krf,real *crf);
  75 /* Determine the reaction-field constants */
  76
  77 void init_generalized_rf(FILE *fplog,
  78                                 const gmx_mtop_t *mtop,const t_inputrec *ir,
  79                                 t_forcerec *fr);
  80 /* Initialize the generalized reaction field parameters */
  81
  82
  83 /* In wall.c */
  84 void make_wall_tables(FILE *fplog,const output_env_t oenv,
  85                              const t_inputrec *ir,const char *tabfn,
  86                              const gmx_groups_t *groups,
  87                              t_forcerec *fr);
  88
  89 real do_walls(t_inputrec *ir,t_forcerec *fr,matrix box,t_mdatoms *md,
  90                      rvec x[],rvec f[],real lambda,real Vlj[],t_nrnb *nrnb);
  91
  92
  93
  94 t_forcerec *mk_forcerec(void);
  95
  96 #define GMX_MAKETABLES_FORCEUSER  (1<<0)
  97 #define GMX_MAKETABLES_14ONLY     (1<<1)
  98
  99 t_forcetable make_tables(FILE *fp,const output_env_t oenv,
 100                                 const t_forcerec *fr, gmx_bool bVerbose,
 101                                 const char *fn, real rtab,int flags);
 102 /* Return tables for inner loops. When bVerbose the tables are printed
 103  * to .xvg files
 104  */
 105
 106 bondedtable_t make_bonded_table(FILE *fplog,char *fn,int angle);
 107 /* Return a table for bonded interactions,
 108  * angle should be: bonds 0, angles 1, dihedrals 2
 109  */
 110
 111 /* Return a table for GB calculations */
 112 t_forcetable make_gb_table(FILE *out,const output_env_t oenv,
 113                                   const t_forcerec *fr,
 114                                   const char *fn,
 115                                   real rtab);
 116
 117 void pr_forcerec(FILE *fplog,t_forcerec *fr,t_commrec *cr);
 118
 119 void
 120 forcerec_set_ranges(t_forcerec *fr,
 121                     int ncg_home,int ncg_force,
 122                     int natoms_force,
 123                     int natoms_force_constr,int natoms_f_novirsum);
 124 /* Set the number of cg's and atoms for the force calculation */
 125
 126 gmx_bool can_use_allvsall(const t_inputrec *ir, const gmx_mtop_t *mtop,
 127                              gmx_bool bPrintNote,t_commrec *cr,FILE *fp);
 128 /* Returns if we can use all-vs-all loops.
 129  * If bPrintNote==TRUE, prints a note, if necessary, to stderr
 130  * and fp (if !=NULL) on the master node.
 131  */
 132
 133 void init_forcerec(FILE       *fplog,
 134                           const output_env_t oenv,
 135                           t_forcerec *fr,
 136                           t_fcdata   *fcd,
 137                           const t_inputrec *ir,
 138                           const gmx_mtop_t *mtop,
 139                           const t_commrec  *cr,
 140                           matrix     box,
 141                           gmx_bool       bMolEpot,
 142                           const char *tabfn,
 143                           const char *tabpfn,
 144                           const char *tabbfn,
 145                           gmx_bool       bNoSolvOpt,
 146                           real       print_force);
 147 /* The Force rec struct must be created with mk_forcerec
 148  * The gmx_booleans have the following meaning:
 149  * bSetQ:    Copy the charges [ only necessary when they change ]
 150  * bMolEpot: Use the free energy stuff per molecule
 151  * print_force >= 0: print forces for atoms with force >= print_force
 152  */
 153
 154 void init_enerdata(int ngener,int n_flambda,gmx_enerdata_t *enerd);
 155 /* Intializes the energy storage struct */
 156
 157 void destroy_enerdata(gmx_enerdata_t *enerd);
 158 /* Free all memory associated with enerd */
 159
 160 void reset_enerdata(t_grpopts *opts,
 161                            t_forcerec *fr,gmx_bool bNS,
 162                            gmx_enerdata_t *enerd,
 163                            gmx_bool bMaster);
 164 /* Resets the energy data, if bNS=TRUE also zeros the long-range part */
 165
 166 void sum_epot(t_grpopts *opts,gmx_enerdata_t *enerd);
 167 /* Locally sum the non-bonded potential energy terms */
 168
 169 void sum_dhdl(gmx_enerdata_t *enerd,double lambda,t_inputrec *ir);
 170 /* Sum the free energy contributions */
 171
 172 void update_forcerec(FILE *fplog,t_forcerec *fr,matrix box);
 173 /* Updates parameters in the forcerec that are time dependent */
 174
 175 /* Compute the average C6 and C12 params for LJ corrections */
 176 void set_avcsixtwelve(FILE *fplog,t_forcerec *fr,
 177                              const gmx_mtop_t *mtop);
 178
 179 /* The state has changed */
 180 #define GMX_FORCE_STATECHANGED (1<<0)
 181 /* The box might have changed */
 182 #define GMX_FORCE_DYNAMICBOX   (1<<1)
 183 /* Do neighbor searching */
 184 #define GMX_FORCE_NS           (1<<2)
 185 /* Calculate bonded energies/forces */
 186 #define GMX_FORCE_DOLR         (1<<3)
 187 /* Calculate long-range energies/forces */
 188 #define GMX_FORCE_BONDED       (1<<4)
 189 /* Store long-range forces in a separate array */
 190 #define GMX_FORCE_SEPLRF       (1<<5)
 191 /* Calculate non-bonded energies/forces */
 192 #define GMX_FORCE_NONBONDED    (1<<6)
 193 /* Calculate forces (not only energies) */
 194 #define GMX_FORCE_FORCES       (1<<7)
 195 /* Calculate the virial */
 196 #define GMX_FORCE_VIRIAL       (1<<8)
 197 /* Calculate dHdl */
 198 #define GMX_FORCE_DHDL         (1<<9)
 199 /* Normally one want all energy terms and forces */
 200 #define GMX_FORCE_ALLFORCES    (GMX_FORCE_BONDED | GMX_FORCE_NONBONDED | GMX_FORCE_FORCES)
 201
 202 void do_force(FILE *log,t_commrec *cr,
 203                      t_inputrec *inputrec,
 204                      gmx_large_int_t step,t_nrnb *nrnb,gmx_wallcycle_t wcycle,
 205                      gmx_localtop_t *top,
 206                      gmx_mtop_t *mtop,
 207                      gmx_groups_t *groups,
 208                      matrix box,rvec x[],history_t *hist,
 209                      rvec f[],
 210                      tensor vir_force,
 211                      t_mdatoms *mdatoms,
 212                      gmx_enerdata_t *enerd,t_fcdata *fcd,
 213                      real lambda,t_graph *graph,
 214                      t_forcerec *fr,gmx_vsite_t *vsite,rvec mu_tot,
 215                      double t,FILE *field,gmx_edsam_t ed,
 216                      gmx_bool bBornRadii,
 217                      int flags);
 218 /* Communicate coordinates (if parallel).
 219  * Do neighbor searching (if necessary).
 220  * Calculate forces.
 221  * Communicate forces (if parallel).
 222  * Spread forces for vsites (if present).
 223  *
 224  * f is always required.
 225  */
 226
 227 void ns(FILE       *fplog,
 228                t_forcerec *fr,
 229                rvec       x[],
 230                matrix     box,
 231                gmx_groups_t *groups,
 232                t_grpopts  *opts,
 233                gmx_localtop_t *top,
 234                t_mdatoms  *md,
 235                t_commrec  *cr,
 236                t_nrnb     *nrnb,
 237                real       lambda,
 238                real       *dvdlambda,
 239                gmx_grppairener_t *grppener,
 240                gmx_bool       bFillGrid,
 241                gmx_bool       bDoLongRange,
 242                gmx_bool       bDoForces,
 243                rvec       *f);
 244 /* Call the neighborsearcher */
 245
 246 void do_force_lowlevel(FILE         *fplog,
 247                               gmx_large_int_t   step,
 248                               t_forcerec   *fr,
 249                               t_inputrec   *ir,
 250                               t_idef       *idef,
 251                               t_commrec    *cr,
 252                               t_nrnb       *nrnb,
 253                               gmx_wallcycle_t wcycle,
 254                               t_mdatoms    *md,
 255                               t_grpopts    *opts,
 256                               rvec         x[],
 257                               history_t    *hist,
 258                               rvec         f[],
 259                               gmx_enerdata_t *enerd,
 260                               t_fcdata     *fcd,
 261                               gmx_mtop_t     *mtop,
 262                               gmx_localtop_t *top,
 263                               gmx_genborn_t *born,
 264                               t_atomtypes  *atype,
 265                               gmx_bool         bBornRadii,
 266                               matrix       box,
 267                               real         lambda,
 268                               t_graph      *graph,
 269                               t_blocka     *excl,
 270                               rvec         mu_tot[2],
 271                               int          flags,
 272                               float        *cycles_pme);
 273 /* Call all the force routines */
 274
 275 #ifdef __cplusplus
 276 }
 277 #endif
 278
 279 #endif  /* _force_h */