src/gromacs/ewald/pme_only.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020,2021, 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 /*! \libinternal \file
  36  *
  37  * \brief This file contains function declarations necessary for
  38  * running on an MPI rank doing only PME long-ranged work.
  39  *
  40  * \author Berk Hess <hess@kth.se>
  41  * \inlibraryapi
  42  * \ingroup module_ewald
  43  */
  44
  45 #ifndef GMX_EWALD_PME_ONLY_H
  46 #define GMX_EWALD_PME_ONLY_H
  47
  48 #include <string>
  49
  50 #include "gromacs/timing/walltime_accounting.h"
  51
  52 struct t_commrec;
  53 struct t_inputrec;
  54 struct t_nrnb;
  55 struct gmx_pme_t;
  56 struct gmx_wallcycle;
  57
  58 enum class PmeRunMode;
  59 namespace gmx
  60 {
  61 class DeviceStreamManager;
  62 }
  63
  64 /*! \brief Called on the nodes that do PME exclusively */
  65 int gmx_pmeonly(gmx_pme_t*                      pme,
  66                 const t_commrec*                cr,
  67                 t_nrnb*                         mynrnb,
  68                 gmx_wallcycle*                  wcycle,
  69                 gmx_walltime_accounting_t       walltime_accounting,
  70                 t_inputrec*                     ir,
  71                 PmeRunMode                      runMode,
  72                 bool                            useGpuPmePpCommunication,
  73                 const gmx::DeviceStreamManager* deviceStreamManager);
  74
  75 #endif