src/gromacs/gmxpreprocess/genhydro.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_GENHYDRO_H
  39 #define GMX_GMXPREPROCESS_GENHYDRO_H
  40
  41 #include "gromacs/fileio/pdbio.h"
  42 #include "gromacs/gmxpreprocess/hackblock.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 int add_h(t_atoms **pdbaptr, rvec *xptr[],
  49           int nah, t_hackblock ah[],
  50           int nterpairs,
  51           t_hackblock **ntdb, t_hackblock **ctdb,
  52           int *rN, int *rC, gmx_bool bMissing,
  53           int **nabptr, t_hack ***abptr,
  54           gmx_bool bUpdate_pdba, gmx_bool bKeep_old_pdba);
  55 /* Generate hydrogen atoms and N and C terminal patches.
  56  * int nterpairs is the number of termini pairs in the molecule
  57  * ntdb[i] and ctdb[i] may be NULL, no replacement will be done then.
  58  * rN[i] is the residue number of the N-terminus of chain i,
  59  * rC[i] is the residue number of the C-terminus of chain i
  60  * if bMissing==TRUE, continue when atoms are not found
  61  * if nabptr && abptrb, the hack array will be returned in them to be used
  62  * a second time
  63  * if bUpdate_pdba, hydrogens are added to *pdbaptr, else it is unchanged
  64  * return the New total number of atoms
  65  */
  66
  67 int protonate(t_atoms **atoms, rvec **x, t_protonate *protdata);
  68 /* Protonate molecule according to oplsaa.ff/aminoacids.hdb
  69  * when called the first time, new atoms are added to atoms,
  70  * second time only coordinates are generated
  71  * return the new total number of atoms
  72  */
  73
  74 void deprotonate(t_atoms *atoms, rvec *x);
  75 /* Deprotonate any molecule: all atoms whose name begins with H will be
  76  * removed
  77  */
  78
  79 #ifdef __cplusplus
  80 }
  81 #endif
  82
  83 #endif