src/gromacs/gmxpreprocess/topio.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) 2012,2014,2015,2016,2018 by the GROMACS development team.
   7  * Copyright (c) 2019,2020, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source 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 GMX_GMXPREPROCESS_TOPIO_H
  40 #define GMX_GMXPREPROCESS_TOPIO_H
  41
  42 #include <memory>
  43 #include <vector>
  44
  45 #include "gromacs/utility/arrayref.h"
  46 #include "gromacs/utility/real.h"
  47
  48 struct gmx_molblock_t;
  49 struct gmx_mtop_t;
  50 class PreprocessingAtomTypes;
  51 struct t_gromppopts;
  52 struct t_inputrec;
  53 struct MoleculeInformation;
  54 struct InteractionsOfType;
  55 struct t_symtab;
  56 struct warninp;
  57 enum struct GmxQmmmMode;
  58 typedef warninp* warninp_t;
  59
  60 namespace gmx
  61 {
  62 class MDLogger;
  63 }
  64
  65 double check_mol(const gmx_mtop_t* mtop, warninp_t wi);
  66 /* Check mass and charge */
  67
  68 char** do_top(bool                                  bVerbose,
  69               const char*                           topfile,
  70               const char*                           topppfile,
  71               t_gromppopts*                         opts,
  72               bool                                  bZero,
  73               t_symtab*                             symtab,
  74               gmx::ArrayRef<InteractionsOfType>     plist,
  75               int*                                  combination_rule,
  76               double*                               repulsion_power,
  77               real*                                 fudgeQQ,
  78               PreprocessingAtomTypes*               atype,
  79               std::vector<MoleculeInformation>*     molinfo,
  80               std::unique_ptr<MoleculeInformation>* intermolecular_interactions,
  81               const t_inputrec*                     ir,
  82               std::vector<gmx_molblock_t>*          molblock,
  83               bool*                                 ffParametrizedWithHBondConstraints,
  84               warninp_t                             wi,
  85               const gmx::MDLogger&                  logger);
  86
  87 /* This routine expects sys->molt[m].ilist to be of size F_NRE and ordered. */
  88 void generate_qmexcl(gmx_mtop_t* sys, t_inputrec* ir, warninp_t wi, GmxQmmmMode qmmmMode, const gmx::MDLogger& logger);
  89
  90 #endif