Merge branch 'release-4-5-patches'
[alexxy/gromacs.git] / src / gromacs / gmxpreprocess / genhydro.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  * Gallium Rubidium Oxygen Manganese Argon Carbon Silicon
34  */
35
36 #ifndef _genhydro_h
37 #define _genhydro_h
38
39 #include "pdbio.h"
40 #include "hackblock.h"
41
42 extern int add_h(t_atoms **pdbaptr, rvec *xptr[], 
43                  int nah, t_hackblock ah[],
44                  int nterpairs,
45                  t_hackblock **ntdb, t_hackblock **ctdb, 
46                  int *rN, int *rC, gmx_bool bMissing,
47                  int **nabptr, t_hack ***abptr,
48                  gmx_bool bUpdate_pdba, gmx_bool bKeep_old_pdba);
49 /* Generate hydrogen atoms and N and C terminal patches.
50  * int nterpairs is the number of termini pairs in the molecule
51  * ntdb[i] and ctdb[i] may be NULL, no replacement will be done then.
52  * rN[i] is the residue number of the N-terminus of chain i,
53  * rC[i] is the residue number of the C-terminus of chain i
54  * if bMissing==TRUE, conitue when atoms are not found
55  * if nabptr && abptrb, the hack array will be returned in them to be used
56  * a second time
57  * if bUpdate_pdba, hydrogens are added to *pdbaptr, else it is unchanged
58  * return the New total number of atoms 
59  */
60
61 extern int protonate(t_atoms **atoms, rvec **x, t_protonate *protdata);
62 /* Protonate molecule according to ffgmx2 
63  * when called the first time, new atoms are added to atoms, 
64  * second time only coordinates are generated
65  * return the New total number of atoms 
66  */
67
68 extern void deprotonate(t_atoms *atoms,rvec *x);
69 /* Deprotonate any molecule: all atoms whose name begins with H will be 
70  * removed 
71  */
72
73 #endif
74