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 "types/force_flags.h"
  42 #include "pbc.h"
  43 #include "network.h"
  44 #include "tgroup.h"
  45 #include "vsite.h"
  46 #include "genborn.h"
  47
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 static const char *sepdvdlformat="  %-30s V %12.5e  dVdl %12.5e\n";
  54
  55 void calc_vir(FILE *fplog,int nxf,rvec x[],rvec f[],tensor vir,
  56                      gmx_bool bScrewPBC,matrix box);
  57 /* Calculate virial for nxf atoms, and add it to vir */
  58
  59 void f_calc_vir(FILE *fplog,int i0,int i1,rvec x[],rvec f[],tensor vir,
  60                        t_graph *g,rvec shift_vec[]);
  61 /* Calculate virial taking periodicity into account */
  62
  63 real RF_excl_correction(FILE *fplog,
  64                                const t_forcerec *fr,t_graph *g,
  65                                const t_mdatoms *mdatoms,const t_blocka *excl,
  66                                rvec x[],rvec f[],rvec *fshift,const t_pbc *pbc,
  67                                real lambda,real *dvdlambda);
  68 /* Calculate the reaction-field energy correction for this node:
  69  * epsfac q_i q_j (k_rf r_ij^2 - c_rf)
  70  * and force correction for all excluded pairs, including self pairs.
  71  */
  72
  73 void calc_rffac(FILE *fplog,int eel,real eps_r,real eps_rf,
  74                        real Rc,real Temp,
  75                        real zsq,matrix box,
  76                        real *kappa,real *krf,real *crf);
  77 /* Determine the reaction-field constants */
  78
  79 void init_generalized_rf(FILE *fplog,
  80                                 const gmx_mtop_t *mtop,const t_inputrec *ir,
  81                                 t_forcerec *fr);
  82 /* Initialize the generalized reaction field parameters */
  83
  84
  85 /* In wall.c */
  86 void make_wall_tables(FILE *fplog,const output_env_t oenv,
  87                              const t_inputrec *ir,const char *tabfn,
  88                              const gmx_groups_t *groups,
  89                              t_forcerec *fr);
  90
  91 real do_walls(t_inputrec *ir,t_forcerec *fr,matrix box,t_mdatoms *md,
  92               rvec x[],rvec f[],real lambda,real Vlj[],t_nrnb *nrnb);
  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 /* Read a table for AdResS Thermo Force calculations */
 118 extern t_forcetable make_atf_table(FILE *out,const output_env_t oenv,
 119                                    const t_forcerec *fr,
 120                                    const char *fn,
 121                                    matrix box);
 122
 123 void pr_forcerec(FILE *fplog,t_forcerec *fr,t_commrec *cr);
 124
 125 void
 126 forcerec_set_ranges(t_forcerec *fr,
 127                     int ncg_home,int ncg_force,
 128                     int natoms_force,
 129                     int natoms_force_constr,int natoms_f_novirsum);
 130 /* Set the number of cg's and atoms for the force calculation */
 131
 132 gmx_bool can_use_allvsall(const t_inputrec *ir, const gmx_mtop_t *mtop,
 133                              gmx_bool bPrintNote,t_commrec *cr,FILE *fp);
 134 /* Returns if we can use all-vs-all loops.
 135  * If bPrintNote==TRUE, prints a note, if necessary, to stderr
 136  * and fp (if !=NULL) on the master node.
 137  */
 138
 139 gmx_bool uses_simple_tables(int cutoff_scheme,
 140                             nonbonded_verlet_t *nbv,
 141                             int group);
 142 /* Returns whether simple tables (i.e. not for use with GPUs) are used
 143  * with the type of kernel indicated.
 144  */
 145
 146 void init_interaction_const_tables(FILE *fp,
 147                                    interaction_const_t *ic,
 148                                    gmx_bool bSimpleTable,
 149                                    real rtab);
 150 /* Initializes the tables in the interaction constant data structure.
 151  * Setting verlet_kernel_type to -1 always initializes tables for
 152  * use with group kernels.
 153  */
 154
 155 void init_interaction_const(FILE *fp,
 156                             interaction_const_t **interaction_const,
 157                             const t_forcerec *fr,
 158                             real  rtab);
 159 /* Initializes the interaction constant data structure. Currently it
 160  * uses forcerec as input.
 161  */
 162
 163 void init_forcerec(FILE       *fplog,
 164                           const output_env_t oenv,
 165                           t_forcerec *fr,
 166                           t_fcdata   *fcd,
 167                           const t_inputrec *ir,
 168                           const gmx_mtop_t *mtop,
 169                           const t_commrec  *cr,
 170                           matrix     box,
 171                           gmx_bool       bMolEpot,
 172                           const char *tabfn,
 173                           const char *tabafn,
 174                           const char *tabpfn,
 175                           const char *tabbfn,
 176                           const char *nbpu_opt,
 177                           gmx_bool   bNoSolvOpt,
 178                           real       print_force);
 179 /* The Force rec struct must be created with mk_forcerec
 180  * The gmx_booleans have the following meaning:
 181  * bSetQ:    Copy the charges [ only necessary when they change ]
 182  * bMolEpot: Use the free energy stuff per molecule
 183  * print_force >= 0: print forces for atoms with force >= print_force
 184  */
 185
 186 void forcerec_set_excl_load(t_forcerec *fr,
 187                             const gmx_localtop_t *top,const t_commrec *cr);
 188   /* Set the exclusion load for the local exclusions and possibly threads */
 189
 190 void init_enerdata(int ngener,int n_lambda,gmx_enerdata_t *enerd);
 191 /* Intializes the energy storage struct */
 192
 193 void destroy_enerdata(gmx_enerdata_t *enerd);
 194 /* Free all memory associated with enerd */
 195
 196 void reset_enerdata(t_grpopts *opts,
 197                            t_forcerec *fr,gmx_bool bNS,
 198                            gmx_enerdata_t *enerd,
 199                            gmx_bool bMaster);
 200 /* Resets the energy data, if bNS=TRUE also zeros the long-range part */
 201
 202 void sum_epot(t_grpopts *opts,gmx_enerdata_t *enerd);
 203 /* Locally sum the non-bonded potential energy terms */
 204
 205 void sum_dhdl(gmx_enerdata_t *enerd,real *lambda,t_lambda *fepvals);
 206 /* Sum the free energy contributions */
 207
 208 void update_forcerec(FILE *fplog,t_forcerec *fr,matrix box);
 209 /* Updates parameters in the forcerec that are time dependent */
 210
 211 /* Compute the average C6 and C12 params for LJ corrections */
 212 void set_avcsixtwelve(FILE *fplog,t_forcerec *fr,
 213                              const gmx_mtop_t *mtop);
 214
 215 extern void do_force(FILE *log,t_commrec *cr,
 216                      t_inputrec *inputrec,
 217                      gmx_large_int_t step,t_nrnb *nrnb,gmx_wallcycle_t wcycle,
 218                      gmx_localtop_t *top,
 219                      gmx_mtop_t *mtop,
 220                      gmx_groups_t *groups,
 221                      matrix box,rvec x[],history_t *hist,
 222                      rvec f[],
 223                      tensor vir_force,
 224                      t_mdatoms *mdatoms,
 225                      gmx_enerdata_t *enerd,t_fcdata *fcd,
 226                      real *lambda,t_graph *graph,
 227                      t_forcerec *fr,
 228                      gmx_vsite_t *vsite,rvec mu_tot,
 229                      double t,FILE *field,gmx_edsam_t ed,
 230                      gmx_bool bBornRadii,
 231                      int flags);
 232
 233 /* Communicate coordinates (if parallel).
 234  * Do neighbor searching (if necessary).
 235  * Calculate forces.
 236  * Communicate forces (if parallel).
 237  * Spread forces for vsites (if present).
 238  *
 239  * f is always required.
 240  */
 241
 242 void ns(FILE       *fplog,
 243                t_forcerec *fr,
 244                rvec       x[],
 245                matrix     box,
 246                gmx_groups_t *groups,
 247                t_grpopts  *opts,
 248                gmx_localtop_t *top,
 249                t_mdatoms  *md,
 250                t_commrec  *cr,
 251                t_nrnb     *nrnb,
 252                real       *lambda,
 253                real       *dvdlambda,
 254                gmx_grppairener_t *grppener,
 255                gmx_bool       bFillGrid,
 256            gmx_bool       bDoLongRangeNS);
 257 /* Call the neighborsearcher */
 258
 259 extern void do_force_lowlevel(FILE         *fplog,
 260                               gmx_large_int_t   step,
 261                               t_forcerec   *fr,
 262                               t_inputrec   *ir,
 263                               t_idef       *idef,
 264                               t_commrec    *cr,
 265                               t_nrnb       *nrnb,
 266                               gmx_wallcycle_t wcycle,
 267                               t_mdatoms    *md,
 268                               t_grpopts    *opts,
 269                               rvec         x[],
 270                               history_t    *hist,
 271                               rvec         f_shortrange[],
 272                   rvec         f_longrange[],
 273                               gmx_enerdata_t *enerd,
 274                               t_fcdata     *fcd,
 275                               gmx_mtop_t     *mtop,
 276                               gmx_localtop_t *top,
 277                               gmx_genborn_t *born,
 278                               t_atomtypes  *atype,
 279                               gmx_bool         bBornRadii,
 280                               matrix       box,
 281                               t_lambda     *fepvals,
 282                               real         *lambda,
 283                               t_graph      *graph,
 284                               t_blocka     *excl,
 285                               rvec         mu_tot[2],
 286                               int          flags,
 287                               float        *cycles_pme);
 288 /* Call all the force routines */
 289
 290 #ifdef __cplusplus
 291 }
 292 #endif
 293
 294 #endif  /* _force_h */