include/coulomb.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 _coulomb_h
  37 #define _coulomb_h
  38 #include "visibility.h"
  39 #include <stdio.h>
  40 #include "typedefs.h"
  41 #include "types/commrec.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /* Ewald related stuff */
  48
  49 void
  50 init_ewald_tab(ewald_tab_t *et, const t_commrec *cr, const t_inputrec *ir,
  51                    FILE *fp);
  52 /* initialize the ewald table (as found in the t_forcerec) */
  53
  54 GMX_LIBGMX_EXPORT
  55 real
  56 calc_ewaldcoeff(real rc,real dtol);
  57 /* Determines the Ewald parameter, both for Ewald and PME */
  58
  59
  60 real
  61 do_ewald(FILE *log,       gmx_bool bVerbose,
  62          t_inputrec *ir,
  63          rvec x[],        rvec f[],
  64          real chargeA[],  real chargeB[],
  65          rvec box,
  66          t_commrec *cr,  int natoms,
  67          matrix lrvir,   real ewaldcoeff,
  68          real lambda,    real *dvdlambda,
  69          ewald_tab_t et);
  70 /* Do an Ewald calculation for the long range electrostatics. */
  71
  72 GMX_LIBGMX_EXPORT
  73 real
  74 ewald_LRcorrection(FILE *fp,
  75                    int start,int end,
  76                    t_commrec *cr,int thread,t_forcerec *fr,
  77                    real *chargeA,real *chargeB,
  78                    gmx_bool calc_excl_corr,
  79                    t_blocka *excl,rvec x[],
  80                    matrix box,rvec mu_tot[],
  81                    int ewald_geometry,real epsilon_surface,
  82                    rvec *f,tensor vir,
  83                    real lambda,real *dvdlambda);
  84 /* Calculate the Long range correction to the Ewald sum,
  85  * due to excluded pairs and/or surface dipole terms.
  86  */
  87
  88 GMX_LIBGMX_EXPORT
  89 real
  90 ewald_charge_correction(t_commrec *cr,t_forcerec *fr,real lambda,matrix box,
  91                         real *dvdlambda,tensor vir);
  92 /* Calculate the Long range correction to the Ewald sum,
  93  * due to a net system charge.
  94  * Should only be called on one thread.
  95  */
  96
  97 /* Routines to set global constants for speeding up the calculation
  98  * of potentials and forces.
  99  */
 100 GMX_LIBGMX_EXPORT
 101 void
 102 set_shift_consts(FILE *log,real r1,real rc,rvec box,
 103                              t_forcerec *fr);
 104
 105 #ifdef __cplusplus
 106 }
 107 #endif
 108
 109 #endif
 110
 111