src/gromacs/taskassignment/decidesimulationworkload.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019, 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.
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  *
  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.
  31  *
  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.
  34  */
  35 /*! \internal
  36  * \file
  37  * \brief Declares routine for deciding simulation workload based on GPU tasks.
  38  *
  39  * \author Paul Bauer <paul.bauer.q@gmail.com>
  40  * \ingroup module_taskassignment
  41  */
  42 #ifndef GMX_TASKASSIGNMENT_DECIDESIMULATIONWORKLOAD_H
  43 #define GMX_TASKASSIGNMENT_DECIDESIMULATIONWORKLOAD_H
  44
  45 #include <vector>
  46
  47 #include "gromacs/mdtypes/inputrec.h"
  48 #include "gromacs/mdtypes/simulation_workload.h"
  49
  50 enum class PmeRunMode;
  51
  52 namespace gmx
  53 {
  54
  55 /*! \brief
  56  * Build datastructure that contains decisions whether to run different workload
  57  * task on GPUs.
  58  *
  59  * \param[in] useGpuForNonbonded Whether we have short-range nonbonded interactions
  60  *                               calculations on GPU(s).
  61  * \param[in] pmeRunMode         Run mode indicating what resource is PME execured on.
  62  * \param[in] useGpuForBonded    Whether bonded interactions are calculated on GPU(s).
  63  * \param[in] useGpuForUpdate    Whether coordinate update and constraint solving is performed on
  64  *                               GPU(s).
  65  * \param[in] useGpuForBufferOps Whether buffer ops / reduction are calculated on GPU(s).
  66  * \param[in] useGpuHaloExchange Whether GPU direct communication is used in halo exchange.
  67  * \param[in] useGpuPmePpComm    Whether GPU direct communication is used in PME-PP communication.
  68  * \param[in] haveEwaldSurfaceContribution Whether there is an Ewald surface contribution
  69  * \returns Simulation lifetime constant workload description.
  70  */
  71 SimulationWorkload createSimulationWorkload(bool              useGpuForNonbonded,
  72                                             PmeRunMode        pmeRunMode,
  73                                             bool              useGpuForBonded,
  74                                             bool              useGpuForUpdate,
  75                                             bool              useGpuForBufferOps,
  76                                             bool              useGpuHaloExchange,
  77                                             bool              useGpuPmePpComm,
  78                                             bool              haveEwaldSurfaceContribution);
  79
  80 }  // namespace gmx
  81
  82 #endif