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