Free-energy support for LJ-PME
[alexxy/gromacs.git] / src / gromacs / legacyheaders / tables.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2012,2014, by the GROMACS development team, led by
5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6  * and including many others, as listed in the AUTHORS file in the
7  * top-level source directory and at http://www.gromacs.org.
8  *
9  * GROMACS is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public License
11  * as published by the Free Software Foundation; either version 2.1
12  * of the License, or (at your option) any later version.
13  *
14  * GROMACS is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with GROMACS; if not, see
21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
23  *
24  * If you want to redistribute modifications to GROMACS, please
25  * consider that scientific software is very special. Version
26  * control is crucial - bugs must be traceable. We will be happy to
27  * consider code for inclusion in the official distribution, but
28  * derived work must not be called official GROMACS. Details are found
29  * in the README & COPYING files - if they are missing, get the
30  * official version at http://www.gromacs.org.
31  *
32  * To help us fund GROMACS development, we humbly ask that you cite
33  * the research papers on the package. Check out http://www.gromacs.org.
34  */
35
36 #ifndef _tables_h
37 #define _tables_h
38 #include "types/simple.h"
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 #if 0
44 }
45 #endif
46
47 typedef double (*real_space_grid_contribution_computer)(double, double);
48 /* Function pointer used to tell table_spline3_fill_ewald_lr whether it
49  * should calculate the grid contribution for electrostatics or LJ.
50  */
51
52 void table_spline3_fill_ewald_lr(real                                 *table_F,
53                                  real                                 *table_V,
54                                  real                                 *table_FDV0,
55                                  int                                   ntab,
56                                  real                                  dx,
57                                  real                                  beta,
58                                  real_space_grid_contribution_computer v_lr);
59 /* Fill tables of ntab points with spacing dr with the ewald long-range
60  * (mesh) force.
61  * There are three separate tables with format FDV0, F, and V.
62  * This function interpolates the Ewald mesh potential contribution
63  * with coefficient beta using a quadratic spline.
64  * The force can then be interpolated linearly.
65  */
66
67 real ewald_spline3_table_scale(real ewaldcoeff, real rc);
68 /* Return the scaling for the Ewald quadratic spline tables. */
69
70 double v_q_ewald_lr(double beta, double r);
71 /* Return the real space grid contribution for Ewald*/
72
73 double v_lj_ewald_lr(double beta, double r);
74 /* Return the real space grid contribution for LJ-Ewald*/
75
76 #ifdef __cplusplus
77 }
78 #endif
79
80 #endif  /* _tables\_h */