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