a9d7202b5553eabf71443dc69edb2ddc787bdb14
[alexxy/gromacs.git] / src / gromacs / legacyheaders / ns.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-2004, 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 #ifndef _ns_h
39 #define _ns_h
40
41 #include <stdio.h>
42
43 #include "gromacs/legacyheaders/typedefs.h"
44 #include "gromacs/legacyheaders/tgroup.h"
45 #include "gromacs/legacyheaders/network.h"
46
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50
51 /****************************************************
52  *
53  *    U T I L I T I E S May be found in ns.c
54  *
55  ****************************************************/
56
57 void init_neighbor_list(FILE *log, t_forcerec *fr, int homenr);
58 /*
59  * nn is the number of energy terms in the energy matrix
60  * (ngener*(ngener-1))/2
61  * start is the first atom on this processor
62  * homenr is the number of atoms on this processor
63  */
64
65 int calc_naaj(int icg, int cgtot);
66 /* Calculate the number of charge groups to interact with for icg */
67
68 /****************************************************
69  *
70  *    N E I G H B O R  S E A R C H I N G
71  *
72  *    Calls either ns5_core (when grid selected in .mdp file)
73  *    or ns_simple_core (when simple selected in .mdp file)
74  *
75  *    Return total number of pairs searched
76  *
77  ****************************************************/
78 void init_ns(FILE *fplog, const t_commrec *cr,
79              gmx_ns_t *ns, t_forcerec *fr,
80              const gmx_mtop_t *mtop);
81
82 int search_neighbours(FILE *log, t_forcerec *fr, matrix box,
83                       gmx_localtop_t *top,
84                       gmx_groups_t *groups,
85                       t_commrec *cr,
86                       t_nrnb *nrnb, t_mdatoms *md,
87                       gmx_bool bFillGrid,
88                       gmx_bool bDoLongRangeNS);
89
90
91 /* Debugging routines from wnblist.c */
92 void dump_nblist(FILE *out, t_commrec *cr, t_forcerec *fr, int nDNL);
93
94 int read_nblist(FILE *in, FILE *out, int **mat, int natoms, gmx_bool bSymm);
95 /* Returns total number of neighbors. If bSymm the matrix is symmetrized. */
96
97 int natoms_beyond_ns_buffer(t_inputrec *ir, t_forcerec *fr, t_block *cgs,
98                             matrix scale_tot, rvec *x);
99 /* Returns the number of atoms that moved beyond the ns buffer */
100
101 void reallocate_nblist(t_nblist *nl);
102 /* List reallocation, only exported for Verlet scheme use with FEP */
103
104 #ifdef __cplusplus
105 }
106 #endif
107
108
109 #endif  /* _ns_h */