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, 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 "typedefs.h"
  42 #include "string2.h"
  43 #include "readinp.h"
  44 #include "grompp-impl.h"
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 enum {
  51     eshNONE, eshHBONDS, eshALLBONDS, eshHANGLES, eshALLANGLES, eshNR
  52 };
  53
  54 enum {
  55     ecouplamVDWQ, ecouplamVDW, ecouplamQ, ecouplamNONE, ecouplamNR
  56 };
  57
  58 typedef struct {
  59     int      warnings;
  60     int      nshake;
  61     char    *include;
  62     char    *define;
  63     gmx_bool bGenVel;
  64     gmx_bool bGenPairs;
  65     real     tempi;
  66     int      seed;
  67     gmx_bool bOrire;
  68     gmx_bool bMorse;
  69     char    *wall_atomtype[2];
  70     gmx_bool pull_start;
  71     char    *couple_moltype;
  72     int      couple_lam0;
  73     int      couple_lam1;
  74     gmx_bool bCoupleIntra;
  75 } t_gromppopts;
  76
  77 /*! \brief Initialise object to hold strings parsed from an .mdp file */
  78 void init_inputrec_strings();
  79
  80 /*! \brief Clean up object that holds strings parsed from an .mdp file */
  81 void done_inputrec_strings();
  82
  83 void init_ir(t_inputrec *ir, t_gromppopts *opts);
  84 /* Initiate stuff */
  85
  86 void check_ir(const char *mdparin, t_inputrec *ir, t_gromppopts *opts,
  87               warninp_t wi);
  88 /* Validate inputrec data.
  89  * Fatal errors will be added to nerror.
  90  */
  91 int search_string(const char *s, int ng, char *gn[]);
  92 /* Returns the index of string s in the index groups */
  93
  94 void double_check(t_inputrec *ir, matrix box, gmx_bool bConstr,
  95                   warninp_t wi);
  96 /* Do more checks */
  97
  98 void triple_check(const char *mdparin, t_inputrec *ir, gmx_mtop_t *sys,
  99                   warninp_t wi);
 100 /* Do even more checks */
 101
 102 void check_chargegroup_radii(const gmx_mtop_t *mtop, const t_inputrec *ir,
 103                              rvec *x,
 104                              warninp_t wi);
 105 /* Even more checks, charge group radii vs. cut-off's only. */
 106
 107 void get_ir(const char *mdparin, const char *mdparout,
 108             t_inputrec *ir, t_gromppopts *opts,
 109             warninp_t wi);
 110 /* Read the input file, and retrieve data for inputrec.
 111  * More data are read, but the are only evaluated when the next
 112  * function is called. Also prints the input file back to mdparout.
 113  */
 114
 115 void do_index(const char* mdparin,
 116               const char *ndx,
 117               gmx_mtop_t *mtop,
 118               gmx_bool    bVerbose,
 119               t_inputrec *ir,
 120               rvec       *v,
 121               warninp_t   wi);
 122 /* Read the index file and assign grp numbers to atoms.
 123  * If v is not NULL, the velocities will be scaled to the correct number
 124  * of degrees of freedom.
 125  */
 126
 127 /* Routines In readpull.c */
 128
 129 char **read_pullparams(int *ninp_p, t_inpfile **inp,
 130                        t_pull *pull, gmx_bool *bStart,
 131                        warninp_t wi);
 132 /* Reads the pull parameters, returns a list of the pull group names */
 133
 134 void make_pull_groups(t_pull *pull,
 135                       char **pgnames,
 136                       const t_blocka *grps, char **gnames);
 137 /* Process the pull group parameters after reading the index groups */
 138
 139 void make_pull_coords(t_pull *pull);
 140 /* Process the pull coordinates after reading the pull groups */
 141
 142 void set_pull_init(t_inputrec *ir, gmx_mtop_t *mtop, rvec *x, matrix box, real lambda,
 143                    const output_env_t oenv, gmx_bool bStart);
 144 /* Prints the initial pull group distances in x.
 145  * If bStart adds the distance to the initial reference location.
 146  */
 147
 148 int str_nelem(const char *str, int maxptr, char *ptr[]);
 149 /* helper function from readir.c to convert strings */
 150
 151 void read_adressparams(int *ninp_p, t_inpfile **inp_p, t_adress *adress, warninp_t wi);
 152 /* Reads in AdResS related parameters */
 153
 154 void do_adress_index(t_adress *adress, gmx_groups_t *groups, char **gnames, t_grpopts *opts, warninp_t wi);
 155 /* Generate adress groups */
 156
 157 char **read_rotparams(int *ninp_p, t_inpfile **inp, t_rot *rot, warninp_t wi);
 158 /* Reads enforced rotation parameters, returns a list of the rot group names */
 159
 160 void make_rotation_groups(t_rot *rot, char **rotgnames,
 161                           t_blocka *grps, char **gnames);
 162 /* Process the rotation parameters after reading the index groups */
 163
 164 void set_reference_positions(t_rot *rot, rvec *x, matrix box,
 165                              const char *fn, gmx_bool bSet, warninp_t wi);
 166
 167 #ifdef __cplusplus
 168 }
 169 #endif
 170
 171 #endif