Warn when a value is unused
[gromacs.git] / include / ns.h
blob526b926c597829df8d596b7fcd4d0de98278b5cd
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.
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.
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.
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.
30 * For more info, check our website at http://www.gromacs.org
32 * And Hey:
33 * Gromacs Runs On Most of All Computer Systems
36 #ifndef _ns_h
37 #define _ns_h
39 #include <stdio.h>
40 #include "sysstuff.h"
41 #include "typedefs.h"
42 #include "pbc.h"
43 #include "tgroup.h"
44 #include "network.h"
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
51 /****************************************************
53 * U T I L I T I E S May be found in ns.c
55 ****************************************************/
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
65 int calc_naaj(int icg,int cgtot);
66 /* Calculate the number of charge groups to interact with for icg */
68 /****************************************************
70 * N E I G H B O R S E A R C H I N G
72 * Calls either ns5_core (when grid selected in .mdp file)
73 * or ns_simple_core (when simple selected in .mdp file)
75 * Return total number of pairs searched
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 matrix box);
83 int search_neighbours(FILE *log,t_forcerec *fr,
84 rvec x[],matrix box,
85 gmx_localtop_t *top,
86 gmx_groups_t *groups,
87 t_commrec *cr,
88 t_nrnb *nrnb,t_mdatoms *md,
89 real lambda,real *dvdlambda,
90 gmx_grppairener_t *grppener,
91 gmx_bool bFillGrid,
92 gmx_bool bDoLongRange,
93 gmx_bool bDoForces,rvec *f);
96 /* Debugging routines from wnblist.c */
97 void dump_nblist(FILE *out,t_commrec *cr,t_forcerec *fr,int nDNL);
99 int read_nblist(FILE *in,FILE *out,int **mat,int natoms,gmx_bool bSymm);
100 /* Returns total number of neighbors. If bSymm the matrix is symmetrized. */
102 int natoms_beyond_ns_buffer(t_inputrec *ir,t_forcerec *fr,t_block *cgs,
103 matrix scale_tot,rvec *x);
104 /* Returns the number of atoms that moved beyond the ns buffer */
106 #ifdef __cplusplus
108 #endif
111 #endif /* _ns_h */