src/gromacs/gmxpreprocess/pgutil.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,2020, 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_PGUTIL_H
  39 #define GMX_GMXPREPROCESS_PGUTIL_H
  40
  41 #include "gromacs/utility/arrayref.h"
  42 #include "gromacs/utility/basedefinitions.h"
  43 #include "gromacs/utility/real.h"
  44
  45 struct t_atom;
  46 struct t_atoms;
  47
  48 /*! \brief
  49  * Search an atom in array of pointers to strings
  50  *
  51  * If \p type starts with '-', start from \p start.
  52  * Will search backwards from that.
  53  *
  54  * \p bondtype is only used for printing the error/warning string,
  55  * when \p bondtype ="check" no error/warning is issued.
  56  * When \p bAllowMissing = FALSE an fatal error is issued, otherwise a warning.
  57  *
  58  * \param[in] type             Atom type string to parse
  59  * \param[in] start            Possible position to begin search from.
  60  * \param[in] atoms            Global topology atoms information.
  61  * \param[in] bondtype         Information what kind of bond, used for error messages.
  62  * \param[in] bAllowMissing    If true, missing bond types are allowed.
  63  *                             AKA allow cartoon physics.
  64  * \param[in] cyclicBondsIndex Information about bonds creating cyclic molecules,
  65  *                             empty if no such bonds exist.
  66  */
  67 int search_atom(const char*              type,
  68                 int                      start,
  69                 const t_atoms*           atoms,
  70                 const char*              bondtype,
  71                 bool                     bAllowMissing,
  72                 gmx::ArrayRef<const int> cyclicBondsIndex);
  73
  74 /* Similar to search_atom, but this routine searches for the specified
  75  * atom in residue resind.
  76  */
  77 int search_res_atom(const char* type, int resind, const t_atoms* atoms, const char* bondtype, bool bAllowMissing);
  78
  79 #endif