src/gromacs/taskassignment/findallgputasks.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,2018, 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 collecting all GPU tasks found on ranks of a node.
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  * \ingroup module_taskassignment
  41  */
  42 #ifndef GMX_TASKASSIGNMENT_FINDALLGPUTASKS_H
  43 #define GMX_TASKASSIGNMENT_FINDALLGPUTASKS_H
  44
  45 #include "gromacs/taskassignment/taskassignment.h"
  46 #include "gromacs/utility/arrayref.h"
  47
  48 namespace gmx
  49 {
  50
  51 class PhysicalNodeCommunicator;
  52
  53 /*! \brief Returns container of all tasks on all ranks of this node
  54  * that are eligible for GPU execution.
  55  *
  56  * Perform all necessary communication for preparing for task
  57  * assignment. Separating this aspect makes it possible to unit test
  58  * the logic of task assignment. */
  59 GpuTasksOnRanks
  60 findAllGpuTasksOnThisNode(ArrayRef<const GpuTask>         gpuTasksOnThisRank,
  61                           const PhysicalNodeCommunicator &physicalNodeComm);
  62
  63 }  // namespace gmx
  64
  65 #endif