src/gromacs/mdrun/legacymdrunoptions.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) 2011,2012,2013,2014,2015,2016,2017,2018,2019, 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 /*! \libinternal \file
  38  *
  39  * \brief This file declares helper functionality for legacy option handling for mdrun
  40  *
  41  * \author Berk Hess <hess@kth.se>
  42  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  43  * \author Erik Lindahl <erik@kth.se>
  44  * \author Mark Abraham <mark.j.abraham@gmail.com>
  45  *
  46  * \ingroup module_mdrun
  47  * \inlibraryapi
  48  */
  49 #ifndef GMX_MDRUN_LEGACYMDRUNOPTIONS_H
  50 #define GMX_MDRUN_LEGACYMDRUNOPTIONS_H
  51
  52 #include "gromacs/commandline/filenm.h"
  53 #include "gromacs/commandline/pargs.h"
  54 #include "gromacs/domdec/options.h"
  55 #include "gromacs/hardware/hw_info.h"
  56 #include "gromacs/mdtypes/mdrunoptions.h"
  57
  58 #include "replicaexchange.h"
  59
  60 struct gmx_multisim_t;
  61
  62 namespace gmx
  63 {
  64
  65 /*! \libinternal
  66  * \brief This class provides the same command-line option
  67  * functionality to both CLI and API sessions.
  68  *
  69  * This class should not exist, but is necessary now to introduce
  70  * support for the CLI and API without duplicating code. It should be
  71  * eliminated following the TODOs below.
  72  *
  73  * \todo Modules in mdrun should acquire proper option handling so
  74  * that all of these declarations and defaults are local to the
  75  * modules.
  76  *
  77  * \todo Contextual aspects, such as working directory, MPI
  78  * environment, and environment variable handling are more properly
  79  * the role of SimulationContext, and should be moved there */
  80 class LegacyMdrunOptions
  81 {
  82     public:
  83         //! Ongoing collection of mdrun options
  84         MdrunOptions                     mdrunOptions;
  85         //! Options for the domain decomposition.
  86         DomdecOptions                    domdecOptions;
  87         //! Parallelism-related user options.
  88         gmx_hw_opt_t                     hw_opt;
  89         //! Command-line override for the duration of a neighbor list with the Verlet scheme.
  90         int                              nstlist_cmdline = 0;
  91         //! Parameters for replica-exchange simulations.
  92         ReplicaExchangeParameters        replExParams;
  93
  94         //! Filename options to fill from command-line argument values.
  95         std::vector<t_filenm> filenames =
  96         {{{ efTPR, nullptr,     nullptr,     ffREAD },
  97           { efTRN, "-o",        nullptr,     ffWRITE },
  98           { efCOMPRESSED, "-x", nullptr,     ffOPTWR },
  99           { efCPT, "-cpi",      nullptr,     ffOPTRD | ffALLOW_MISSING },
 100           { efCPT, "-cpo",      nullptr,     ffOPTWR },
 101           { efSTO, "-c",        "confout",   ffWRITE },
 102           { efEDR, "-e",        "ener",      ffWRITE },
 103           { efLOG, "-g",        "md",        ffWRITE },
 104           { efXVG, "-dhdl",     "dhdl",      ffOPTWR },
 105           { efXVG, "-field",    "field",     ffOPTWR },
 106           { efXVG, "-table",    "table",     ffOPTRD },
 107           { efXVG, "-tablep",   "tablep",    ffOPTRD },
 108           { efXVG, "-tableb",   "table",     ffOPTRDMULT },
 109           { efTRX, "-rerun",    "rerun",     ffOPTRD },
 110           { efXVG, "-tpi",      "tpi",       ffOPTWR },
 111           { efXVG, "-tpid",     "tpidist",   ffOPTWR },
 112           { efEDI, "-ei",       "sam",       ffOPTRD },
 113           { efXVG, "-eo",       "edsam",     ffOPTWR },
 114           { efXVG, "-px",       "pullx",     ffOPTWR },
 115           { efXVG, "-pf",       "pullf",     ffOPTWR },
 116           { efXVG, "-ro",       "rotation",  ffOPTWR },
 117           { efLOG, "-ra",       "rotangles", ffOPTWR },
 118           { efLOG, "-rs",       "rotslabs",  ffOPTWR },
 119           { efLOG, "-rt",       "rottorque", ffOPTWR },
 120           { efMTX, "-mtx",      "nm",        ffOPTWR },
 121           { efRND, "-multidir", nullptr,     ffOPTRDMULT},
 122           { efXVG, "-awh",      "awhinit",   ffOPTRD },
 123           { efDAT, "-membed",   "membed",    ffOPTRD },
 124           { efTOP, "-mp",       "membed",    ffOPTRD },
 125           { efNDX, "-mn",       "membed",    ffOPTRD },
 126           { efXVG, "-if",       "imdforces", ffOPTWR },
 127           { efXVG, "-swap",     "swapions",  ffOPTWR }}};
 128
 129         //! Print a warning if any force is larger than this (in kJ/mol nm).
 130         real                             pforce = -1;
 131
 132         //! The value of the -append option
 133         bool                             appendOption = true;
 134
 135         /*! \brief Output context for writing text files
 136          *
 137          * \todo Clarify initialization, ownership, and lifetime. */
 138         gmx_output_env_t                *oenv = nullptr;
 139
 140         /*! \brief Command line options, defaults, docs and storage for them to fill. */
 141         /*! \{ */
 142         rvec              realddxyz                                                  = {0, 0, 0};
 143         const char       *ddrank_opt_choices[static_cast<int>(DdRankOrder::Count)+1] =
 144         { nullptr, "interleave", "pp_pme", "cartesian", nullptr };
 145         const char       *dddlb_opt_choices[static_cast<int>(DlbOption::Count)+1] =
 146         { nullptr, "auto", "no", "yes", nullptr };
 147         const char       *thread_aff_opt_choices[static_cast<int>(ThreadAffinity::Count) + 1] =
 148         { nullptr, "auto", "on", "off", nullptr };
 149         const char       *nbpu_opt_choices[5] =
 150         { nullptr, "auto", "cpu", "gpu", nullptr };
 151         const char       *pme_opt_choices[5] =
 152         { nullptr, "auto", "cpu", "gpu", nullptr };
 153         const char       *pme_fft_opt_choices[5] =
 154         { nullptr, "auto", "cpu", "gpu", nullptr };
 155         const char       *bonded_opt_choices[5] =
 156         { nullptr, "auto", "cpu", "gpu", nullptr };
 157         const char       *gpuIdsAvailable       = "";
 158         const char       *userGpuTaskAssignment = "";
 159
 160         ImdOptions       &imdOptions = mdrunOptions.imdOptions;
 161
 162         t_pargs           pa[47] = {
 163
 164             { "-dd",      FALSE, etRVEC, {&realddxyz},
 165               "Domain decomposition grid, 0 is optimize" },
 166             { "-ddorder", FALSE, etENUM, {ddrank_opt_choices},
 167               "DD rank order" },
 168             { "-npme",    FALSE, etINT, {&domdecOptions.numPmeRanks},
 169               "Number of separate ranks to be used for PME, -1 is guess" },
 170             { "-nt",      FALSE, etINT, {&hw_opt.nthreads_tot},
 171               "Total number of threads to start (0 is guess)" },
 172             { "-ntmpi",   FALSE, etINT, {&hw_opt.nthreads_tmpi},
 173               "Number of thread-MPI ranks to start (0 is guess)" },
 174             { "-ntomp",   FALSE, etINT, {&hw_opt.nthreads_omp},
 175               "Number of OpenMP threads per MPI rank to start (0 is guess)" },
 176             { "-ntomp_pme", FALSE, etINT, {&hw_opt.nthreads_omp_pme},
 177               "Number of OpenMP threads per MPI rank to start (0 is -ntomp)" },
 178             { "-pin",     FALSE, etENUM, {thread_aff_opt_choices},
 179               "Whether mdrun should try to set thread affinities" },
 180             { "-pinoffset", FALSE, etINT, {&hw_opt.core_pinning_offset},
 181               "The lowest logical core number to which mdrun should pin the first thread" },
 182             { "-pinstride", FALSE, etINT, {&hw_opt.core_pinning_stride},
 183               "Pinning distance in logical cores for threads, use 0 to minimize the number of threads per physical core" },
 184             { "-gpu_id",  FALSE, etSTR, {&gpuIdsAvailable},
 185               "List of unique GPU device IDs available to use" },
 186             { "-gputasks",  FALSE, etSTR, {&userGpuTaskAssignment},
 187               "List of GPU device IDs, mapping each PP task on each node to a device" },
 188             { "-ddcheck", FALSE, etBOOL, {&domdecOptions.checkBondedInteractions},
 189               "Check for all bonded interactions with DD" },
 190             { "-ddbondcomm", FALSE, etBOOL, {&domdecOptions.useBondedCommunication},
 191               "HIDDENUse special bonded atom communication when [TT]-rdd[tt] > cut-off" },
 192             { "-rdd",     FALSE, etREAL, {&domdecOptions.minimumCommunicationRange},
 193               "The maximum distance for bonded interactions with DD (nm), 0 is determine from initial coordinates" },
 194             { "-rcon",    FALSE, etREAL, {&domdecOptions.constraintCommunicationRange},
 195               "Maximum distance for P-LINCS (nm), 0 is estimate" },
 196             { "-dlb",     FALSE, etENUM, {dddlb_opt_choices},
 197               "Dynamic load balancing (with DD)" },
 198             { "-dds",     FALSE, etREAL, {&domdecOptions.dlbScaling},
 199               "Fraction in (0,1) by whose reciprocal the initial DD cell size will be increased in order to "
 200               "provide a margin in which dynamic load balancing can act while preserving the minimum cell size." },
 201             { "-ddcsx",   FALSE, etSTR, {&domdecOptions.cellSizeX},
 202               "HIDDENA string containing a vector of the relative sizes in the x "
 203               "direction of the corresponding DD cells. Only effective with static "
 204               "load balancing." },
 205             { "-ddcsy",   FALSE, etSTR, {&domdecOptions.cellSizeY},
 206               "HIDDENA string containing a vector of the relative sizes in the y "
 207               "direction of the corresponding DD cells. Only effective with static "
 208               "load balancing." },
 209             { "-ddcsz",   FALSE, etSTR, {&domdecOptions.cellSizeZ},
 210               "HIDDENA string containing a vector of the relative sizes in the z "
 211               "direction of the corresponding DD cells. Only effective with static "
 212               "load balancing." },
 213             { "-nb",      FALSE, etENUM, {nbpu_opt_choices},
 214               "Calculate non-bonded interactions on" },
 215             { "-nstlist", FALSE, etINT, {&nstlist_cmdline},
 216               "Set nstlist when using a Verlet buffer tolerance (0 is guess)" },
 217             { "-tunepme", FALSE, etBOOL, {&mdrunOptions.tunePme},
 218               "Optimize PME load between PP/PME ranks or GPU/CPU (only with the Verlet cut-off scheme)" },
 219             { "-pme",     FALSE, etENUM, {pme_opt_choices},
 220               "Perform PME calculations on" },
 221             { "-pmefft", FALSE, etENUM, {pme_fft_opt_choices},
 222               "Perform PME FFT calculations on" },
 223             { "-bonded",     FALSE, etENUM, {bonded_opt_choices},
 224               "Perform bonded calculations on" },
 225             { "-v",       FALSE, etBOOL, {&mdrunOptions.verbose},
 226               "Be loud and noisy" },
 227             { "-pforce",  FALSE, etREAL, {&pforce},
 228               "Print all forces larger than this (kJ/mol nm)" },
 229             { "-reprod",  FALSE, etBOOL, {&mdrunOptions.reproducible},
 230               "Try to avoid optimizations that affect binary reproducibility" },
 231             { "-cpt",     FALSE, etREAL, {&mdrunOptions.checkpointOptions.period},
 232               "Checkpoint interval (minutes)" },
 233             { "-cpnum",   FALSE, etBOOL, {&mdrunOptions.checkpointOptions.keepAndNumberCheckpointFiles},
 234               "Keep and number checkpoint files" },
 235             { "-append",  FALSE, etBOOL, {&appendOption},
 236               "Append to previous output files when continuing from checkpoint instead of adding the simulation part number to all file names" },
 237             { "-nsteps",  FALSE, etINT64, {&mdrunOptions.numStepsCommandline},
 238               "Run this number of steps, overrides .mdp file option (-1 means infinite, -2 means use mdp option, smaller is invalid)" },
 239             { "-maxh",   FALSE, etREAL, {&mdrunOptions.maximumHoursToRun},
 240               "Terminate after 0.99 times this time (hours)" },
 241             { "-replex",  FALSE, etINT, {&replExParams.exchangeInterval},
 242               "Attempt replica exchange periodically with this period (steps)" },
 243             { "-nex",  FALSE, etINT, {&replExParams.numExchanges},
 244               "Number of random exchanges to carry out each exchange interval (N^3 is one suggestion).  -nex zero or not specified gives neighbor replica exchange." },
 245             { "-reseed",  FALSE, etINT, {&replExParams.randomSeed},
 246               "Seed for replica exchange, -1 is generate a seed" },
 247             { "-imdport",    FALSE, etINT, {&imdOptions.port},
 248               "HIDDENIMD listening port" },
 249             { "-imdwait",  FALSE, etBOOL, {&imdOptions.wait},
 250               "HIDDENPause the simulation while no IMD client is connected" },
 251             { "-imdterm",  FALSE, etBOOL, {&imdOptions.terminatable},
 252               "HIDDENAllow termination of the simulation from IMD client" },
 253             { "-imdpull",  FALSE, etBOOL, {&imdOptions.pull},
 254               "HIDDENAllow pulling in the simulation from IMD client" },
 255             { "-rerunvsite", FALSE, etBOOL, {&mdrunOptions.rerunConstructVsites},
 256               "HIDDENRecalculate virtual site coordinates with [TT]-rerun[tt]" },
 257             { "-confout", FALSE, etBOOL, {&mdrunOptions.writeConfout},
 258               "HIDDENWrite the last configuration with [TT]-c[tt] and force checkpointing at the last step" },
 259             { "-stepout", FALSE, etINT, {&mdrunOptions.verboseStepPrintInterval},
 260               "HIDDENFrequency of writing the remaining wall clock time for the run" },
 261             { "-resetstep", FALSE, etINT, {&mdrunOptions.timingOptions.resetStep},
 262               "HIDDENReset cycle counters after these many time steps" },
 263             { "-resethway", FALSE, etBOOL, {&mdrunOptions.timingOptions.resetHalfway},
 264               "HIDDENReset the cycle counters after half the number of steps or halfway [TT]-maxh[tt]" }
 265         };
 266         /*! \} */
 267
 268         //! Handle to communication object.
 269         t_commrec        *cr = nullptr;
 270         //! Multi-simulation object.
 271         gmx_multisim_t   *ms = nullptr;
 272
 273         //! Parses the command-line input and prepares to start mdrun.
 274         int updateFromCommandLine(int argc, char **argv, ArrayRef<const char *> desc);
 275
 276         ~LegacyMdrunOptions();
 277 };
 278
 279 } // end namespace gmx
 280
 281 #endif