src/gromacs/ewald/pme_load_balancing.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016,2017,2018,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 /*! \libinternal \file
  36  *
  37  * \brief This file contains function declarations necessary for
  38  * managing automatic load balance of PME calculations (Coulomb and
  39  * LJ).
  40  *
  41  * \author Berk Hess <hess@kth.se>
  42  * \inlibraryapi
  43  * \ingroup module_ewald
  44  */
  45
  46 #ifndef GMX_EWALD_PME_LOAD_BALANCING_H
  47 #define GMX_EWALD_PME_LOAD_BALANCING_H
  48
  49 #include "gromacs/mdtypes/forcerec.h"
  50 #include "gromacs/mdtypes/interaction_const.h"
  51 #include "gromacs/timing/wallcycle.h"
  52
  53 struct nonbonded_verlet_t;
  54 struct t_commrec;
  55 struct t_inputrec;
  56 class t_state;
  57
  58 namespace gmx
  59 {
  60 class MDLogger;
  61 template<typename T>
  62 class ArrayRef;
  63 } // namespace gmx
  64
  65 /*! \brief Object to manage PME load balancing */
  66 struct pme_load_balancing_t;
  67
  68 /*! \brief Return whether PME load balancing is active */
  69 bool pme_loadbal_is_active(const pme_load_balancing_t* pme_lb);
  70
  71 /*! \brief Initialize the PP-PME load balacing data and infrastructure
  72  *
  73  * Initialize the PP-PME load balacing data and infrastructure.
  74  * The actual load balancing might start right away, later or never.
  75  * The PME grid in pmedata is reused for smaller grids to lower the memory
  76  * usage.
  77  */
  78 void pme_loadbal_init(pme_load_balancing_t**     pme_lb_p,
  79                       t_commrec*                 cr,
  80                       const gmx::MDLogger&       mdlog,
  81                       const t_inputrec&          ir,
  82                       const matrix               box,
  83                       const interaction_const_t& ic,
  84                       const nonbonded_verlet_t&  nbv,
  85                       gmx_pme_t*                 pmedata,
  86                       gmx_bool                   bUseGPU);
  87
  88 /*! \brief Process cycles and PME load balance when necessary
  89  *
  90  * Process the cycles measured over the last nstlist steps and then
  91  * either continue balancing or check if we need to trigger balancing.
  92  * Should be called after the ewcSTEP cycle counter has been stopped.
  93  * Returns if the load balancing is printing to fp_err.
  94  */
  95 void pme_loadbal_do(pme_load_balancing_t*          pme_lb,
  96                     struct t_commrec*              cr,
  97                     FILE*                          fp_err,
  98                     FILE*                          fp_log,
  99                     const gmx::MDLogger&           mdlog,
 100                     const t_inputrec&              ir,
 101                     t_forcerec*                    fr,
 102                     const matrix                   box,
 103                     gmx::ArrayRef<const gmx::RVec> x,
 104                     gmx_wallcycle_t                wcycle,
 105                     int64_t                        step,
 106                     int64_t                        step_rel,
 107                     gmx_bool*                      bPrinting,
 108                     bool                           useGpuPmePpCommunication);
 109
 110 /*! \brief Finish the PME load balancing and print the settings when fplog!=NULL */
 111 void pme_loadbal_done(pme_load_balancing_t* pme_lb, FILE* fplog, const gmx::MDLogger& mdlog, gmx_bool bNonBondedOnGPU);
 112
 113 #endif