src/gromacs/gmxpreprocess/ter_db.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) 2011,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_TER_DB_H
  39 #define GMX_GMXPREPROCESS_TER_DB_H
  40
  41 #include <vector>
  42
  43 class PreprocessingAtomTypes;
  44 struct MoleculePatchDatabase;
  45
  46 namespace gmx
  47 {
  48 template<typename>
  49 class ArrayRef;
  50 }
  51
  52 /*! \brief
  53  * Read database for N&C terminal modifications.
  54  *
  55  * \param[in] ffdir Directory for files.
  56  * \param[in] ter Which terminal side to read.
  57  * \param[inout] tbptr Database for terminii entry to populate.
  58  * \param[in] atype Database for atomtype information.
  59  * \returns Number of entries entered into database.
  60  */
  61 int read_ter_db(const char*                         ffdir,
  62                 char                                ter,
  63                 std::vector<MoleculePatchDatabase>* tbptr,
  64                 PreprocessingAtomTypes*             atype);
  65
  66 /*! \brief
  67  * Return entries for modification blocks that match a residue name.
  68  *
  69  * \param[in] tb Complete modification database.
  70  * \param[in] resname Residue name for terminus.
  71  * \returns A list of pointers to entries that match, or of nullptr for no matching entry.
  72  */
  73 std::vector<MoleculePatchDatabase*> filter_ter(gmx::ArrayRef<MoleculePatchDatabase> tb, const char* resname);
  74
  75 /*! \brief
  76  * Interactively select one terminus.
  77  *
  78  * \param[in] tb List of possible entries, with pointer to actual entry or nullptr.
  79  * \param[in] title Name of entry.
  80  * \returns The modification block selected.
  81  */
  82 MoleculePatchDatabase* choose_ter(gmx::ArrayRef<MoleculePatchDatabase*> tb, const char* title);
  83
  84 #endif