src/gromacs/mdrun/legacymdrunoptions.cpp

   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-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 /*! \internal \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  */
  48 #include "gmxpre.h"
  49
  50 #include "legacymdrunoptions.h"
  51
  52 #include <cstring>
  53
  54 #include "gromacs/math/functions.h"
  55 #include "gromacs/utility/arraysize.h"
  56 #include "gromacs/utility/fatalerror.h"
  57
  58 namespace gmx
  59 {
  60
  61 /*! \brief Return whether the command-line parameter that
  62  *  will trigger a multi-simulation is set */
  63 static bool is_multisim_option_set(int argc, const char* const argv[])
  64 {
  65     for (int i = 0; i < argc; ++i)
  66     {
  67         if (strcmp(argv[i], "-multidir") == 0)
  68         {
  69             return true;
  70         }
  71     }
  72     return false;
  73 }
  74
  75 int LegacyMdrunOptions::updateFromCommandLine(int argc, char** argv, ArrayRef<const char*> desc)
  76 {
  77     unsigned long PCA_Flags = PCA_CAN_SET_DEFFNM;
  78     // With -multidir, the working directory still needs to be
  79     // changed, so we can't check for the existence of files during
  80     // parsing.  It isn't useful to do any completion based on file
  81     // system contents, either.
  82     if (is_multisim_option_set(argc, argv))
  83     {
  84         PCA_Flags |= PCA_DISABLE_INPUT_FILE_CHECKING;
  85     }
  86
  87     if (!parse_common_args(&argc, argv, PCA_Flags, ssize(filenames), filenames.data(), asize(pa),
  88                            pa, ssize(desc), desc.data(), 0, nullptr, &oenv))
  89     {
  90         return 0;
  91     }
  92
  93     // Handle the options that permits the user to either declare
  94     // which compatible GPUs are availble for use, or to select a GPU
  95     // task assignment. Either could be in an environment variable (so
  96     // that there is a way to customize it, when using MPI in
  97     // heterogeneous contexts).
  98     {
  99         // TODO Argument parsing can't handle std::string. We should
 100         // fix that by changing the parsing, once more of the roles of
 101         // handling, validating and implementing defaults for user
 102         // command-line options have been seperated.
 103         hw_opt.gpuIdsAvailable       = gpuIdsAvailable;
 104         hw_opt.userGpuTaskAssignment = userGpuTaskAssignment;
 105
 106         const char* env = getenv("GMX_GPU_ID");
 107         if (env != nullptr)
 108         {
 109             if (!hw_opt.gpuIdsAvailable.empty())
 110             {
 111                 gmx_fatal(FARGS, "GMX_GPU_ID and -gpu_id can not be used at the same time");
 112             }
 113             hw_opt.gpuIdsAvailable = env;
 114         }
 115
 116         env = getenv("GMX_GPUTASKS");
 117         if (env != nullptr)
 118         {
 119             if (!hw_opt.userGpuTaskAssignment.empty())
 120             {
 121                 gmx_fatal(FARGS, "GMX_GPUTASKS and -gputasks can not be used at the same time");
 122             }
 123             hw_opt.userGpuTaskAssignment = env;
 124         }
 125
 126         if (!hw_opt.gpuIdsAvailable.empty() && !hw_opt.userGpuTaskAssignment.empty())
 127         {
 128             gmx_fatal(FARGS, "-gpu_id and -gputasks cannot be used at the same time");
 129         }
 130     }
 131
 132     hw_opt.threadAffinity = static_cast<ThreadAffinity>(nenum(thread_aff_opt_choices));
 133
 134     if (!opt2parg_bSet("-append", asize(pa), pa))
 135     {
 136         mdrunOptions.appendingBehavior = AppendingBehavior::Auto;
 137     }
 138     else
 139     {
 140         if (opt2parg_bool("-append", asize(pa), pa))
 141         {
 142             mdrunOptions.appendingBehavior = AppendingBehavior::Appending;
 143         }
 144         else
 145         {
 146             mdrunOptions.appendingBehavior = AppendingBehavior::NoAppending;
 147         }
 148     }
 149
 150     mdrunOptions.rerun            = opt2bSet("-rerun", ssize(filenames), filenames.data());
 151     mdrunOptions.ntompOptionIsSet = opt2parg_bSet("-ntomp", asize(pa), pa);
 152
 153     domdecOptions.rankOrder    = static_cast<DdRankOrder>(nenum(ddrank_opt_choices));
 154     domdecOptions.dlbOption    = static_cast<DlbOption>(nenum(dddlb_opt_choices));
 155     domdecOptions.numCells[XX] = roundToInt(realddxyz[XX]);
 156     domdecOptions.numCells[YY] = roundToInt(realddxyz[YY]);
 157     domdecOptions.numCells[ZZ] = roundToInt(realddxyz[ZZ]);
 158
 159     return 1;
 160 }
 161
 162 LegacyMdrunOptions::~LegacyMdrunOptions()
 163 {
 164     output_env_done(oenv);
 165 }
 166
 167 } // namespace gmx