src/kernel/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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef _genhydro_h
  40 #define _genhydro_h
  41 #include "visibility.h"
  42 #include "pdbio.h"
  43 #include "hackblock.h"
  44
  45 GMX_LIBGMXPREPROCESS_EXPORT
  46 extern int add_h(t_atoms **pdbaptr, rvec *xptr[],
  47                  int nah, t_hackblock ah[],
  48                  int nterpairs,
  49                  t_hackblock **ntdb, t_hackblock **ctdb,
  50                  int *rN, int *rC, gmx_bool bMissing,
  51                  int **nabptr, t_hack ***abptr,
  52                  gmx_bool bUpdate_pdba, gmx_bool bKeep_old_pdba);
  53 /* Generate hydrogen atoms and N and C terminal patches.
  54  * int nterpairs is the number of termini pairs in the molecule
  55  * ntdb[i] and ctdb[i] may be NULL, no replacement will be done then.
  56  * rN[i] is the residue number of the N-terminus of chain i,
  57  * rC[i] is the residue number of the C-terminus of chain i
  58  * if bMissing==TRUE, continue when atoms are not found
  59  * if nabptr && abptrb, the hack array will be returned in them to be used
  60  * a second time
  61  * if bUpdate_pdba, hydrogens are added to *pdbaptr, else it is unchanged
  62  * return the New total number of atoms
  63  */
  64
  65 GMX_LIBGMXPREPROCESS_EXPORT
  66 extern int protonate(t_atoms **atoms, rvec **x, t_protonate *protdata);
  67 /* Protonate molecule according to gmx2.ff/aminoacids.hdb
  68  * when called the first time, new atoms are added to atoms,
  69  * second time only coordinates are generated
  70  * return the new total number of atoms
  71  */
  72
  73 extern void deprotonate(t_atoms *atoms,rvec *x);
  74 /* Deprotonate any molecule: all atoms whose name begins with H will be
  75  * removed
  76  */
  77
  78 #endif
  79