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