src/kernel/pme_loadbal.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2011, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef _pme_loadbal_h
  40 #define _pme_loadbal_h
  41
  42 typedef struct pme_load_balancing *pme_load_balancing_t;
  43
  44 /* Initialze the PP-PME load balacing data and infrastructure */
  45 void pme_loadbal_init(pme_load_balancing_t *pme_lb_p,
  46                      const t_inputrec *ir,matrix box,
  47                      const interaction_const_t *ic,
  48                      gmx_pme_t pmedata);
  49
  50 /* Try to adjust the PME grid and Coulomb cut-off.
  51  * The adjustment is done to generate a different non-bonded PP and PME load.
  52  * With separate PME nodes (PP and PME on different processes) or with
  53  * a GPU (PP on GPU, PME on CPU), PP and PME run on different resources
  54  * and changing the load will affect the load balance and performance.
  55  * The total time for a set of integration steps is monitored and a range
  56  * of grid/cut-off setups is scanned. After calling pme_load_balance many
  57  * times and acquiring enough statistics, the best performing setup is chosen.
  58  * Here we try to take into account fluctuations and changes due to external
  59  * factors as well as DD load balancing.
  60  * Returns TRUE the load balancing continues, FALSE is the balancing is done.
  61  */
  62 gmx_bool pme_load_balance(pme_load_balancing_t pme_lb,
  63                           t_commrec *cr,
  64                           FILE *fp_err,
  65                           FILE *fp_log,
  66                           t_inputrec *ir,
  67                           t_state *state,
  68                           double cycles,
  69                           interaction_const_t *ic,
  70                           nonbonded_verlet_t *nbv,
  71                           gmx_pme_t *pmedata,
  72                           gmx_large_int_t step);
  73
  74 /* Restart the PME load balancing discarding all timings gathered up till now */
  75 void restart_pme_loadbal(pme_load_balancing_t pme_lb, int n);
  76
  77 /* Finish the PME load balancing and print the settings when fplog!=NULL */
  78 void pme_loadbal_done(pme_load_balancing_t pme_lb, FILE *fplog);
  79
  80 #endif /* _pme_loadbal_h */