src/gromacs/gmxpreprocess/readir.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gallium Rubidium Oxygen Manganese Argon Carbon Silicon
  34  */
  35
  36 #ifndef _readir_h
  37 #define _readir_h
  38
  39 #include "typedefs.h"
  40 #include "string2.h"
  41 #include "readinp.h"
  42 #include "grompp.h"
  43
  44 enum {
  45     eshNONE, eshHBONDS, eshALLBONDS, eshHANGLES, eshALLANGLES, eshNR
  46 };
  47
  48 static const char *constraints[eshNR+1]    = {
  49     "none", "h-bonds", "all-bonds", "h-angles", "all-angles", NULL
  50 };
  51
  52 enum {
  53     ecouplamVDWQ, ecouplamVDW, ecouplamQ, ecouplamNONE, ecouplamNR
  54 };
  55
  56 static const char *couple_lam[ecouplamNR+1]    = {
  57     "vdw-q", "vdw", "q", "none", NULL
  58 };
  59
  60 typedef struct {
  61     int      warnings;
  62     int      nshake;
  63     char    *include;
  64     char    *define;
  65     gmx_bool bGenVel;
  66     gmx_bool bGenPairs;
  67     real     tempi;
  68     int      seed;
  69     gmx_bool bOrire;
  70     gmx_bool bMorse;
  71     char    *wall_atomtype[2];
  72     gmx_bool pull_start;
  73     char    *couple_moltype;
  74     int      couple_lam0;
  75     int      couple_lam1;
  76     gmx_bool bCoupleIntra;
  77 } t_gromppopts;
  78
  79
  80 extern void init_ir(t_inputrec *ir, t_gromppopts *opts);
  81 /* Initiate stuff */
  82
  83 extern void check_ir(const char *mdparin, t_inputrec *ir, t_gromppopts *opts,
  84                      warninp_t wi);
  85 /* Validate inputrec data.
  86  * Fatal errors will be added to nerror.
  87  */
  88 extern int search_string(char *s, int ng, char *gn[]);
  89 /* Returns the index of string s in the index groups */
  90
  91 extern void double_check(t_inputrec *ir, matrix box, gmx_bool bConstr,
  92                          warninp_t wi);
  93 /* Do more checks */
  94
  95 extern void triple_check(const char *mdparin, t_inputrec *ir, gmx_mtop_t *sys,
  96                          warninp_t wi);
  97 /* Do even more checks */
  98
  99 extern void check_chargegroup_radii(const gmx_mtop_t *mtop, const t_inputrec *ir,
 100                                     rvec *x,
 101                                     warninp_t wi);
 102 /* Even more checks, charge group radii vs. cut-off's only. */
 103
 104 extern void get_ir(const char *mdparin, const char *mdparout,
 105                    t_inputrec *ir, t_gromppopts *opts,
 106                    warninp_t wi);
 107 /* Read the input file, and retrieve data for inputrec.
 108  * More data are read, but the are only evaluated when the next
 109  * function is called. Also prints the input file back to mdparout.
 110  */
 111
 112 extern void do_index(const char* mdparin,
 113                      const char *ndx,
 114                      gmx_mtop_t *mtop,
 115                      gmx_bool    bVerbose,
 116                      t_inputrec *ir,
 117                      rvec       *v,
 118                      warninp_t   wi);
 119 /* Read the index file and assign grp numbers to atoms.
 120  * If v is not NULL, the velocities will be scaled to the correct number
 121  * of degrees of freedom.
 122  */
 123
 124 /* Routines In readpull.c */
 125
 126 extern char **read_pullparams(int *ninp_p, t_inpfile **inp,
 127                               t_pull *pull, gmx_bool *bStart,
 128                               warninp_t wi);
 129 /* Reads the pull parameters, returns a list of the pull group names */
 130
 131 extern void make_pull_groups(t_pull *pull, char **pgnames,
 132                              t_blocka *grps, char **gnames);
 133 /* Process the pull parameters after reading the index groups */
 134
 135 extern void set_pull_init(t_inputrec *ir, gmx_mtop_t *mtop, rvec *x, matrix box, real lambda,
 136                           const output_env_t oenv, gmx_bool bStart);
 137 /* Prints the initial pull group distances in x.
 138  * If bStart adds the distance to the initial reference location.
 139  */
 140
 141 extern int str_nelem(const char *str, int maxptr, char *ptr[]);
 142 /* helper function from readir.c to convert strings */
 143
 144 extern void read_adressparams(int *ninp_p, t_inpfile **inp_p, t_adress *adress, warninp_t wi);
 145 /* Reads in AdResS related parameters */
 146
 147 extern void do_adress_index(t_adress *adress, gmx_groups_t *groups, char **gnames, t_grpopts *opts, warninp_t wi);
 148 /* Generate adress groups */
 149
 150 extern char **read_rotparams(int *ninp_p, t_inpfile **inp, t_rot *rot, warninp_t wi);
 151 /* Reads enforced rotation parameters, returns a list of the rot group names */
 152
 153 extern void make_rotation_groups(t_rot *rot, char **rotgnames,
 154                                  t_blocka *grps, char **gnames);
 155 /* Process the rotation parameters after reading the index groups */
 156
 157 extern void set_reference_positions(t_rot *rot, gmx_mtop_t *mtop, rvec *x, matrix box,
 158                                     const char *fn, gmx_bool bSet, warninp_t wi);
 159
 160 #endif  /* _readir_h */