src/gromacs/gmxpreprocess/hackblock.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,2018, 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_HACKBLOCK_H
  39 #define GMX_GMXPREPROCESS_HACKBLOCK_H
  40
  41 #include "gromacs/gmxpreprocess/gpp_atomtype.h"
  42 #include "gromacs/gmxpreprocess/grompp-impl.h"
  43 #include "gromacs/topology/symtab.h"
  44
  45 /* Used for reading .rtp/.tdb */
  46 /* ebtsBONDS must be the first, new types can be added to the end */
  47 /* these *MUST* correspond to the arrays in hackblock.c */
  48 enum {
  49     ebtsBONDS, ebtsANGLES, ebtsPDIHS, ebtsIDIHS, ebtsEXCLS, ebtsCMAP, ebtsNR
  50 };
  51 extern const char *btsNames[ebtsNR];
  52 extern const int   btsNiatoms[ebtsNR];
  53
  54 /* if changing any of these structs, make sure that all of the
  55    free/clear/copy/merge_t_* functions stay updated */
  56
  57 /* BONDEDS */
  58 typedef struct {
  59     char  *a[MAXATOMLIST]; /* atom names */
  60     char  *s;              /* optional define string which gets copied from
  61                               .rtp/.tdb to .top and will be parsed by cpp
  62                               during grompp */
  63     bool match;            /* boolean to mark that the entry has been found */
  64     char*   &ai() { return a[0]; }
  65     char*   &aj() { return a[1]; }
  66     char*   &ak() { return a[2]; }
  67     char*   &al() { return a[3]; }
  68     char*   &am() { return a[4]; }
  69 } t_rbonded;
  70
  71 typedef struct {
  72     int        type;     /* The type of bonded interaction */
  73     int        nb;       /* number of bondeds */
  74     t_rbonded *b;        /* bondeds */
  75 } t_rbondeds;
  76
  77 /* RESIDUES (rtp) */
  78 typedef struct {
  79     char         *resname;
  80     /* The base file name this rtp entry was read from */
  81     char         *filebase;
  82     /* atom data */
  83     int           natom;
  84     t_atom       *atom;
  85     char       ***atomname;
  86     int          *cgnr;
  87     /* Bonded interaction setup */
  88     bool          bKeepAllGeneratedDihedrals;
  89     int           nrexcl;
  90     bool          bGenerateHH14Interactions;
  91     bool          bRemoveDihedralIfWithImproper;
  92     /* list of bonded interactions to add */
  93     t_rbondeds    rb[ebtsNR];
  94 } t_restp;
  95
  96 /* Block to hack residues */
  97 typedef struct {
  98     int      nr;      /* Number of atoms to hack    */
  99     char    *oname;   /* Old name                   */
 100     char    *nname;   /* New name                   */
 101     /* the type of hack depends on the setting of oname and nname:
 102      * if oname==NULL                we're adding, must have tp>0 also!
 103      * if oname!=NULL && nname==NULL we're deleting
 104      * if oname!=NULL && nname!=NULL we're replacing
 105      */
 106     t_atom     *atom; /* New atom data              */
 107     int         cgnr; /* chargegroup number. if not read will be NOTSET */
 108     int         tp;   /* Type of attachment (1..11) */
 109     int         nctl; /* How many control atoms there are */
 110     char       *a[4]; /* Control atoms i,j,k,l    */
 111     bool        bAlreadyPresent;
 112     bool        bXSet;
 113     rvec        newx; /* calculated new position    */
 114     int         newi; /* new atom index number (after additions) */
 115     char*      &ai() { return a[0]; }
 116     char*      &aj() { return a[1]; }
 117     char*      &ak() { return a[2]; }
 118     char*      &al() { return a[3]; }
 119 } t_hack;
 120
 121 typedef struct {
 122     char      *name;     /* Name of hack block (residue or terminus) */
 123     char      *filebase; /* The base file name this entry was read from */
 124     int        nhack;    /* Number of atoms to hack                  */
 125     int        maxhack;  /* used for efficient srenew-ing            */
 126     t_hack    *hack;     /* Hack list                                */
 127     /* list of bonded interactions to add */
 128     t_rbondeds rb[ebtsNR];
 129 } t_hackblock;
 130
 131 typedef struct {
 132     char *res1, *res2;
 133     char *atom1, *atom2;
 134     char *newres1, *newres2;
 135     int   nbond1, nbond2;
 136     real  length;
 137 } t_specbond;
 138
 139 t_specbond *get_specbonds(int *nspecbond);
 140 void done_specbonds(int nsb, t_specbond sb[]);
 141
 142 void free_t_restp(int nrtp, t_restp **rtp);
 143 void free_t_hack(int nh, t_hack **h);
 144 void free_t_hackblock(int nhb, t_hackblock **hb);
 145 /* free the whole datastructure */
 146
 147 void clear_t_hackblock(t_hackblock *hb);
 148 void clear_t_hack(t_hack *hack);
 149 /* reset struct */
 150
 151 bool merge_t_bondeds(t_rbondeds s[], t_rbondeds d[],
 152                      bool bMin, bool bPlus);
 153 /* add s[].b[] to d[].b[]
 154  * If bMin==TRUE, don't copy bondeds with atoms starting with '-'
 155  * If bPlus==TRUE, don't copy bondeds with atoms starting with '+'
 156  * Returns if bonds were removed at the termini.
 157  */
 158
 159 void copy_t_restp(t_restp *s, t_restp *d);
 160 void copy_t_hack(t_hack *s, t_hack *d);
 161 void copy_t_hackblock(t_hackblock *s, t_hackblock *d);
 162 /* make copy of whole datastructure */
 163
 164 void merge_hacks_lo(int ns, t_hack *s, int *nd, t_hack **d);
 165 /* add s[] to *d[] */
 166
 167 void merge_hacks(t_hackblock *s, t_hackblock *d);
 168 /* add s->hacks[] to d->hacks[] */
 169
 170 void merge_t_hackblock(t_hackblock *s, t_hackblock *d);
 171 /* add s->hacks[] and s->rb[] to d*/
 172
 173 void dump_hb(FILE *out, int nres, t_hackblock hb[]);
 174 /* print out whole datastructure */
 175
 176 #endif