src/gromacs/legacyheaders/mdrun.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 _mdrun_h
  39 #define _mdrun_h
  40
  41 #include <stdio.h>
  42 #include <time.h>
  43 #include "typedefs.h"
  44 #include "network.h"
  45 #include "sim_util.h"
  46 #include "tgroup.h"
  47 #include "../fileio/filenm.h"
  48 #include "mshift.h"
  49 #include "mdebin.h"
  50 #include "vcm.h"
  51 #include "vsite.h"
  52 #include "update.h"
  53 #include "types/membedt.h"
  54 #include "types/globsig.h"
  55
  56 #include "thread_mpi/threads.h"
  57
  58 #ifdef __cplusplus
  59 extern "C" {
  60 #endif
  61
  62 #define MD_POLARISE       (1<<2)
  63 #define MD_RERUN          (1<<4)
  64 #define MD_RERUN_VSITE    (1<<5)
  65 #define MD_SEPPOT         (1<<7)
  66 #define MD_DDBONDCHECK    (1<<10)
  67 #define MD_DDBONDCOMM     (1<<11)
  68 #define MD_CONFOUT        (1<<12)
  69 #define MD_REPRODUCIBLE   (1<<13)
  70 #define MD_APPENDFILES    (1<<15)
  71 #define MD_APPENDFILESSET (1<<21)
  72 #define MD_KEEPANDNUMCPT  (1<<16)
  73 #define MD_READ_EKIN      (1<<17)
  74 #define MD_STARTFROMCPT   (1<<18)
  75 #define MD_RESETCOUNTERSHALFWAY (1<<19)
  76 #define MD_TUNEPME        (1<<20)
  77 #define MD_TESTVERLET     (1<<22)
  78
  79 /* The options for the domain decomposition MPI task ordering */
  80 enum {
  81     ddnoSEL, ddnoINTERLEAVE, ddnoPP_PME, ddnoCARTESIAN, ddnoNR
  82 };
  83
  84 /* Variables for temporary use with the deform option,
  85  * used in runner.c and md.c.
  86  * (These variables should be stored in the tpx file.)
  87  */
  88 extern gmx_int64_t         deform_init_init_step_tpx;
  89 extern matrix              deform_init_box_tpx;
  90 extern tMPI_Thread_mutex_t deform_init_box_mutex;
  91
  92 #ifdef GMX_THREAD_MPI
  93 /* The minimum number of atoms per tMPI thread. With fewer atoms than this,
  94  * the number of threads will get lowered.
  95  */
  96 #define MIN_ATOMS_PER_MPI_THREAD    90
  97 #define MIN_ATOMS_PER_GPU           900
  98 #endif
  99
 100
 101 typedef double gmx_integrator_t (FILE *log, t_commrec *cr,
 102                                  int nfile, const t_filenm fnm[],
 103                                  const output_env_t oenv, gmx_bool bVerbose,
 104                                  gmx_bool bCompact, int nstglobalcomm,
 105                                  gmx_vsite_t *vsite, gmx_constr_t constr,
 106                                  int stepout,
 107                                  t_inputrec *inputrec,
 108                                  gmx_mtop_t *mtop, t_fcdata *fcd,
 109                                  t_state *state,
 110                                  t_mdatoms *mdatoms,
 111                                  t_nrnb *nrnb, gmx_wallcycle_t wcycle,
 112                                  gmx_edsam_t ed,
 113                                  t_forcerec *fr,
 114                                  int repl_ex_nst, int repl_ex_nex, int repl_ex_seed,
 115                                  gmx_membed_t membed,
 116                                  real cpt_period, real max_hours,
 117                                  const char *deviceOptions,
 118                                  unsigned long Flags,
 119                                  gmx_walltime_accounting_t walltime_accounting);
 120
 121 /* ROUTINES from md.c */
 122
 123 gmx_integrator_t do_md;
 124
 125
 126 /* ROUTINES from minimize.c */
 127
 128 gmx_integrator_t do_steep;
 129 /* Do steepest descents EM */
 130
 131 gmx_integrator_t do_cg;
 132 /* Do conjugate gradient EM */
 133
 134 gmx_integrator_t do_lbfgs;
 135 /* Do conjugate gradient L-BFGS */
 136
 137 gmx_integrator_t do_nm;
 138 /* Do normal mode analysis */
 139
 140 /* ROUTINES from tpi.c */
 141
 142 gmx_integrator_t do_tpi;
 143 /* Do test particle insertion */
 144
 145 void init_npt_masses(t_inputrec *ir, t_state *state, t_extmass *MassQ, gmx_bool bInit);
 146
 147 void init_expanded_ensemble(gmx_bool bStateFromCP, t_inputrec *ir, df_history_t *dfhist);
 148
 149 int ExpandedEnsembleDynamics(FILE *log, t_inputrec *ir, gmx_enerdata_t *enerd,
 150                              t_state *state, t_extmass *MassQ, int fep_state, df_history_t *dfhist,
 151                              gmx_int64_t step,
 152                              rvec *v, t_mdatoms *mdatoms);
 153
 154 void PrintFreeEnergyInfoToFile(FILE *outfile, t_lambda *fep, t_expanded *expand, t_simtemp *simtemp, df_history_t *dfhist,
 155                                int fep_state, int frequency, gmx_int64_t step);
 156
 157 /* check the version */
 158 void check_ir_old_tpx_versions(t_commrec *cr, FILE *fplog,
 159                                t_inputrec *ir, gmx_mtop_t *mtop);
 160
 161 /* Allocate and initialize node-local state entries. */
 162 void set_state_entries(t_state *state, const t_inputrec *ir);
 163
 164 /* Broadcast the data for a simulation, and allocate node-specific settings */
 165 void init_parallel(t_commrec *cr, t_inputrec *inputrec,
 166                    gmx_mtop_t *mtop);
 167
 168 int mdrunner(gmx_hw_opt_t *hw_opt,
 169              FILE *fplog, t_commrec *cr, int nfile,
 170              const t_filenm fnm[], const output_env_t oenv, gmx_bool bVerbose,
 171              gmx_bool bCompact, int nstglobalcomm, ivec ddxyz, int dd_node_order,
 172              real rdd, real rconstr, const char *dddlb_opt, real dlb_scale,
 173              const char *ddcsx, const char *ddcsy, const char *ddcsz,
 174              const char *nbpu_opt, int nstlist_cmdline,
 175              gmx_int64_t nsteps_cmdline, int nstepout, int resetstep,
 176              int nmultisim, int repl_ex_nst, int repl_ex_nex,
 177              int repl_ex_seed, real pforce, real cpt_period, real max_hours,
 178              const char *deviceOptions, unsigned long Flags);
 179 /* Driver routine, that calls the different methods */
 180
 181 #ifdef __cplusplus
 182 }
 183 #endif
 184
 185 #endif  /* _mdrun_h */