src/gromacs/legacyheaders/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
  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 real
  55 calc_ewaldcoeff(real rc, real dtol);
  56 /* Determines the Ewald parameter, both for Ewald and PME */
  57
  58
  59 real
  60 do_ewald(FILE *log,       gmx_bool bVerbose,
  61          t_inputrec *ir,
  62          rvec x[],        rvec f[],
  63          real chargeA[],  real chargeB[],
  64          rvec box,
  65          t_commrec *cr,  int natoms,
  66          matrix lrvir,   real ewaldcoeff,
  67          real lambda,    real *dvdlambda,
  68          ewald_tab_t et);
  69 /* Do an Ewald calculation for the long range electrostatics. */
  70
  71 real
  72 ewald_LRcorrection(FILE *fp,
  73                    int start, int end,
  74                    t_commrec *cr, int thread, t_forcerec *fr,
  75                    real *chargeA, real *chargeB,
  76                    gmx_bool calc_excl_corr,
  77                    t_blocka *excl, rvec x[],
  78                    matrix box, rvec mu_tot[],
  79                    int ewald_geometry, real epsilon_surface,
  80                    rvec *f, tensor vir,
  81                    real lambda, real *dvdlambda);
  82 /* Calculate the Long range correction to the Ewald sum,
  83  * due to excluded pairs and/or surface dipole terms.
  84  */
  85
  86 real
  87 ewald_charge_correction(t_commrec *cr, t_forcerec *fr, real lambda, matrix box,
  88                         real *dvdlambda, tensor vir);
  89 /* Calculate the Long range correction to the Ewald sum,
  90  * due to a net system charge.
  91  * Should only be called on one thread.
  92  */
  93
  94 /* Routines to set global constants for speeding up the calculation
  95  * of potentials and forces.
  96  */
  97 void
  98 set_shift_consts(FILE *log, real r1, real rc, rvec box,
  99                  t_forcerec *fr);
 100
 101 #ifdef __cplusplus
 102 }
 103 #endif
 104
 105 #endif