src/gromacs/gmxpreprocess/pdb2top.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_PDB2TOP_H
  39 #define GMX_GMXPREPROCESS_PDB2TOP_H
  40
  41 #include "gromacs/gmxpreprocess/gpp_atomtype.h"
  42 #include "gromacs/gmxpreprocess/grompp-impl.h"
  43 #include "gromacs/gmxpreprocess/hackblock.h"
  44 #include "gromacs/gmxpreprocess/toputil.h"
  45 #include "gromacs/legacyheaders/typedefs.h"
  46
  47 /* this *MUST* correspond to array in pdb2top.c */
  48 enum {
  49     ehisA, ehisB, ehisH, ehis1, ehisNR
  50 };
  51 extern const char *hh[ehisNR];
  52
  53 typedef struct {
  54     int   res1, res2;
  55     char *a1, *a2;
  56 } t_ssbond;
  57
  58 void choose_ff(const char *ffsel,
  59                char *forcefield, int ff_maxlen,
  60                char *ffdir, int ffdir_maxlen);
  61 /* Find force fields in the current and libdirs and choose an ff.
  62  * If ffsel!=NULL: search for ffsel.
  63  * If ffsel==NULL: interactive selection.
  64  */
  65
  66 void choose_watermodel(const char *wmsel, const char *ffdir,
  67                        char **watermodel);
  68 /* Choose, possibly interactively, which water model to include,
  69  * based on the wmsel command line option choice and watermodels.dat
  70  * in ffdir.
  71  */
  72
  73 void get_hackblocks_rtp(t_hackblock **hb, t_restp **restp,
  74                         int nrtp, t_restp rtp[],
  75                         int nres, t_resinfo *resinfo,
  76                         int nterpairs,
  77                         t_hackblock **ntdb, t_hackblock **ctdb,
  78                         int *rn, int *rc);
  79 /* Get the database entries for the nres residues in resinfo
  80  * and store them in restp and hb.
  81  */
  82
  83 void match_atomnames_with_rtp(t_restp restp[], t_hackblock hb[],
  84                               t_atoms *pdba, rvec *x,
  85                               gmx_bool bVerbose);
  86 /* Check if atom in pdba need to be deleted of renamed due to tdb or hdb.
  87  * If renaming involves atoms added wrt to the rtp database,
  88  * add these atoms to restp.
  89  */
  90
  91 void print_top_comment(FILE *out, const char *filename, const char *ffdir, gmx_bool bITP);
  92
  93 void print_top_header(FILE *out, const char *filename, gmx_bool bITP,
  94                       const char *ffdir, real mHmult);
  95
  96 void print_top_mols(FILE *out,
  97                     const char *title, const char *ffdir, const char *water,
  98                     int nincl, char **incls,
  99                     int nmol, t_mols *mols);
 100
 101 void write_top(FILE *out, char *pr, char *molname,
 102                t_atoms *at, gmx_bool bRTPresname,
 103                int bts[], t_params plist[], t_excls excls[],
 104                gpp_atomtype_t atype, int *cgnr, int nrexcl);
 105 /* NOTE: nrexcl is not the size of *excl! */
 106
 107
 108 void pdb2top(FILE *top_file, char *posre_fn, char *molname,
 109              t_atoms *atoms, rvec **x,
 110              gpp_atomtype_t atype, struct t_symtab *tab,
 111              int nrtp, t_restp rtp[],
 112              t_restp *restp, t_hackblock *hb,
 113              gmx_bool bAllowMissing,
 114              gmx_bool bVsites, gmx_bool bVsiteAromatics,
 115              const char *ffdir,
 116              real mHmult,
 117              int nssbonds, t_ssbond ssbonds[],
 118              real long_bond_dist, real short_bond_dist,
 119              gmx_bool bDeuterate, gmx_bool bChargeGroups, gmx_bool bCmap,
 120              gmx_bool bRenumRes, gmx_bool bRTPresname);
 121 /* Create a topology ! */
 122
 123 void print_sums(t_atoms *atoms, gmx_bool bSystem);
 124
 125 #endif