src/gromacs/gmxpreprocess/h_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,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_H_DB_H
  39 #define GMX_GMXPREPROCESS_H_DB_H
  40
  41 #include <cstdio>
  42
  43 #include <vector>
  44
  45 #include "gromacs/utility/arrayref.h"
  46
  47 struct MoleculePatch;
  48 struct MoleculePatchDatabase;
  49
  50 /* functions for the h-database */
  51
  52 void read_ab(char* line, const char* fn, MoleculePatch* ab);
  53 /* Read one add block */
  54
  55 /*! \brief
  56  * Read the databse from hdb file(s).
  57  *
  58  * \param[in] ffdir Directory for files.
  59  * \param[inout] globalPatches The database for atom modifications to populate.
  60  * \returns The number of modifications stored.
  61  */
  62 int read_h_db(const char* ffdir, std::vector<MoleculePatchDatabase>* globalPatches);
  63
  64 void print_ab(FILE* out, const MoleculePatch& ab, const char* nname);
  65 /* print one add block */
  66
  67 /*! \brief
  68  * Search for an entry.
  69  *
  70  * \param[in] globalPatches Database to search.
  71  * \param[in] key Name to search for.
  72  */
  73 gmx::ArrayRef<const MoleculePatchDatabase>::iterator
  74 search_h_db(gmx::ArrayRef<const MoleculePatchDatabase> globalPatches, const char* key);
  75 /* Search for an entry in the database */
  76
  77 #endif