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