Merge release-5-0 into master
[alexxy/gromacs.git] / src / gromacs / legacyheaders / genborn.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5  * Copyright (c) 2001-2008, The GROMACS development team.
6  * Copyright (c) 2013,2014, by the GROMACS development team, led by
7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8  * and including many others, as listed in the AUTHORS file in the
9  * top-level source directory and at http://www.gromacs.org.
10  *
11  * GROMACS is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public License
13  * as published by the Free Software Foundation; either version 2.1
14  * of the License, or (at your option) any later version.
15  *
16  * GROMACS is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with GROMACS; if not, see
23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
25  *
26  * If you want to redistribute modifications to GROMACS, please
27  * consider that scientific software is very special. Version
28  * control is crucial - bugs must be traceable. We will be happy to
29  * consider code for inclusion in the official distribution, but
30  * derived work must not be called official GROMACS. Details are found
31  * in the README & COPYING files - if they are missing, get the
32  * official version at http://www.gromacs.org.
33  *
34  * To help us fund GROMACS development, we humbly ask that you cite
35  * the research papers on the package. Check out http://www.gromacs.org.
36  */
37
38
39 #ifndef _genborn_h
40 #define _genborn_h
41
42 #include "gromacs/legacyheaders/typedefs.h"
43
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47
48 /* Still parameters - make sure to edit in genborn_sse.c too if you change these! */
49 #define STILL_P1  0.073*0.1              /* length        */
50 #define STILL_P2  0.921*0.1*CAL2JOULE    /* energy*length */
51 #define STILL_P3  6.211*0.1*CAL2JOULE    /* energy*length */
52 #define STILL_P4  15.236*0.1*CAL2JOULE
53 #define STILL_P5  1.254
54
55 #define STILL_P5INV (1.0/STILL_P5)
56 #define STILL_PIP5  (M_PI*STILL_P5)
57
58 struct t_graph;
59 struct t_pbc;
60
61 /* Initialise GB stuff */
62 int init_gb(gmx_genborn_t **p_born,
63             t_forcerec *fr, const t_inputrec *ir,
64             const gmx_mtop_t *mtop, int gb_algorithm);
65
66
67 /* Born radii calculations, both with and without SSE acceleration */
68 int calc_gb_rad(t_commrec *cr, t_forcerec *fr, t_inputrec *ir, gmx_localtop_t *top, rvec x[], t_nblist *nl, gmx_genborn_t *born, t_mdatoms *md, t_nrnb     *nrnb);
69
70
71
72 /* Bonded GB interactions */
73 real gb_bonds_tab(rvec x[], rvec f[], rvec fshift[], real *charge, real *p_gbtabscale,
74                   real *invsqrta, real *dvda, real *GBtab, t_idef *idef, real epsilon_r,
75                   real gb_epsilon_solvent, real facel, const struct t_pbc *pbc,
76                   const struct t_graph *graph);
77
78
79
80
81 /* Functions for calculating adjustments due to ie chain rule terms */
82 void
83 calc_gb_forces(t_commrec *cr, t_mdatoms *md, gmx_genborn_t *born, gmx_localtop_t *top,
84                rvec x[], rvec f[], t_forcerec *fr, t_idef *idef, int gb_algorithm, int sa_algorithm, t_nrnb *nrnb,
85                const struct t_pbc *pbc, const struct t_graph *graph, gmx_enerdata_t *enerd);
86
87
88 int
89 make_gb_nblist(t_commrec *cr, int gb_algorithm,
90                rvec x[], matrix box,
91                t_forcerec *fr, t_idef *idef, struct t_graph *graph, gmx_genborn_t *born);
92
93 void
94 make_local_gb(const t_commrec *cr, gmx_genborn_t *born, int gb_algorithm);
95
96 #ifdef __cplusplus
97 }
98 #endif
99
100 #endif /* _genborn_h */