Fix remaining copyright headers
[alexxy/gromacs.git] / src / gromacs / legacyheaders / grompp.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, 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 _grompp_h
39 #define _grompp_h
40
41 #include <stdio.h>
42 #include "typedefs.h"
43
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47
48 #define MAXSLEN 32
49
50 typedef struct {
51     gmx_bool bSet;              /* Has this combination been set        */
52     real     c[4];              /* The non-bonded parameters            */
53 } t_nbparam;
54 /* The t_nbparam struct is used to temporary store the explicit
55  * non-bonded parameter combinations, which will be copied to t_params.
56  */
57
58 typedef struct {
59     atom_id    a[MAXATOMLIST];   /* The atom list (eg. bonds: particle  */
60     /* i = a[0] (AI), j = a[1] (AJ))    */
61     real       c[MAXFORCEPARAM]; /* Force parameters (eg. b0 = c[0])    */
62     char       s[MAXSLEN];       /* A string (instead of parameters),    *
63                                   * read from the .rtp file in pdb2gmx   */
64 } t_param;
65
66 typedef struct {
67     int          nr;    /* The number of bonds in this record   */
68     int          maxnr; /* The amount of elements in the array  */
69     t_param     *param; /* Array of parameters (dim: nr)        */
70
71     /* CMAP tmp data, there are probably better places for this */
72     int         grid_spacing; /* Cmap grid spacing */
73     int         nc;           /* Number of cmap angles */
74
75     real       *cmap;         /* Temporary storage of the raw cmap grid data */
76     int         ncmap;        /* Number of allocated elements in cmap grid*/
77
78     int        *cmap_types;   /* Store the five atomtypes followed by a number that identifies the type */
79     int         nct;          /* Number of allocated elements in cmap_types */
80
81 } t_params;
82
83 typedef struct {
84     int            nr;          /* The number of exclusions             */
85     atom_id       *e;           /* The excluded atoms                   */
86 } t_excls;
87
88 typedef struct {
89     char            **name;
90     int               nrexcl;       /* Number of exclusions per atom    */
91     gmx_bool          excl_set;     /* Have exclusions been generated?  */
92     gmx_bool          bProcessed;   /* Has the mol been processed           */
93     t_atoms           atoms;        /* Atoms                                */
94     t_block           cgs;          /* Charge groups                        */
95     t_block           mols;         /* Molecules                            */
96     t_blocka          excls;        /* Exclusions                           */
97     t_params          plist[F_NRE]; /* Parameters in old style              */
98 } t_molinfo;
99
100 typedef struct {
101     char *name;
102     int   nr;
103 } t_mols;
104
105 gmx_bool is_int(double x);
106 /* Returns TRUE when x is integer */
107
108 /* Must correspond to strings in topdirs.c */
109 typedef enum {
110     d_defaults,
111     d_atomtypes,
112     d_bondtypes,
113     d_constrainttypes,
114     d_pairtypes,
115     d_angletypes,
116     d_dihedraltypes,
117     d_nonbond_params,
118     d_implicit_genborn_params,
119     d_implicit_surface_params,
120     d_cmaptypes,
121     d_moleculetype,
122     d_atoms,
123     d_vsites2,
124     d_vsites3,
125     d_vsites4,
126     d_vsitesn,
127     d_bonds,
128     d_exclusions,
129     d_pairs,
130     d_pairs_nb,
131     d_angles,
132     d_dihedrals,
133     d_constraints,
134     d_settles,
135     d_polarization,
136     d_water_polarization,
137     d_thole_polarization,
138     d_system,
139     d_molecules,
140     d_position_restraints,
141     d_angle_restraints,
142     d_angle_restraints_z,
143     d_distance_restraints,
144     d_orientation_restraints,
145     d_dihedral_restraints,
146     d_cmap,
147     d_maxdir,
148     d_invalid,
149     d_none
150 } directive;
151
152 #ifdef __cplusplus
153 }
154 #endif
155
156 #endif  /* _grompp_h */