61dd844dbc2d733f87c3edfc6f2039f0b5004d4c
[alexxy/gromacs.git] / include / perf_est.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-2008, The GROMACS development team,
6  * check out http://www.gromacs.org for more information.
7  * Copyright (c) 2012, 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 #ifndef _perf_est_h
39 #define _perf_est_h
40 #include "visibility.h"
41 #include "typedefs.h"
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 int n_bonded_dx(gmx_mtop_t *mtop,gmx_bool bExcl);
48 /* Returns the number of pbc_rvec_sub calls required for bonded interactions.
49  * This number is also roughly proportional to the computational cost.
50  */
51
52 GMX_LIBMD_EXPORT
53 float pme_load_estimate(gmx_mtop_t *mtop,t_inputrec *ir,matrix box);
54 /* Returns an estimate for the relative load of the PME mesh calculation
55  * in the total force calculation.
56  * This estimate is reasonable for recent Intel and AMD x86_64 CPUs.
57  */
58
59 #ifdef __cplusplus
60 }
61 #endif
62
63 #endif  /* _perf_est_h */