src/programs/mdrun/pme_loadbal.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014, 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
  36 #ifndef _pme_loadbal_h
  37 #define _pme_loadbal_h
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 typedef struct pme_load_balancing *pme_load_balancing_t;
  44
  45 /* Initialze the PP-PME load balacing data and infrastructure */
  46 void pme_loadbal_init(pme_load_balancing_t *pme_lb_p,
  47                       const t_inputrec *ir, matrix box,
  48                       const interaction_const_t *ic,
  49                       gmx_pme_t pmedata);
  50
  51 /* Try to adjust the PME grid and Coulomb cut-off.
  52  * The adjustment is done to generate a different non-bonded PP and PME load.
  53  * With separate PME nodes (PP and PME on different processes) or with
  54  * a GPU (PP on GPU, PME on CPU), PP and PME run on different resources
  55  * and changing the load will affect the load balance and performance.
  56  * The total time for a set of integration steps is monitored and a range
  57  * of grid/cut-off setups is scanned. After calling pme_load_balance many
  58  * times and acquiring enough statistics, the best performing setup is chosen.
  59  * Here we try to take into account fluctuations and changes due to external
  60  * factors as well as DD load balancing.
  61  * Returns TRUE the load balancing continues, FALSE is the balancing is done.
  62  */
  63 gmx_bool pme_load_balance(pme_load_balancing_t        pme_lb,
  64                           t_commrec                  *cr,
  65                           FILE                       *fp_err,
  66                           FILE                       *fp_log,
  67                           t_inputrec                 *ir,
  68                           t_state                    *state,
  69                           double                      cycles,
  70                           interaction_const_t        *ic,
  71                           struct nonbonded_verlet_t  *nbv,
  72                           gmx_pme_t                  *pmedata,
  73                           gmx_int64_t                 step);
  74
  75 /* Restart the PME load balancing discarding all timings gathered up till now */
  76 void restart_pme_loadbal(pme_load_balancing_t pme_lb, int n);
  77
  78 /* Finish the PME load balancing and print the settings when fplog!=NULL */
  79 void pme_loadbal_done(pme_load_balancing_t pme_lb,
  80                       t_commrec *cr, FILE *fplog,
  81                       gmx_bool bNonBondedOnGPU);
  82
  83 #ifdef __cplusplus
  84 }
  85 #endif
  86
  87 #endif /* _pme_loadbal_h */