Separate job script files for gmxapi package versions.
[gromacs.git] / src / gromacs / taskassignment / decidesimulationworkload.cpp
blob5c5cdaeb3f606e453b68bdf9833152407f4d921f
1 /*
2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2019,2020, by the GROMACS development team, led by
5 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 * and including many others, as listed in the AUTHORS file in the
7 * top-level source directory and at http://www.gromacs.org.
9 * GROMACS is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 2.1
12 * of the License, or (at your option) any later version.
14 * GROMACS is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with GROMACS; if not, see
21 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * If you want to redistribute modifications to GROMACS, please
25 * consider that scientific software is very special. Version
26 * control is crucial - bugs must be traceable. We will be happy to
27 * consider code for inclusion in the official distribution, but
28 * derived work must not be called official GROMACS. Details are found
29 * in the README & COPYING files - if they are missing, get the
30 * official version at http://www.gromacs.org.
32 * To help us fund GROMACS development, we humbly ask that you cite
33 * the research papers on the package. Check out http://www.gromacs.org.
35 /*! \internal \file
36 * \brief
37 * Defines routine for building simulation workload task description.
39 * \author Paul Bauer <paul.bauer.q@gmail.com>
40 * \ingroup module_taskassignment
42 #include "gmxpre.h"
44 #include "decidesimulationworkload.h"
46 #include "gromacs/ewald/pme.h"
47 #include "gromacs/mdtypes/multipletimestepping.h"
48 #include "gromacs/taskassignment/decidegpuusage.h"
49 #include "gromacs/taskassignment/taskassignment.h"
50 #include "gromacs/utility/arrayref.h"
52 namespace gmx
55 SimulationWorkload createSimulationWorkload(const t_inputrec& inputrec,
56 const bool disableNonbondedCalculation,
57 const DevelopmentFeatureFlags& devFlags,
58 bool useGpuForNonbonded,
59 PmeRunMode pmeRunMode,
60 bool useGpuForBonded,
61 bool useGpuForUpdate,
62 bool useGpuDirectHalo)
64 SimulationWorkload simulationWorkload;
65 simulationWorkload.computeNonbonded = !disableNonbondedCalculation;
66 simulationWorkload.computeNonbondedAtMtsLevel1 =
67 simulationWorkload.computeNonbonded && inputrec.useMts
68 && inputrec.mtsLevels.back().forceGroups[static_cast<int>(MtsForceGroups::Nonbonded)];
69 simulationWorkload.computeMuTot = inputrecNeedMutot(&inputrec);
70 simulationWorkload.useCpuNonbonded = !useGpuForNonbonded;
71 simulationWorkload.useGpuNonbonded = useGpuForNonbonded;
72 simulationWorkload.useCpuPme = (pmeRunMode == PmeRunMode::CPU);
73 simulationWorkload.useGpuPme = (pmeRunMode == PmeRunMode::GPU || pmeRunMode == PmeRunMode::Mixed);
74 simulationWorkload.useGpuPmeFft = (pmeRunMode == PmeRunMode::Mixed);
75 simulationWorkload.useGpuBonded = useGpuForBonded;
76 simulationWorkload.useGpuUpdate = useGpuForUpdate;
77 simulationWorkload.useGpuBufferOps = (devFlags.enableGpuBufferOps || useGpuForUpdate)
78 && !simulationWorkload.computeNonbondedAtMtsLevel1;
79 simulationWorkload.useGpuHaloExchange = useGpuDirectHalo;
80 simulationWorkload.useGpuPmePpCommunication =
81 devFlags.enableGpuPmePPComm && (pmeRunMode == PmeRunMode::GPU);
82 simulationWorkload.useGpuDirectCommunication =
83 devFlags.enableGpuHaloExchange || devFlags.enableGpuPmePPComm;
84 simulationWorkload.haveEwaldSurfaceContribution = haveEwaldSurfaceContribution(inputrec);
86 return simulationWorkload;
89 } // namespace gmx