src/gromacs/gmxpreprocess/readir.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,2016,2017 by the GROMACS development team.
   7  * Copyright (c) 2018,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_READIR_H
  40 #define GMX_GMXPREPROCESS_READIR_H
  41
  42 #include <string>
  43
  44 #include "gromacs/fileio/readinp.h"
  45 #include "gromacs/math/vectypes.h"
  46 #include "gromacs/utility/real.h"
  47
  48 namespace gmx
  49 {
  50 class MDModules;
  51 struct MdModulesNotifier;
  52 } // namespace gmx
  53
  54 struct gmx_mtop_t;
  55 struct gmx_output_env_t;
  56 struct pull_params_t;
  57 struct pull_t;
  58 struct t_blocka;
  59 struct t_grpopts;
  60 struct t_inpfile;
  61 struct t_inputrec;
  62 struct t_rot;
  63 struct warninp;
  64 typedef warninp* warninp_t;
  65
  66 enum
  67 {
  68     eshNONE,
  69     eshHBONDS,
  70     eshALLBONDS,
  71     eshHANGLES,
  72     eshALLANGLES,
  73     eshNR
  74 };
  75
  76 enum
  77 {
  78     ecouplamVDWQ,
  79     ecouplamVDW,
  80     ecouplamQ,
  81     ecouplamNONE,
  82     ecouplamNR
  83 };
  84
  85 struct t_gromppopts
  86 {
  87     int         warnings     = 0;
  88     int         nshake       = 0;
  89     char*       include      = nullptr;
  90     char*       define       = nullptr;
  91     bool        bGenVel      = false;
  92     bool        bGenPairs    = false;
  93     real        tempi        = 0;
  94     int         seed         = 0;
  95     int         numMtsLevels = 0;
  96     std::string mtsLevel2Forces;
  97     bool        bOrire           = false;
  98     bool        bMorse           = false;
  99     char*       wall_atomtype[2] = { nullptr, nullptr };
 100     char*       couple_moltype   = nullptr;
 101     int         couple_lam0      = 0;
 102     int         couple_lam1      = 0;
 103     bool        bCoupleIntra     = false;
 104 };
 105
 106 /*! \brief Initialise object to hold strings parsed from an .mdp file */
 107 void init_inputrec_strings();
 108
 109 /*! \brief Clean up object that holds strings parsed from an .mdp file */
 110 void done_inputrec_strings();
 111
 112 void check_ir(const char*                   mdparin,
 113               const gmx::MdModulesNotifier& mdModulesNotifier,
 114               t_inputrec*                   ir,
 115               t_gromppopts*                 opts,
 116               warninp_t                     wi);
 117 /* Validate inputrec data.
 118  * Fatal errors will be added to nerror.
 119  */
 120 int search_string(const char* s, int ng, char* gn[]);
 121 /* Returns the index of string s in the index groups */
 122
 123 void double_check(t_inputrec* ir, matrix box, bool bHasNormalConstraints, bool bHasAnyConstraints, warninp_t wi);
 124 /* Do more checks */
 125
 126 void triple_check(const char* mdparin, t_inputrec* ir, gmx_mtop_t* sys, warninp_t wi);
 127 /* Do even more checks */
 128
 129 void get_ir(const char*     mdparin,
 130             const char*     mdparout,
 131             gmx::MDModules* mdModules,
 132             t_inputrec*     ir,
 133             t_gromppopts*   opts,
 134             WriteMdpHeader  writeMdpHeader,
 135             warninp_t       wi);
 136 /* Read the input file, and retrieve data for inputrec.
 137  * More data are read, but the are only evaluated when the next
 138  * function is called. Also prints the input file back to mdparout.
 139  */
 140
 141 void do_index(const char*                   mdparin,
 142               const char*                   ndx,
 143               gmx_mtop_t*                   mtop,
 144               bool                          bVerbose,
 145               const gmx::MdModulesNotifier& notifier,
 146               t_inputrec*                   ir,
 147               warninp_t                     wi);
 148 /* Read the index file and assign grp numbers to atoms.
 149  */
 150
 151 /* Routines In readpull.c */
 152
 153 std::vector<std::string> read_pullparams(std::vector<t_inpfile>* inp, pull_params_t* pull, warninp_t wi);
 154 /* Reads the pull parameters, returns a list of the pull group names */
 155
 156 void make_pull_groups(pull_params_t*                   pull,
 157                       gmx::ArrayRef<const std::string> pullGroupNames,
 158                       const t_blocka*                  grps,
 159                       char**                           gnames);
 160 /* Process the pull group parameters after reading the index groups */
 161
 162 void make_pull_coords(pull_params_t* pull);
 163 /* Process the pull coordinates after reading the pull groups */
 164
 165 pull_t* set_pull_init(t_inputrec* ir, const gmx_mtop_t* mtop, rvec* x, matrix box, real lambda, warninp_t wi);
 166 /* Prints the initial pull group distances in x.
 167  * If requested, adds the current distance to the initial reference location.
 168  * Returns the pull_t pull work struct. This should be passed to finish_pull()
 169  * after all modules have registered their external potentials, if present.
 170  */
 171
 172 std::vector<std::string> read_rotparams(std::vector<t_inpfile>* inp, t_rot* rot, warninp_t wi);
 173 /* Reads enforced rotation parameters, returns a list of the rot group names */
 174
 175 void make_rotation_groups(t_rot*                           rot,
 176                           gmx::ArrayRef<const std::string> rotateGroupNames,
 177                           t_blocka*                        grps,
 178                           char**                           gnames);
 179 /* Process the rotation parameters after reading the index groups */
 180
 181 void set_reference_positions(t_rot* rot, rvec* x, matrix box, const char* fn, bool bSet, warninp_t wi);
 182
 183 #endif