Sort all includes in src/gromacs
[alexxy/gromacs.git] / src / gromacs / gmxana / hxprops.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  * 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
38 #ifndef _hxprops_h
39 #define _hxprops_h
40
41 #include <stdio.h>
42
43 #include "gromacs/legacyheaders/typedefs.h"
44
45 #define PHI_AHX (-55.0)
46 #define PSI_AHX (-45.0)
47 /* Canonical values of the helix phi/psi angles */
48
49
50 typedef struct {
51     real     phi, psi, pprms2;
52     real     jcaha;
53     real     d3, d4, d5, rmsa;
54     gmx_bool bHelix;
55     int      nhx;
56     int      nrms, resno;
57     int      Cprev, N, H, CA, C, O, Nnext;
58     char     label[32];
59 } t_bb;
60
61 enum {
62     efhRAD,  efhTWIST, efhRISE, efhLEN,
63     efhDIP,  efhRMS,   efhRMSA, efhCD222,
64     efhPPRMS, efhCPHI,  efhPHI,  efhPSI,
65     efhHB3,  efhHB4,   efhHB5,  efhJCA,
66     efhAHX,  efhNR
67 };
68
69 extern real ahx_len(int gnx, atom_id index[], rvec x[]);
70 /* Assume we have a list of Calpha atoms only! */
71
72 extern real ellipticity(int nres, t_bb bb[]);
73
74 extern real radius(FILE *fp, int nca, atom_id ca_index[], rvec x[]);
75 /* Assume we have calphas */
76
77 extern real twist(int nca, atom_id caindex[], rvec x[]);
78 /* Calculate the twist of the helix */
79
80 extern real pprms(FILE *fp, int nbb, t_bb bb[]);
81 /* Calculate the average RMS from canonical phi/psi values
82  * and the distance per residue
83  */
84
85 extern real ca_phi(int gnx, atom_id index[], rvec x[]);
86 /* Assume we have a list of Calpha atoms only! */
87
88 extern real dip(int nbb, atom_id bbind[], rvec x[], t_atom atom[]);
89
90 extern real rise(int gnx, atom_id index[], rvec x[]);
91 /* Assume we have a list of Calpha atoms only! */
92
93 extern void av_hblen(FILE *fp3, FILE *fp3a,
94                      FILE *fp4, FILE *fp4a,
95                      FILE *fp5, FILE *fp5a,
96                      real t, int nres, t_bb bb[]);
97
98 extern void av_phipsi(FILE *fphi, FILE *fpsi, FILE *fphi2, FILE *fpsi2,
99                       real t, int nres, t_bb bb[]);
100
101 extern t_bb *mkbbind(const char *fn, int *nres, int *nbb, int res0,
102                      int *nall, atom_id **index,
103                      char ***atomname, t_atom atom[],
104                      t_resinfo *resinfo);
105
106 extern void do_start_end(int nres, t_bb bb[], int *nbb,
107                          atom_id bbindex[], int *nca, atom_id caindex[],
108                          gmx_bool bRange, int rStart, int rEnd);
109
110 extern void calc_hxprops(int nres, t_bb bb[], rvec x[]);
111
112 extern void pr_bb(FILE *fp, int nres, t_bb bb[]);
113
114 #endif