src/kernel/mdrun.c

   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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #ifdef HAVE_CONFIG_H
  39 #include <config.h>
  40 #endif
  41
  42 #include "typedefs.h"
  43 #include "macros.h"
  44 #include "copyrite.h"
  45 #include "main.h"
  46 #include "statutil.h"
  47 #include "smalloc.h"
  48 #include "futil.h"
  49 #include "smalloc.h"
  50 #include "edsam.h"
  51 #include "mdrun.h"
  52 #include "xmdrun.h"
  53 #include "checkpoint.h"
  54 #ifdef GMX_THREAD_MPI
  55 #include "thread_mpi.h"
  56 #endif
  57
  58 /* afm stuf */
  59 #include "pull.h"
  60
  61 int cmain(int argc,char *argv[])
  62 {
  63   const char *desc[] = {
  64     "The [TT]mdrun[tt] program is the main computational chemistry engine",
  65     "within GROMACS. Obviously, it performs Molecular Dynamics simulations,",
  66     "but it can also perform Stochastic Dynamics, Energy Minimization,",
  67     "test particle insertion or (re)calculation of energies.",
  68     "Normal mode analysis is another option. In this case [TT]mdrun[tt]",
  69     "builds a Hessian matrix from single conformation.",
  70     "For usual Normal Modes-like calculations, make sure that",
  71     "the structure provided is properly energy-minimized.",
  72     "The generated matrix can be diagonalized by [TT]g_nmeig[tt].[PAR]",
  73     "The [TT]mdrun[tt] program reads the run input file ([TT]-s[tt])",
  74     "and distributes the topology over nodes if needed.",
  75     "[TT]mdrun[tt] produces at least four output files.",
  76     "A single log file ([TT]-g[tt]) is written, unless the option",
  77     "[TT]-seppot[tt] is used, in which case each node writes a log file.",
  78     "The trajectory file ([TT]-o[tt]), contains coordinates, velocities and",
  79     "optionally forces.",
  80     "The structure file ([TT]-c[tt]) contains the coordinates and",
  81     "velocities of the last step.",
  82     "The energy file ([TT]-e[tt]) contains energies, the temperature,",
  83     "pressure, etc, a lot of these things are also printed in the log file.",
  84     "Optionally coordinates can be written to a compressed trajectory file",
  85     "([TT]-x[tt]).[PAR]",
  86     "The option [TT]-dhdl[tt] is only used when free energy calculation is",
  87     "turned on.[PAR]",
  88     "A simulation can be run in parallel using two different parallelization",
  89     "schemes: MPI parallelization and/or OpenMP thread parallelization.",
  90     "The MPI parallelization uses multiple processes when [TT]mdrun[tt] is",
  91     "compiled with a normal MPI library or threads when [TT]mdrun[tt] is",
  92     "compiled with the GROMACS built-in thread-MPI library. OpenMP threads",
  93     "are supported when mdrun is compiled with OpenMP. Full OpenMP support",
  94     "is only available with the Verlet cut-off scheme, with the (older)",
  95     "group scheme only PME-only processes can use OpenMP parallelization.",
  96     "In all cases [TT]mdrun[tt] will by default try to use all the available",
  97     "hardware resources. With a normal MPI library only the options",
  98     "[TT]-ntomp[tt] (with the Verlet cut-off scheme) and [TT]-ntomp_pme[tt],",
  99     "for PME-only processes, can be used to control the number of threads.",
 100     "With thread-MPI there are additional options [TT]-nt[tt], which sets",
 101     "the total number of threads, and [TT]-ntmpi[tt], which sets the number",
 102     "of thread-MPI threads.",
 103     "Note that using combined MPI+OpenMP parallelization is almost always",
 104     "slower than single parallelization, except at the scaling limit, where",
 105     "especially OpenMP parallelization of PME reduces the communication cost.",
 106     "OpenMP-only parallelization is much faster than MPI-only parallelization",
 107     "on a single CPU(-die). Since we currently don't have proper hardware",
 108     "topology detection, [TT]mdrun[tt] compiled with thread-MPI will only",
 109     "automatically use OpenMP-only parallelization when you use up to 4",
 110     "threads, up to 12 threads with Intel Nehalem/Westmere, or up to 16",
 111     "threads with Intel Sandy Bridge or newer CPUs. Otherwise MPI-only",
 112     "parallelization is used (except with GPUs, see below).",
 113     "[PAR]",
 114     "To quickly test the performance of the new Verlet cut-off scheme",
 115     "with old [TT].tpr[tt] files, either on CPUs or CPUs+GPUs, you can use",
 116     "the [TT]-testverlet[tt] option. This should not be used for production,",
 117     "since it can slightly modify potentials and it will remove charge groups",
 118     "making analysis difficult, as the [TT].tpr[tt] file will still contain",
 119     "charge groups. For production simulations it is highly recommended",
 120     "to specify [TT]cutoff-scheme = Verlet[tt] in the [TT].mdp[tt] file.",
 121     "[PAR]",
 122     "With GPUs (only supported with the Verlet cut-off scheme), the number",
 123     "of GPUs should match the number of MPI processes or MPI threads,",
 124     "excluding PME-only processes/threads. With thread-MPI the number",
 125     "of MPI threads will automatically be set to the number of GPUs detected.",
 126     "When you want to use a subset of the available GPUs, you can use",
 127     "the [TT]-gpu_id[tt] option, where GPU id's are passed as a string,",
 128     "e.g. 02 for using GPUs 0 and 2. When you want different GPU id's",
 129     "on different nodes of a compute cluster, use the GMX_GPU_ID environment",
 130     "variable instead. The format for GMX_GPU_ID is identical to ",
 131     "[TT]-gpu_id[tt], but an environment variable can have different values",
 132     "on different nodes of a cluster.",
 133     "[PAR]",
 134     "When using PME with separate PME nodes or with a GPU, the two major",
 135     "compute tasks, the non-bonded force calculation and the PME calculation",
 136     "run on different compute resources. If this load is not balanced,",
 137     "some of the resources will be idle part of time. With the Verlet",
 138     "cut-off scheme this load is automatically balanced when the PME load",
 139     "is too high (but not when it is too low). This is done by scaling",
 140     "the Coulomb cut-off and PME grid spacing by the same amount. In the first",
 141     "few hundred steps different settings are tried and the fastest is chosen",
 142     "for the rest of the simulation. This does not affect the accuracy of",
 143     "the results, but it does affect the decomposition of the Coulomb energy",
 144     "into particle and mesh contributions. The auto-tuning can be turned off",
 145     "with the option [TT]-notunepme[tt].",
 146     "[PAR]",
 147     "When compiled with OpenMP on Linux, [TT]mdrun[tt] pins threads to cores,",
 148     "as this usually results in significantly better performance.",
 149     "If you don't want this, use [TT]-nopin[tt].",
 150     "With Intel CPUs with hyper-threading enabled, you should pin",
 151     "consecutive threads to the same physical core for optimal",
 152     "performance when you use virtual cores. This is done automatically",
 153     "when you use more than half of the virtual cores. It can also be set",
 154     "manually with [TT]-pinht[tt], e.g. for running multiple simulations",
 155     "on one compute node.",
 156     "When running multiple mdrun (or other) simulations on the same physical",
 157     "node, some simulations need to start pinning from a non-zero core",
 158     "to avoid overloading cores; with [TT]-pinoffset[tt] you can specify",
 159     "the offset in (physical) cores for pinning.",
 160     "[PAR]",
 161     "When [TT]mdrun[tt] is started using MPI with more than 1 process",
 162     "or with thread-MPI with more than 1 thread, MPI parallelization is used.",
 163     "By default domain decomposition is used, unless the [TT]-pd[tt]",
 164     "option is set, which selects particle decomposition.",
 165     "[PAR]",
 166     "With domain decomposition, the spatial decomposition can be set",
 167     "with option [TT]-dd[tt]. By default [TT]mdrun[tt] selects a good decomposition.",
 168     "The user only needs to change this when the system is very inhomogeneous.",
 169     "Dynamic load balancing is set with the option [TT]-dlb[tt],",
 170     "which can give a significant performance improvement,",
 171     "especially for inhomogeneous systems. The only disadvantage of",
 172     "dynamic load balancing is that runs are no longer binary reproducible,",
 173     "but in most cases this is not important.",
 174     "By default the dynamic load balancing is automatically turned on",
 175     "when the measured performance loss due to load imbalance is 5% or more.",
 176     "At low parallelization these are the only important options",
 177     "for domain decomposition.",
 178     "At high parallelization the options in the next two sections",
 179     "could be important for increasing the performace.",
 180     "[PAR]",
 181     "When PME is used with domain decomposition, separate nodes can",
 182     "be assigned to do only the PME mesh calculation;",
 183     "this is computationally more efficient starting at about 12 nodes.",
 184     "The number of PME nodes is set with option [TT]-npme[tt],",
 185     "this can not be more than half of the nodes.",
 186     "By default [TT]mdrun[tt] makes a guess for the number of PME",
 187     "nodes when the number of nodes is larger than 11 or performance wise",
 188     "not compatible with the PME grid x dimension.",
 189     "But the user should optimize npme. Performance statistics on this issue",
 190     "are written at the end of the log file.",
 191     "For good load balancing at high parallelization, the PME grid x and y",
 192     "dimensions should be divisible by the number of PME nodes",
 193     "(the simulation will run correctly also when this is not the case).",
 194     "[PAR]",
 195     "This section lists all options that affect the domain decomposition.",
 196     "[PAR]",
 197     "Option [TT]-rdd[tt] can be used to set the required maximum distance",
 198     "for inter charge-group bonded interactions.",
 199     "Communication for two-body bonded interactions below the non-bonded",
 200     "cut-off distance always comes for free with the non-bonded communication.",
 201     "Atoms beyond the non-bonded cut-off are only communicated when they have",
 202     "missing bonded interactions; this means that the extra cost is minor",
 203     "and nearly indepedent of the value of [TT]-rdd[tt].",
 204     "With dynamic load balancing option [TT]-rdd[tt] also sets",
 205     "the lower limit for the domain decomposition cell sizes.",
 206     "By default [TT]-rdd[tt] is determined by [TT]mdrun[tt] based on",
 207     "the initial coordinates. The chosen value will be a balance",
 208     "between interaction range and communication cost.",
 209     "[PAR]",
 210     "When inter charge-group bonded interactions are beyond",
 211     "the bonded cut-off distance, [TT]mdrun[tt] terminates with an error message.",
 212     "For pair interactions and tabulated bonds",
 213     "that do not generate exclusions, this check can be turned off",
 214     "with the option [TT]-noddcheck[tt].",
 215     "[PAR]",
 216     "When constraints are present, option [TT]-rcon[tt] influences",
 217     "the cell size limit as well.",
 218     "Atoms connected by NC constraints, where NC is the LINCS order plus 1,",
 219     "should not be beyond the smallest cell size. A error message is",
 220     "generated when this happens and the user should change the decomposition",
 221     "or decrease the LINCS order and increase the number of LINCS iterations.",
 222     "By default [TT]mdrun[tt] estimates the minimum cell size required for P-LINCS",
 223     "in a conservative fashion. For high parallelization it can be useful",
 224     "to set the distance required for P-LINCS with the option [TT]-rcon[tt].",
 225     "[PAR]",
 226     "The [TT]-dds[tt] option sets the minimum allowed x, y and/or z scaling",
 227     "of the cells with dynamic load balancing. [TT]mdrun[tt] will ensure that",
 228     "the cells can scale down by at least this factor. This option is used",
 229     "for the automated spatial decomposition (when not using [TT]-dd[tt])",
 230     "as well as for determining the number of grid pulses, which in turn",
 231     "sets the minimum allowed cell size. Under certain circumstances",
 232     "the value of [TT]-dds[tt] might need to be adjusted to account for",
 233     "high or low spatial inhomogeneity of the system.",
 234     "[PAR]",
 235     "The option [TT]-gcom[tt] can be used to only do global communication",
 236     "every n steps.",
 237     "This can improve performance for highly parallel simulations",
 238     "where this global communication step becomes the bottleneck.",
 239     "For a global thermostat and/or barostat the temperature",
 240     "and/or pressure will also only be updated every [TT]-gcom[tt] steps.",
 241     "By default it is set to the minimum of nstcalcenergy and nstlist.[PAR]",
 242     "With [TT]-rerun[tt] an input trajectory can be given for which ",
 243     "forces and energies will be (re)calculated. Neighbor searching will be",
 244     "performed for every frame, unless [TT]nstlist[tt] is zero",
 245     "(see the [TT].mdp[tt] file).[PAR]",
 246     "ED (essential dynamics) sampling and/or additional flooding potentials",
 247     "are switched on by using the [TT]-ei[tt] flag followed by an [TT].edi[tt]",
 248     "file. The [TT].edi[tt] file can be produced with the [TT]make_edi[tt] tool",
 249     "or by using options in the essdyn menu of the WHAT IF program.",
 250     "[TT]mdrun[tt] produces a [TT].xvg[tt] output file that",
 251     "contains projections of positions, velocities and forces onto selected",
 252     "eigenvectors.[PAR]",
 253     "When user-defined potential functions have been selected in the",
 254     "[TT].mdp[tt] file the [TT]-table[tt] option is used to pass [TT]mdrun[tt]",
 255     "a formatted table with potential functions. The file is read from",
 256     "either the current directory or from the [TT]GMXLIB[tt] directory.",
 257     "A number of pre-formatted tables are presented in the [TT]GMXLIB[tt] dir,",
 258     "for 6-8, 6-9, 6-10, 6-11, 6-12 Lennard-Jones potentials with",
 259     "normal Coulomb.",
 260     "When pair interactions are present, a separate table for pair interaction",
 261     "functions is read using the [TT]-tablep[tt] option.[PAR]",
 262     "When tabulated bonded functions are present in the topology,",
 263     "interaction functions are read using the [TT]-tableb[tt] option.",
 264     "For each different tabulated interaction type the table file name is",
 265     "modified in a different way: before the file extension an underscore is",
 266     "appended, then a 'b' for bonds, an 'a' for angles or a 'd' for dihedrals",
 267     "and finally the table number of the interaction type.[PAR]",
 268     "The options [TT]-px[tt] and [TT]-pf[tt] are used for writing pull COM",
 269     "coordinates and forces when pulling is selected",
 270     "in the [TT].mdp[tt] file.[PAR]",
 271     "With [TT]-multi[tt] or [TT]-multidir[tt], multiple systems can be ",
 272     "simulated in parallel.",
 273     "As many input files/directories are required as the number of systems. ",
 274     "The [TT]-multidir[tt] option takes a list of directories (one for each ",
 275     "system) and runs in each of them, using the input/output file names, ",
 276     "such as specified by e.g. the [TT]-s[tt] option, relative to these ",
 277     "directories.",
 278     "With [TT]-multi[tt], the system number is appended to the run input ",
 279     "and each output filename, for instance [TT]topol.tpr[tt] becomes",
 280     "[TT]topol0.tpr[tt], [TT]topol1.tpr[tt] etc.",
 281     "The number of nodes per system is the total number of nodes",
 282     "divided by the number of systems.",
 283     "One use of this option is for NMR refinement: when distance",
 284     "or orientation restraints are present these can be ensemble averaged",
 285     "over all the systems.[PAR]",
 286     "With [TT]-replex[tt] replica exchange is attempted every given number",
 287     "of steps. The number of replicas is set with the [TT]-multi[tt] or ",
 288     "[TT]-multidir[tt] option, described above.",
 289     "All run input files should use a different coupling temperature,",
 290     "the order of the files is not important. The random seed is set with",
 291     "[TT]-reseed[tt]. The velocities are scaled and neighbor searching",
 292     "is performed after every exchange.[PAR]",
 293     "Finally some experimental algorithms can be tested when the",
 294     "appropriate options have been given. Currently under",
 295     "investigation are: polarizability and X-ray bombardments.",
 296     "[PAR]",
 297     "The option [TT]-membed[tt] does what used to be g_membed, i.e. embed",
 298     "a protein into a membrane. The data file should contain the options",
 299     "that where passed to g_membed before. The [TT]-mn[tt] and [TT]-mp[tt]",
 300     "both apply to this as well.",
 301     "[PAR]",
 302     "The option [TT]-pforce[tt] is useful when you suspect a simulation",
 303     "crashes due to too large forces. With this option coordinates and",
 304     "forces of atoms with a force larger than a certain value will",
 305     "be printed to stderr.",
 306     "[PAR]",
 307     "Checkpoints containing the complete state of the system are written",
 308     "at regular intervals (option [TT]-cpt[tt]) to the file [TT]-cpo[tt],",
 309     "unless option [TT]-cpt[tt] is set to -1.",
 310     "The previous checkpoint is backed up to [TT]state_prev.cpt[tt] to",
 311     "make sure that a recent state of the system is always available,",
 312     "even when the simulation is terminated while writing a checkpoint.",
 313     "With [TT]-cpnum[tt] all checkpoint files are kept and appended",
 314     "with the step number.",
 315     "A simulation can be continued by reading the full state from file",
 316     "with option [TT]-cpi[tt]. This option is intelligent in the way that",
 317     "if no checkpoint file is found, Gromacs just assumes a normal run and",
 318     "starts from the first step of the [TT].tpr[tt] file. By default the output",
 319     "will be appending to the existing output files. The checkpoint file",
 320     "contains checksums of all output files, such that you will never",
 321     "loose data when some output files are modified, corrupt or removed.",
 322     "There are three scenarios with [TT]-cpi[tt]:[PAR]",
 323     "[TT]*[tt] no files with matching names are present: new output files are written[PAR]",
 324     "[TT]*[tt] all files are present with names and checksums matching those stored",
 325     "in the checkpoint file: files are appended[PAR]",
 326     "[TT]*[tt] otherwise no files are modified and a fatal error is generated[PAR]",
 327     "With [TT]-noappend[tt] new output files are opened and the simulation",
 328     "part number is added to all output file names.",
 329     "Note that in all cases the checkpoint file itself is not renamed",
 330     "and will be overwritten, unless its name does not match",
 331     "the [TT]-cpo[tt] option.",
 332     "[PAR]",
 333     "With checkpointing the output is appended to previously written",
 334     "output files, unless [TT]-noappend[tt] is used or none of the previous",
 335     "output files are present (except for the checkpoint file).",
 336     "The integrity of the files to be appended is verified using checksums",
 337     "which are stored in the checkpoint file. This ensures that output can",
 338     "not be mixed up or corrupted due to file appending. When only some",
 339     "of the previous output files are present, a fatal error is generated",
 340     "and no old output files are modified and no new output files are opened.",
 341     "The result with appending will be the same as from a single run.",
 342     "The contents will be binary identical, unless you use a different number",
 343     "of nodes or dynamic load balancing or the FFT library uses optimizations",
 344     "through timing.",
 345     "[PAR]",
 346     "With option [TT]-maxh[tt] a simulation is terminated and a checkpoint",
 347     "file is written at the first neighbor search step where the run time",
 348     "exceeds [TT]-maxh[tt]*0.99 hours.",
 349     "[PAR]",
 350     "When [TT]mdrun[tt] receives a TERM signal, it will set nsteps to the current",
 351     "step plus one. When [TT]mdrun[tt] receives an INT signal (e.g. when ctrl+C is",
 352     "pressed), it will stop after the next neighbor search step ",
 353     "(with nstlist=0 at the next step).",
 354     "In both cases all the usual output will be written to file.",
 355     "When running with MPI, a signal to one of the [TT]mdrun[tt] processes",
 356     "is sufficient, this signal should not be sent to mpirun or",
 357     "the [TT]mdrun[tt] process that is the parent of the others.",
 358     "[PAR]",
 359     "When [TT]mdrun[tt] is started with MPI, it does not run niced by default."
 360   };
 361   t_commrec    *cr;
 362   t_filenm fnm[] = {
 363     { efTPX, NULL,      NULL,       ffREAD },
 364     { efTRN, "-o",      NULL,       ffWRITE },
 365     { efXTC, "-x",      NULL,       ffOPTWR },
 366     { efCPT, "-cpi",    NULL,       ffOPTRD },
 367     { efCPT, "-cpo",    NULL,       ffOPTWR },
 368     { efSTO, "-c",      "confout",  ffWRITE },
 369     { efEDR, "-e",      "ener",     ffWRITE },
 370     { efLOG, "-g",      "md",       ffWRITE },
 371     { efXVG, "-dhdl",   "dhdl",     ffOPTWR },
 372     { efXVG, "-field",  "field",    ffOPTWR },
 373     { efXVG, "-table",  "table",    ffOPTRD },
 374     { efXVG, "-tabletf", "tabletf",    ffOPTRD },
 375     { efXVG, "-tablep", "tablep",   ffOPTRD },
 376     { efXVG, "-tableb", "table",    ffOPTRD },
 377     { efTRX, "-rerun",  "rerun",    ffOPTRD },
 378     { efXVG, "-tpi",    "tpi",      ffOPTWR },
 379     { efXVG, "-tpid",   "tpidist",  ffOPTWR },
 380     { efEDI, "-ei",     "sam",      ffOPTRD },
 381     { efXVG, "-eo",     "edsam",    ffOPTWR },
 382     { efGCT, "-j",      "wham",     ffOPTRD },
 383     { efGCT, "-jo",     "bam",      ffOPTWR },
 384     { efXVG, "-ffout",  "gct",      ffOPTWR },
 385     { efXVG, "-devout", "deviatie", ffOPTWR },
 386     { efXVG, "-runav",  "runaver",  ffOPTWR },
 387     { efXVG, "-px",     "pullx",    ffOPTWR },
 388     { efXVG, "-pf",     "pullf",    ffOPTWR },
 389     { efXVG, "-ro",     "rotation", ffOPTWR },
 390     { efLOG, "-ra",     "rotangles",ffOPTWR },
 391     { efLOG, "-rs",     "rotslabs", ffOPTWR },
 392     { efLOG, "-rt",     "rottorque",ffOPTWR },
 393     { efMTX, "-mtx",    "nm",       ffOPTWR },
 394     { efNDX, "-dn",     "dipole",   ffOPTWR },
 395     { efRND, "-multidir",NULL,      ffOPTRDMULT},
 396     { efDAT, "-membed", "membed",   ffOPTRD },
 397     { efTOP, "-mp",     "membed",   ffOPTRD },
 398     { efNDX, "-mn",     "membed",   ffOPTRD }
 399   };
 400 #define NFILE asize(fnm)
 401
 402   /* Command line options ! */
 403   gmx_bool bCart        = FALSE;
 404   gmx_bool bPPPME       = FALSE;
 405   gmx_bool bPartDec     = FALSE;
 406   gmx_bool bDDBondCheck = TRUE;
 407   gmx_bool bDDBondComm  = TRUE;
 408   gmx_bool bTunePME     = TRUE;
 409   gmx_bool bTestVerlet  = FALSE;
 410   gmx_bool bVerbose     = FALSE;
 411   gmx_bool bCompact     = TRUE;
 412   gmx_bool bSepPot      = FALSE;
 413   gmx_bool bRerunVSite  = FALSE;
 414   gmx_bool bIonize      = FALSE;
 415   gmx_bool bConfout     = TRUE;
 416   gmx_bool bReproducible = FALSE;
 417
 418   int  npme=-1;
 419   int  nmultisim=0;
 420   int  nstglobalcomm=-1;
 421   int  repl_ex_nst=0;
 422   int  repl_ex_seed=-1;
 423   int  repl_ex_nex=0;
 424   int  nstepout=100;
 425   int  resetstep=-1;
 426   int  nsteps=-2; /* the value -2 means that the mdp option will be used */
 427
 428   rvec realddxyz={0,0,0};
 429   const char *ddno_opt[ddnoNR+1] =
 430     { NULL, "interleave", "pp_pme", "cartesian", NULL };
 431   const char *dddlb_opt[] =
 432     { NULL, "auto", "no", "yes", NULL };
 433   const char *nbpu_opt[] =
 434     { NULL, "auto", "cpu", "gpu", "gpu_cpu", NULL };
 435   real rdd=0.0,rconstr=0.0,dlb_scale=0.8,pforce=-1;
 436   char *ddcsx=NULL,*ddcsy=NULL,*ddcsz=NULL;
 437   real cpt_period=15.0,max_hours=-1;
 438   gmx_bool bAppendFiles=TRUE;
 439   gmx_bool bKeepAndNumCPT=FALSE;
 440   gmx_bool bResetCountersHalfWay=FALSE;
 441   output_env_t oenv=NULL;
 442   const char *deviceOptions = "";
 443
 444   gmx_hw_opt_t hw_opt={0,0,0,0,TRUE,FALSE,0,NULL};
 445
 446   t_pargs pa[] = {
 447
 448     { "-pd",      FALSE, etBOOL,{&bPartDec},
 449       "Use particle decompostion" },
 450     { "-dd",      FALSE, etRVEC,{&realddxyz},
 451       "Domain decomposition grid, 0 is optimize" },
 452     { "-ddorder", FALSE, etENUM, {ddno_opt},
 453       "DD node order" },
 454     { "-npme",    FALSE, etINT, {&npme},
 455       "Number of separate nodes to be used for PME, -1 is guess" },
 456     { "-nt",      FALSE, etINT, {&hw_opt.nthreads_tot},
 457       "Total number of threads to start (0 is guess)" },
 458     { "-ntmpi",   FALSE, etINT, {&hw_opt.nthreads_tmpi},
 459       "Number of thread-MPI threads to start (0 is guess)" },
 460     { "-ntomp",   FALSE, etINT, {&hw_opt.nthreads_omp},
 461       "Number of OpenMP threads per MPI process/thread to start (0 is guess)" },
 462     { "-ntomp_pme", FALSE, etINT, {&hw_opt.nthreads_omp_pme},
 463       "Number of OpenMP threads per MPI process/thread to start (0 is -ntomp)" },
 464     { "-pin",     FALSE, etBOOL, {&hw_opt.bThreadPinning},
 465       "Pin OpenMP threads to cores" },
 466     { "-pinht",   FALSE, etBOOL, {&hw_opt.bPinHyperthreading},
 467       "Always pin threads to Hyper-Threading cores" },
 468     { "-pinoffset", FALSE, etINT, {&hw_opt.core_pinning_offset},
 469       "Core offset for pinning (for running multiple mdrun processes on a single physical node)" },
 470     { "-gpu_id",  FALSE, etSTR, {&hw_opt.gpu_id},
 471       "List of GPU id's to use" },
 472     { "-ddcheck", FALSE, etBOOL, {&bDDBondCheck},
 473       "Check for all bonded interactions with DD" },
 474     { "-ddbondcomm", FALSE, etBOOL, {&bDDBondComm},
 475       "HIDDENUse special bonded atom communication when [TT]-rdd[tt] > cut-off" },
 476     { "-rdd",     FALSE, etREAL, {&rdd},
 477       "The maximum distance for bonded interactions with DD (nm), 0 is determine from initial coordinates" },
 478     { "-rcon",    FALSE, etREAL, {&rconstr},
 479       "Maximum distance for P-LINCS (nm), 0 is estimate" },
 480     { "-dlb",     FALSE, etENUM, {dddlb_opt},
 481       "Dynamic load balancing (with DD)" },
 482     { "-dds",     FALSE, etREAL, {&dlb_scale},
 483       "Minimum allowed dlb scaling of the DD cell size" },
 484     { "-ddcsx",   FALSE, etSTR, {&ddcsx},
 485       "HIDDENThe DD cell sizes in x" },
 486     { "-ddcsy",   FALSE, etSTR, {&ddcsy},
 487       "HIDDENThe DD cell sizes in y" },
 488     { "-ddcsz",   FALSE, etSTR, {&ddcsz},
 489       "HIDDENThe DD cell sizes in z" },
 490     { "-gcom",    FALSE, etINT,{&nstglobalcomm},
 491       "Global communication frequency" },
 492     { "-nb",      FALSE, etENUM, {&nbpu_opt},
 493       "Calculate non-bonded interactions on" },
 494     { "-tunepme", FALSE, etBOOL, {&bTunePME},
 495       "Optimize PME load between PP/PME nodes or GPU/CPU" },
 496     { "-testverlet", FALSE, etBOOL, {&bTestVerlet},
 497       "Test the Verlet non-bonded scheme" },
 498     { "-v",       FALSE, etBOOL,{&bVerbose},
 499       "Be loud and noisy" },
 500     { "-compact", FALSE, etBOOL,{&bCompact},
 501       "Write a compact log file" },
 502     { "-seppot",  FALSE, etBOOL, {&bSepPot},
 503       "Write separate V and dVdl terms for each interaction type and node to the log file(s)" },
 504     { "-pforce",  FALSE, etREAL, {&pforce},
 505       "Print all forces larger than this (kJ/mol nm)" },
 506     { "-reprod",  FALSE, etBOOL,{&bReproducible},
 507       "Try to avoid optimizations that affect binary reproducibility" },
 508     { "-cpt",     FALSE, etREAL, {&cpt_period},
 509       "Checkpoint interval (minutes)" },
 510     { "-cpnum",   FALSE, etBOOL, {&bKeepAndNumCPT},
 511       "Keep and number checkpoint files" },
 512     { "-append",  FALSE, etBOOL, {&bAppendFiles},
 513       "Append to previous output files when continuing from checkpoint instead of adding the simulation part number to all file names" },
 514     { "-nsteps",  FALSE, etINT, {&nsteps},
 515       "Run this number of steps, overrides .mdp file option" },
 516     { "-maxh",   FALSE, etREAL, {&max_hours},
 517       "Terminate after 0.99 times this time (hours)" },
 518     { "-multi",   FALSE, etINT,{&nmultisim},
 519       "Do multiple simulations in parallel" },
 520     { "-replex",  FALSE, etINT, {&repl_ex_nst},
 521       "Attempt replica exchange periodically with this period (steps)" },
 522     { "-nex",  FALSE, etINT, {&repl_ex_nex},
 523       "Number of random exchanges to carry out each exchange interval (N^3 is one suggestion).  -nex zero or not specified gives neighbor replica exchange." },
 524     { "-reseed",  FALSE, etINT, {&repl_ex_seed},
 525       "Seed for replica exchange, -1 is generate a seed" },
 526     { "-rerunvsite", FALSE, etBOOL, {&bRerunVSite},
 527       "HIDDENRecalculate virtual site coordinates with [TT]-rerun[tt]" },
 528     { "-ionize",  FALSE, etBOOL,{&bIonize},
 529       "Do a simulation including the effect of an X-Ray bombardment on your system" },
 530     { "-confout", FALSE, etBOOL, {&bConfout},
 531       "HIDDENWrite the last configuration with [TT]-c[tt] and force checkpointing at the last step" },
 532     { "-stepout", FALSE, etINT, {&nstepout},
 533       "HIDDENFrequency of writing the remaining runtime" },
 534     { "-resetstep", FALSE, etINT, {&resetstep},
 535       "HIDDENReset cycle counters after these many time steps" },
 536     { "-resethway", FALSE, etBOOL, {&bResetCountersHalfWay},
 537       "HIDDENReset the cycle counters after half the number of steps or halfway [TT]-maxh[tt]" }
 538   };
 539   gmx_edsam_t  ed;
 540   unsigned long Flags, PCA_Flags;
 541   ivec     ddxyz;
 542   int      dd_node_order;
 543   gmx_bool     bAddPart;
 544   FILE     *fplog,*fpmulti;
 545   int      sim_part,sim_part_fn;
 546   const char *part_suffix=".part";
 547   char     suffix[STRLEN];
 548   int      rc;
 549   char **multidir=NULL;
 550
 551
 552   cr = init_par(&argc,&argv);
 553
 554   if (MASTER(cr))
 555     CopyRight(stderr, argv[0]);
 556
 557   PCA_Flags = (PCA_CAN_SET_DEFFNM | (MASTER(cr) ? 0 : PCA_QUIET));
 558
 559   /* Comment this in to do fexist calls only on master
 560    * works not with rerun or tables at the moment
 561    * also comment out the version of init_forcerec in md.c
 562    * with NULL instead of opt2fn
 563    */
 564   /*
 565      if (!MASTER(cr))
 566      {
 567      PCA_Flags |= PCA_NOT_READ_NODE;
 568      }
 569      */
 570
 571   parse_common_args(&argc,argv,PCA_Flags, NFILE,fnm,asize(pa),pa,
 572                     asize(desc),desc,0,NULL, &oenv);
 573
 574
 575
 576   /* we set these early because they might be used in init_multisystem()
 577      Note that there is the potential for npme>nnodes until the number of
 578      threads is set later on, if there's thread parallelization. That shouldn't
 579      lead to problems. */
 580   dd_node_order = nenum(ddno_opt);
 581   cr->npmenodes = npme;
 582
 583   /* now check the -multi and -multidir option */
 584   if (opt2bSet("-multidir", NFILE, fnm))
 585   {
 586       int i;
 587       if (nmultisim > 0)
 588       {
 589           gmx_fatal(FARGS, "mdrun -multi and -multidir options are mutually exclusive.");
 590       }
 591       nmultisim = opt2fns(&multidir, "-multidir", NFILE, fnm);
 592   }
 593
 594
 595   if (repl_ex_nst != 0 && nmultisim < 2)
 596       gmx_fatal(FARGS,"Need at least two replicas for replica exchange (option -multi)");
 597
 598   if (repl_ex_nex < 0)
 599       gmx_fatal(FARGS,"Replica exchange number of exchanges needs to be positive");
 600
 601   if (nmultisim > 1) {
 602 #ifndef GMX_THREAD_MPI
 603     gmx_bool bParFn = (multidir == NULL);
 604     init_multisystem(cr, nmultisim, multidir, NFILE, fnm, bParFn);
 605 #else
 606     gmx_fatal(FARGS,"mdrun -multi is not supported with the thread library.Please compile GROMACS with MPI support");
 607 #endif
 608   }
 609
 610   bAddPart = !bAppendFiles;
 611
 612   /* Check if there is ANY checkpoint file available */
 613   sim_part    = 1;
 614   sim_part_fn = sim_part;
 615   if (opt2bSet("-cpi",NFILE,fnm))
 616   {
 617       if (bSepPot && bAppendFiles)
 618       {
 619           gmx_fatal(FARGS,"Output file appending is not supported with -seppot");
 620       }
 621
 622       bAppendFiles =
 623                 read_checkpoint_simulation_part(opt2fn_master("-cpi", NFILE,
 624                                                               fnm,cr),
 625                                                 &sim_part_fn,NULL,cr,
 626                                                 bAppendFiles,NFILE,fnm,
 627                                                 part_suffix,&bAddPart);
 628       if (sim_part_fn==0 && MULTIMASTER(cr))
 629       {
 630           fprintf(stdout,"No previous checkpoint file present, assuming this is a new run.\n");
 631       }
 632       else
 633       {
 634           sim_part = sim_part_fn + 1;
 635       }
 636
 637       if (MULTISIM(cr) && MASTER(cr))
 638       {
 639           if (MULTIMASTER(cr))
 640           {
 641               /* Log file is not yet available, so if there's a
 642                * problem we can only write to stderr. */
 643               fpmulti = stderr;
 644           }
 645           else
 646           {
 647               fpmulti = NULL;
 648           }
 649           check_multi_int(fpmulti,cr->ms,sim_part,"simulation part",TRUE);
 650       }
 651   }
 652   else
 653   {
 654       bAppendFiles = FALSE;
 655   }
 656
 657   if (!bAppendFiles)
 658   {
 659       sim_part_fn = sim_part;
 660   }
 661
 662   if (bAddPart)
 663   {
 664       /* Rename all output files (except checkpoint files) */
 665       /* create new part name first (zero-filled) */
 666       sprintf(suffix,"%s%04d",part_suffix,sim_part_fn);
 667
 668       add_suffix_to_output_names(fnm,NFILE,suffix);
 669       if (MULTIMASTER(cr))
 670       {
 671           fprintf(stdout,"Checkpoint file is from part %d, new output files will be suffixed '%s'.\n",sim_part-1,suffix);
 672       }
 673   }
 674
 675   Flags = opt2bSet("-rerun",NFILE,fnm) ? MD_RERUN : 0;
 676   Flags = Flags | (bSepPot       ? MD_SEPPOT       : 0);
 677   Flags = Flags | (bIonize       ? MD_IONIZE       : 0);
 678   Flags = Flags | (bPartDec      ? MD_PARTDEC      : 0);
 679   Flags = Flags | (bDDBondCheck  ? MD_DDBONDCHECK  : 0);
 680   Flags = Flags | (bDDBondComm   ? MD_DDBONDCOMM   : 0);
 681   Flags = Flags | (bTunePME      ? MD_TUNEPME      : 0);
 682   Flags = Flags | (bTestVerlet   ? MD_TESTVERLET   : 0);
 683   Flags = Flags | (bConfout      ? MD_CONFOUT      : 0);
 684   Flags = Flags | (bRerunVSite   ? MD_RERUN_VSITE  : 0);
 685   Flags = Flags | (bReproducible ? MD_REPRODUCIBLE : 0);
 686   Flags = Flags | (bAppendFiles  ? MD_APPENDFILES  : 0);
 687   Flags = Flags | (opt2parg_bSet("-append", asize(pa),pa) ? MD_APPENDFILESSET : 0);
 688   Flags = Flags | (bKeepAndNumCPT ? MD_KEEPANDNUMCPT : 0);
 689   Flags = Flags | (sim_part>1    ? MD_STARTFROMCPT : 0);
 690   Flags = Flags | (bResetCountersHalfWay ? MD_RESETCOUNTERSHALFWAY : 0);
 691
 692
 693   /* We postpone opening the log file if we are appending, so we can
 694      first truncate the old log file and append to the correct position
 695      there instead.  */
 696   if ((MASTER(cr) || bSepPot) && !bAppendFiles)
 697   {
 698       gmx_log_open(ftp2fn(efLOG,NFILE,fnm),cr,
 699                    !bSepPot,Flags & MD_APPENDFILES,&fplog);
 700       CopyRight(fplog,argv[0]);
 701       please_cite(fplog,"Hess2008b");
 702       please_cite(fplog,"Spoel2005a");
 703       please_cite(fplog,"Lindahl2001a");
 704       please_cite(fplog,"Berendsen95a");
 705   }
 706   else if (!MASTER(cr) && bSepPot)
 707   {
 708       gmx_log_open(ftp2fn(efLOG,NFILE,fnm),cr,!bSepPot,Flags,&fplog);
 709   }
 710   else
 711   {
 712       fplog = NULL;
 713   }
 714
 715   ddxyz[XX] = (int)(realddxyz[XX] + 0.5);
 716   ddxyz[YY] = (int)(realddxyz[YY] + 0.5);
 717   ddxyz[ZZ] = (int)(realddxyz[ZZ] + 0.5);
 718
 719   rc = mdrunner(&hw_opt, fplog,cr,NFILE,fnm,oenv,bVerbose,bCompact,
 720                 nstglobalcomm, ddxyz,dd_node_order,rdd,rconstr,
 721                 dddlb_opt[0],dlb_scale,ddcsx,ddcsy,ddcsz,
 722                 nbpu_opt[0],
 723                 nsteps,nstepout,resetstep,
 724                 nmultisim,repl_ex_nst,repl_ex_nex,repl_ex_seed,
 725                 pforce, cpt_period,max_hours,deviceOptions,Flags);
 726
 727   gmx_finalize_par();
 728
 729   if (MULTIMASTER(cr)) {
 730       thanx(stderr);
 731   }
 732
 733   /* Log file has to be closed in mdrunner if we are appending to it
 734      (fplog not set here) */
 735   if (MASTER(cr) && !bAppendFiles)
 736   {
 737       gmx_log_close(fplog);
 738   }
 739
 740   return rc;
 741 }
 742