Sort all includes in src/gromacs
[alexxy/gromacs.git] / src / gromacs / gmxana / dlist.c
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 #include "gmxpre.h"
38
39 #include <stdlib.h>
40 #include <string.h>
41
42 #include "gromacs/gmxana/gstat.h"
43 #include "gromacs/topology/residuetypes.h"
44 #include "gromacs/utility/fatalerror.h"
45 #include "gromacs/utility/smalloc.h"
46
47 t_dlist *mk_dlist(FILE *log,
48                   t_atoms *atoms, int *nlist,
49                   gmx_bool bPhi, gmx_bool bPsi, gmx_bool bChi, gmx_bool bHChi,
50                   int maxchi, int r0, gmx_residuetype_t *rt)
51 {
52     int       ires, i, j, k, ii;
53     t_dihatms atm, prev;
54     int       nl = 0, nc[edMax];
55     char     *thisres;
56     t_dlist  *dl;
57
58     snew(dl, atoms->nres+1);
59     prev.C = prev.Cn[1] = -1; /* Keep the compiler quiet */
60     for (i = 0; (i < edMax); i++)
61     {
62         nc[i] = 0;
63     }
64     ires = -1;
65     i    =  0;
66     while (i < atoms->nr)
67     {
68         ires = atoms->atom[i].resind;
69
70         /* Initiate all atom numbers to -1 */
71         atm.minC = atm.H = atm.N = atm.C = atm.O = atm.minCalpha = -1;
72         for (j = 0; (j < MAXCHI+3); j++)
73         {
74             atm.Cn[j] = -1;
75         }
76
77         /* Look for atoms in this residue */
78         /* maybe should allow for chis to hydrogens? */
79         while ((i < atoms->nr) && (atoms->atom[i].resind == ires))
80         {
81             if ((strcmp(*(atoms->atomname[i]), "H") == 0) ||
82                 (strcmp(*(atoms->atomname[i]), "H1") == 0) ||
83                 (strcmp(*(atoms->atomname[i]), "HN") == 0) )
84             {
85                 atm.H = i;
86             }
87             else if (strcmp(*(atoms->atomname[i]), "N") == 0)
88             {
89                 atm.N = i;
90             }
91             else if (strcmp(*(atoms->atomname[i]), "C") == 0)
92             {
93                 atm.C = i;
94             }
95             else if ((strcmp(*(atoms->atomname[i]), "O") == 0) ||
96                      (strcmp(*(atoms->atomname[i]), "O1") == 0) ||
97                      (strcmp(*(atoms->atomname[i]), "OC1") == 0) ||
98                      (strcmp(*(atoms->atomname[i]), "OT1") == 0))
99             {
100                 atm.O = i;
101             }
102             else if (strcmp(*(atoms->atomname[i]), "CA") == 0)
103             {
104                 atm.Cn[1] = i;
105             }
106             else if (strcmp(*(atoms->atomname[i]), "CB") == 0)
107             {
108                 atm.Cn[2] = i;
109             }
110             else if ((strcmp(*(atoms->atomname[i]), "CG") == 0)  ||
111                      (strcmp(*(atoms->atomname[i]), "CG1") == 0) ||
112                      (strcmp(*(atoms->atomname[i]), "OG") == 0)  ||
113                      (strcmp(*(atoms->atomname[i]), "OG1") == 0) ||
114                      (strcmp(*(atoms->atomname[i]), "SG") == 0))
115             {
116                 atm.Cn[3] = i;
117             }
118             else if ((strcmp(*(atoms->atomname[i]), "CD") == 0)  ||
119                      (strcmp(*(atoms->atomname[i]), "CD1") == 0) ||
120                      (strcmp(*(atoms->atomname[i]), "SD") == 0)  ||
121                      (strcmp(*(atoms->atomname[i]), "OD1") == 0) ||
122                      (strcmp(*(atoms->atomname[i]), "ND1") == 0))
123             {
124                 atm.Cn[4] = i;
125             }
126             /* by grs - split the Cn[4] into 2 bits to check allowing dih to H */
127             else if (bHChi && ((strcmp(*(atoms->atomname[i]), "HG")  == 0) ||
128                                (strcmp(*(atoms->atomname[i]), "HG1")  == 0)) )
129             {
130                 atm.Cn[4] = i;
131             }
132             else if ((strcmp(*(atoms->atomname[i]), "CE") == 0) ||
133                      (strcmp(*(atoms->atomname[i]), "CE1") == 0) ||
134                      (strcmp(*(atoms->atomname[i]), "OE1") == 0) ||
135                      (strcmp(*(atoms->atomname[i]), "NE") == 0))
136             {
137                 atm.Cn[5] = i;
138             }
139             else if ((strcmp(*(atoms->atomname[i]), "CZ") == 0) ||
140                      (strcmp(*(atoms->atomname[i]), "NZ") == 0))
141             {
142                 atm.Cn[6] = i;
143             }
144             /* HChi flag here too */
145             else if (bHChi && (strcmp(*(atoms->atomname[i]), "NH1") == 0))
146             {
147                 atm.Cn[7] = i;
148             }
149             i++;
150         }
151
152         thisres = *(atoms->resinfo[ires].name);
153
154         /* added by grs - special case for aromatics, whose chis above 2 are
155            not real and produce rubbish output - so set back to -1 */
156         if (strcmp(thisres, "PHE") == 0 ||
157             strcmp(thisres, "TYR") == 0 ||
158             strcmp(thisres, "PTR") == 0 ||
159             strcmp(thisres, "TRP") == 0 ||
160             strcmp(thisres, "HIS") == 0 ||
161             strcmp(thisres, "HISA") == 0 ||
162             strcmp(thisres, "HISB") == 0)
163         {
164             for (ii = 5; ii <= 7; ii++)
165             {
166                 atm.Cn[ii] = -1;
167             }
168         }
169         /* end fixing aromatics */
170
171         /* Special case for Pro, has no H */
172         if (strcmp(thisres, "PRO") == 0)
173         {
174             atm.H = atm.Cn[4];
175         }
176         /* Carbon from previous residue */
177         if (prev.C != -1)
178         {
179             atm.minC = prev.C;
180         }
181         /* Alpha-carbon from previous residue */
182         if (prev.Cn[1] != -1)
183         {
184             atm.minCalpha = prev.Cn[1];
185         }
186         prev = atm;
187
188         /* Check how many dihedrals we have */
189         if ((atm.N != -1) && (atm.Cn[1] != -1) && (atm.C != -1) &&
190             (atm.O != -1) && ((atm.H != -1) || (atm.minC != -1)))
191         {
192             dl[nl].resnr     = ires+1;
193             dl[nl].atm       = atm;
194             dl[nl].atm.Cn[0] = atm.N;
195             if ((atm.Cn[3] != -1) && (atm.Cn[2] != -1) && (atm.Cn[1] != -1))
196             {
197                 nc[0]++;
198                 if (atm.Cn[4] != -1)
199                 {
200                     nc[1]++;
201                     if (atm.Cn[5] != -1)
202                     {
203                         nc[2]++;
204                         if (atm.Cn[6] != -1)
205                         {
206                             nc[3]++;
207                             if (atm.Cn[7] != -1)
208                             {
209                                 nc[4]++;
210                                 if (atm.Cn[8] != -1)
211                                 {
212                                     nc[5]++;
213                                 }
214                             }
215                         }
216                     }
217                 }
218             }
219             if ((atm.minC != -1) && (atm.minCalpha != -1))
220             {
221                 nc[6]++;
222             }
223             dl[nl].index = gmx_residuetype_get_index(rt, thisres);
224
225             sprintf(dl[nl].name, "%s%d", thisres, ires+r0);
226             nl++;
227         }
228         else if (debug)
229         {
230             fprintf(debug, "Could not find N atom but could find other atoms"
231                     " in residue %s%d\n", thisres, ires+r0);
232         }
233     }
234     fprintf(stderr, "\n");
235     fprintf(log, "\n");
236     fprintf(log, "There are %d residues with dihedrals\n", nl);
237     j = 0;
238     if (bPhi)
239     {
240         j += nl;
241     }
242     if (bPsi)
243     {
244         j += nl;
245     }
246     if (bChi)
247     {
248         for (i = 0; (i < maxchi); i++)
249         {
250             j += nc[i];
251         }
252     }
253     fprintf(log, "There are %d dihedrals\n", j);
254     fprintf(log, "Dihedral: ");
255     if (bPhi)
256     {
257         fprintf(log, " Phi  ");
258     }
259     if (bPsi)
260     {
261         fprintf(log, " Psi  ");
262     }
263     if (bChi)
264     {
265         for (i = 0; (i < maxchi); i++)
266         {
267             fprintf(log, "Chi%d  ", i+1);
268         }
269     }
270     fprintf(log, "\nNumber:   ");
271     if (bPhi)
272     {
273         fprintf(log, "%4d  ", nl);
274     }
275     if (bPsi)
276     {
277         fprintf(log, "%4d  ", nl);
278     }
279     if (bChi)
280     {
281         for (i = 0; (i < maxchi); i++)
282         {
283             fprintf(log, "%4d  ", nc[i]);
284         }
285     }
286     fprintf(log, "\n");
287
288     *nlist = nl;
289
290     return dl;
291 }
292
293 gmx_bool has_dihedral(int Dih, t_dlist *dl)
294 {
295     gmx_bool b = FALSE;
296     int      ddd;
297
298     switch (Dih)
299     {
300         case edPhi:
301             b = ((dl->atm.H != -1) && (dl->atm.N != -1) && (dl->atm.Cn[1] != -1) && (dl->atm.C != -1));
302             break;
303         case edPsi:
304             b = ((dl->atm.N != -1) && (dl->atm.Cn[1] != -1) && (dl->atm.C != -1) && (dl->atm.O != -1));
305             break;
306         case edOmega:
307             b = ((dl->atm.minCalpha != -1) && (dl->atm.minC != -1) && (dl->atm.N != -1) && (dl->atm.Cn[1] != -1));
308             break;
309         case edChi1:
310         case edChi2:
311         case edChi3:
312         case edChi4:
313         case edChi5:
314         case edChi6:
315             ddd = Dih - edChi1;
316             b   = ((dl->atm.Cn[ddd] != -1) &&  (dl->atm.Cn[ddd+1] != -1) &&
317                    (dl->atm.Cn[ddd+2] != -1) && (dl->atm.Cn[ddd+3] != -1));
318             break;
319         default:
320             pr_dlist(stdout, 1, dl, 1, 0, TRUE, TRUE, TRUE, TRUE, MAXCHI);
321             gmx_fatal(FARGS, "Non existant dihedral %d in file %s, line %d",
322                       Dih, __FILE__, __LINE__);
323     }
324     return b;
325 }
326
327 static void pr_one_ro(FILE *fp, t_dlist *dl, int nDih, real gmx_unused dt)
328 {
329     int k;
330     for (k = 0; k < NROT; k++)
331     {
332         fprintf(fp, "  %6.2f", dl->rot_occ[nDih][k]);
333     }
334     fprintf(fp, "\n");
335 }
336
337 static void pr_ntr_s2(FILE *fp, t_dlist *dl, int nDih, real dt)
338 {
339     fprintf(fp, "  %6.2f  %6.2f\n", (dt == 0) ? 0 : dl->ntr[nDih]/dt, dl->S2[nDih]);
340 }
341
342 void pr_dlist(FILE *fp, int nl, t_dlist dl[], real dt, int printtype,
343               gmx_bool bPhi, gmx_bool bPsi, gmx_bool bChi, gmx_bool bOmega, int maxchi)
344 {
345     int   i, Xi;
346
347     void  (*pr_props)(FILE *, t_dlist *, int, real);
348
349     /* Analysis of dihedral transitions etc */
350
351     if (printtype == edPrintST)
352     {
353         pr_props = pr_ntr_s2;
354         fprintf(stderr, "Now printing out transitions and OPs...\n");
355     }
356     else
357     {
358         pr_props = pr_one_ro;
359         fprintf(stderr, "Now printing out rotamer occupancies...\n");
360         fprintf(fp, "\nXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n\n");
361     }
362
363     /* change atom numbers from 0 based to 1 based */
364     for (i = 0; (i < nl); i++)
365     {
366         fprintf(fp, "Residue %s\n", dl[i].name);
367         if (printtype == edPrintST)
368         {
369             fprintf(fp, " Angle [   AI,   AJ,   AK,   AL]  #tr/ns  S^2D  \n"
370                     "--------------------------------------------\n");
371         }
372         else
373         {
374             fprintf(fp, " Angle [   AI,   AJ,   AK,   AL]  rotamers  0  g(-)  t  g(+)\n"
375                     "--------------------------------------------\n");
376         }
377         if (bPhi)
378         {
379             fprintf(fp, "   Phi [%5d,%5d,%5d,%5d]",
380                     (dl[i].atm.H == -1) ? 1+dl[i].atm.minC : 1+dl[i].atm.H,
381                     1+dl[i].atm.N, 1+dl[i].atm.Cn[1], 1+dl[i].atm.C);
382             pr_props(fp, &dl[i], edPhi, dt);
383         }
384         if (bPsi)
385         {
386             fprintf(fp, "   Psi [%5d,%5d,%5d,%5d]", 1+dl[i].atm.N, 1+dl[i].atm.Cn[1],
387                     1+dl[i].atm.C, 1+dl[i].atm.O);
388             pr_props(fp, &dl[i], edPsi, dt);
389         }
390         if (bOmega && has_dihedral(edOmega, &(dl[i])))
391         {
392             fprintf(fp, " Omega [%5d,%5d,%5d,%5d]", 1+dl[i].atm.minCalpha, 1+dl[i].atm.minC,
393                     1+dl[i].atm.N, 1+dl[i].atm.Cn[1]);
394             pr_props(fp, &dl[i], edOmega, dt);
395         }
396         for (Xi = 0; Xi < MAXCHI; Xi++)
397         {
398             if (bChi && (Xi < maxchi) && (dl[i].atm.Cn[Xi+3] != -1) )
399             {
400                 fprintf(fp, "   Chi%d[%5d,%5d,%5d,%5d]", Xi+1, 1+dl[i].atm.Cn[Xi],
401                         1+dl[i].atm.Cn[Xi+1], 1+dl[i].atm.Cn[Xi+2],
402                         1+dl[i].atm.Cn[Xi+3]);
403                 pr_props(fp, &dl[i], Xi+edChi1, dt); /* Xi+2 was wrong here */
404             }
405         }
406         fprintf(fp, "\n");
407     }
408 }
409
410
411
412 int pr_trans(FILE *fp, int nl, t_dlist dl[], real dt, int Xi)
413 {
414     /* never called at the moment */
415
416     int  i, nn, nz;
417
418     nz = 0;
419     fprintf(fp, "\\begin{table}[h]\n");
420     fprintf(fp, "\\caption{Number of dihedral transitions per nanosecond}\n");
421     fprintf(fp, "\\begin{tabular}{|l|l|}\n");
422     fprintf(fp, "\\hline\n");
423     fprintf(fp, "Residue\t&$\\chi_%d$\t\\\\\n", Xi+1);
424     for (i = 0; (i < nl); i++)
425     {
426         nn = dl[i].ntr[Xi]/dt;
427
428         if (nn == 0)
429         {
430             fprintf(fp, "%s\t&\\HL{%d}\t\\\\\n", dl[i].name, nn);
431             nz++;
432         }
433         else if (nn > 0)
434         {
435             fprintf(fp, "%s\t&\\%d\t\\\\\n", dl[i].name, nn);
436         }
437     }
438     fprintf(fp, "\\hline\n");
439     fprintf(fp, "\\end{tabular}\n");
440     fprintf(fp, "\\end{table}\n\n");
441
442     return nz;
443 }