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