de9f9abca1a6464b4c5aab94e485fa6238fee632
[alexxy/gromacs.git] / src / gromacs / mdlib / 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  * Copyright (c) 2010,2014,2015,2016, by the GROMACS development team, led by
7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8  * and including many others, as listed in the AUTHORS file in the
9  * top-level source directory and at http://www.gromacs.org.
10  *
11  * GROMACS is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public License
13  * as published by the Free Software Foundation; either version 2.1
14  * of the License, or (at your option) any later version.
15  *
16  * GROMACS is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with GROMACS; if not, see
23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
25  *
26  * If you want to redistribute modifications to GROMACS, please
27  * consider that scientific software is very special. Version
28  * control is crucial - bugs must be traceable. We will be happy to
29  * consider code for inclusion in the official distribution, but
30  * derived work must not be called official GROMACS. Details are found
31  * in the README & COPYING files - if they are missing, get the
32  * official version at http://www.gromacs.org.
33  *
34  * To help us fund GROMACS development, we humbly ask that you cite
35  * the research papers on the package. Check out http://www.gromacs.org.
36  */
37 #ifndef GMX_MDLIB_PERF_EST_H
38 #define GMX_MDLIB_PERF_EST_H
39
40 #include "gromacs/math/vectypes.h"
41 #include "gromacs/utility/basedefinitions.h"
42
43 struct gmx_mtop_t;
44 struct t_inputrec;
45
46 void count_bonded_distances(const gmx_mtop_t *mtop, const t_inputrec *ir,
47                             double *ndistance_c, double *ndistance_simd);
48 /* Count the number of distance calculations in bonded interactions,
49  * separately for plain-C and SIMD bonded functions.
50  * The computational cost is nearly proportional to the numbers.
51  * It is allowed to pass NULL for the last two arguments.
52  */
53
54 float pme_load_estimate(const gmx_mtop_t *mtop, const t_inputrec *ir,
55                         const matrix box);
56 /* Returns an estimate for the relative load of the PME mesh calculation
57  * in the total force calculation.
58  * This estimate is reasonable for recent Intel and AMD x86_64 CPUs.
59  */
60
61 #endif