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