include/pme.h

   1 /*
   2  * $Id$
   3  *
   4  *                This source code is part of
   5  *
   6  *                 G   R   O   M   A   C   S
   7  *
   8  *          GROningen MAchine for Chemical Simulations
   9  *
  10  *                        VERSION 3.0
  11  *
  12  * Copyright (c) 1991-2001
  13  * BIOSON Research Institute, Dept. of Biophysical Chemistry
  14  * University of Groningen, The Netherlands
  15  *
  16  * This program is free software; you can redistribute it and/or
  17  * modify it under the terms of the GNU General Public License
  18  * as published by the Free Software Foundation; either version 2
  19  * of the License, or (at your option) any later version.
  20  *
  21  * If you want to redistribute modifications, please consider that
  22  * scientific software is very special. Version control is crucial -
  23  * bugs must be traceable. We will be happy to consider code for
  24  * inclusion in the official distribution, but derived work must not
  25  * be called official GROMACS. Details are found in the README & COPYING
  26  * files - if they are missing, get the official version at www.gromacs.org.
  27  *
  28  * To help us fund GROMACS development, we humbly ask that you cite
  29  * the papers on the package - you can find them in the top README file.
  30  *
  31  * Do check out http://www.gromacs.org , or mail us at gromacs@gromacs.org .
  32  *
  33  * And Hey:
  34  * Giving Russians Opium May Alter Current Situation
  35  */
  36
  37 #ifndef _pme_h
  38 #define _pme_h
  39
  40 static char *SRCID_pme_h = "$Id$";
  41 #ifdef HAVE_CONFIG_H
  42 #include <config.h>
  43 #endif
  44
  45 #include <stdio.h>
  46 #include "typedefs.h"
  47 #include "complex.h"
  48 #include "fftgrid.h"
  49
  50 typedef real *splinevec[DIM];
  51
  52 extern real do_pme(FILE *log,       bool bVerbose,
  53                    t_inputrec *ir,
  54                    rvec x[],        rvec f[],
  55                    real charge[],   matrix box,
  56                    t_commrec *cr,
  57                    t_nsborder *nsb, t_nrnb *nrnb,
  58                    matrix lrvir,real ewaldcoeff,
  59                    bool bGatherOnly);
  60
  61 /* Do a PME calculation for the long range electrostatics.
  62  * If bGatherOnly is set, the energy from the last computation will be used, and
  63  * the forces will be interpolated at the new positions. No new solving is done then.
  64  */
  65
  66 extern void sum_qgrid(t_commrec *cr,t_nsborder *nsb,t_fftgrid *grid,bool bForward);
  67
  68 extern void init_pme(FILE *log,t_commrec *cr,
  69                      int nkx,int nky,int nkz,int pme_order,int homenr,
  70                      bool bOptFFT);
  71
  72 /* Routine for spreading something on a grid. Can be misused for non-PME
  73  * related things. init_pme must be called before this guy.
  74  */
  75 extern t_fftgrid *spread_on_grid(FILE *logfile,   int homenr,
  76                                  int pme_order,   rvec x[],
  77                                  real charge[],   matrix box,
  78                                  bool bGatherOnly);
  79
  80 #endif