Update copyright statements and change license to LGPL
[alexxy/gromacs.git] / src / kernel / toppush.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  * check out http://www.gromacs.org for more information.
7  * Copyright (c) 2012, by the GROMACS development team, led by
8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
9  * others, as listed in the AUTHORS file in the top-level source
10  * directory and at http://www.gromacs.org.
11  *
12  * GROMACS is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU Lesser General Public License
14  * as published by the Free Software Foundation; either version 2.1
15  * of the License, or (at your option) any later version.
16  *
17  * GROMACS is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20  * Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with GROMACS; if not, see
24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
26  *
27  * If you want to redistribute modifications to GROMACS, please
28  * consider that scientific software is very special. Version
29  * control is crucial - bugs must be traceable. We will be happy to
30  * consider code for inclusion in the official distribution, but
31  * derived work must not be called official GROMACS. Details are found
32  * in the README & COPYING files - if they are missing, get the
33  * official version at http://www.gromacs.org.
34  *
35  * To help us fund GROMACS development, we humbly ask that you cite
36  * the research papers on the package. Check out http://www.gromacs.org.
37  */
38
39 #ifndef _toppush_h
40 #define _toppush_h
41
42 #include "typedefs.h"
43 #include "toputil.h"
44 #include "gpp_atomtype.h"
45 #include "gpp_bond_atomtype.h"
46 #include "warninp.h"
47
48 typedef struct {
49   int     nr;   /* The number of entries in the list                    */
50   int     nra2; /* The total number of entries in a                     */
51   atom_id *nra; /* The number of entries in each a array (dim nr)       */
52   atom_id **a;  /* The atom numbers (dim nr) the length of each element */
53                 /* i is nra[i]                                          */
54 } t_block2;
55
56 extern void generate_nbparams(int comb,int funct,t_params plist[],
57                               gpp_atomtype_t atype,
58                               warninp_t wi);
59                               
60 extern void push_at (t_symtab *symtab,gpp_atomtype_t at,
61                      t_bond_atomtype bat,char *line,int nb_funct,
62                      t_nbparam ***nbparam,t_nbparam ***pair,
63                      warninp_t wi);
64
65 extern void push_bt(directive d,t_params bt[], int nral,
66                     gpp_atomtype_t at,t_bond_atomtype bat,char *line,
67                     warninp_t wi);
68
69 extern void push_dihedraltype(directive d,t_params bt[],
70                               t_bond_atomtype bat,char *line,
71                               warninp_t wi);
72
73 extern void push_cmaptype(directive d,t_params bt[], int nral, gpp_atomtype_t at,
74                           t_bond_atomtype bat,char *line,
75                           warninp_t wi);
76
77 extern void push_nbt(directive d,t_nbparam **nbt,gpp_atomtype_t atype,
78                      char *plines,int nb_funct,
79                      warninp_t wi);
80
81 void
82 push_gb_params(gpp_atomtype_t atype,
83                char       *line,
84                warninp_t wi);
85
86 extern void push_atom(t_symtab   *symtab, 
87                       t_block    *cgs,
88                       t_atoms    *at,
89                       gpp_atomtype_t atype,
90                       char       *line,
91                       int        *lastcg,
92                       warninp_t  wi);
93
94 extern void push_bond(directive d,t_params bondtype[],t_params bond[],
95                       t_atoms *at,gpp_atomtype_t atype,char *line,
96                       gmx_bool bBonded,gmx_bool bGenPairs,real fudgeQQ,
97                       gmx_bool bZero,gmx_bool *bWarn_copy_A_B,
98                       warninp_t wi);
99
100 extern void push_cmap(directive d, t_params bondtype[], t_params bond[],
101                       t_atoms *at, gpp_atomtype_t atype, char *line,
102                       gmx_bool *bWarn_copy_A_B,
103                       warninp_t wi);
104
105 extern void push_vsitesn(directive d,t_params bondtype[],t_params bond[],
106                          t_atoms *at,gpp_atomtype_t atype,char *line,
107                          warninp_t wi);
108
109 extern void push_mol(int nrmols,t_molinfo mols[],char *pline,
110                      int *whichmol,int *nrcopies,
111                      warninp_t wi);
112
113 extern void push_molt(t_symtab *symtab,int *nmol,t_molinfo **mol,char *line,
114                       warninp_t wi);
115
116 extern void init_block2(t_block2 *b2, int natom);
117         
118 extern void done_block2(t_block2 *b2);
119
120 extern void push_excl(char *line, t_block2 *b2);
121
122 extern void merge_excl(t_blocka *excl, t_block2 *b2);
123
124 extern void b_to_b2(t_blocka *b, t_block2 *b2);
125
126 extern void b2_to_b(t_block2 *b2, t_blocka *b);
127
128 extern int add_atomtype_decoupled(t_symtab *symtab,gpp_atomtype_t at,
129                                   t_nbparam ***nbparam,t_nbparam ***pair);
130 /* Add an atom type with all parameters set to zero (no interactions).
131  * Returns the atom type number.
132  */
133
134 extern void convert_moltype_couple(t_molinfo *mol,int atomtype_decouple,
135                                    real fudgeQQ,
136                                    int couple_lam0,int couple_lam1,
137                                    gmx_bool bCoupleIntra,
138                                    int nb_funct,t_params *nbp);
139 /* Setup mol such that the B-state has no interaction with the rest
140  * of the system, but full interaction with itself.
141  */
142
143 #endif  /* _toppush_h */