include/nrnb.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-2004, 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
  39 #ifndef _nrnb_h
  40 #define _nrnb_h
  41 #include "visibility.h"
  42 #include "typedefs.h"
  43 #include "types/commrec.h"
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 GMX_LIBGMX_EXPORT
  50 void init_nrnb(t_nrnb *nrnb);
  51
  52 void cp_nrnb(t_nrnb *dest, t_nrnb *src);
  53
  54 void add_nrnb(t_nrnb *dest, t_nrnb *s1, t_nrnb *s2);
  55
  56 GMX_LIBGMX_EXPORT
  57 void print_nrnb(FILE *out, t_nrnb *nrnb);
  58
  59 void _inc_nrnb(t_nrnb *nrnb,int enr,int inc,char *file,int line);
  60
  61 #if DEBUG_NRNB
  62 #define inc_nrnb(nrnb,enr,inc) _inc_nrnb(nrnb,enr,inc,__FILE__,__LINE__)
  63 #else
  64 #define inc_nrnb(nrnb,enr,inc) (nrnb)->n[enr] += inc
  65 #endif
  66
  67
  68 GMX_LIBGMX_EXPORT
  69 void print_flop(FILE *out,t_nrnb *nrnb,double *nbfs,double *mflop);
  70 /* Calculates the non-bonded forces and flop count.
  71  * When out!=NULL also prints the full count table.
  72  */
  73
  74 GMX_LIBGMX_EXPORT
  75 void print_perf(FILE *out,double nodetime,double realtime,int nprocs,
  76                        gmx_large_int_t nsteps,real delta_t,
  77                        double nbfs,double mflop,
  78                        int omp_nth_pp);
  79 /* Prints the performance, nbfs and mflop come from print_flop */
  80
  81 GMX_LIBGMX_EXPORT
  82 void pr_load(FILE *log,t_commrec *cr,t_nrnb nrnb[]);
  83 /* Print detailed load balancing info */
  84
  85 GMX_LIBGMX_EXPORT
  86 int cost_nrnb(int enr);
  87 /* Cost in i860 cycles of this component of MD */
  88
  89 GMX_LIBGMX_EXPORT
  90 const char *nrnb_str(int enr);
  91 /* Name of this component */
  92
  93 #ifdef __cplusplus
  94 }
  95 #endif
  96
  97 #endif  /* _nrnb_h */