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