src/gromacs/gmxlib/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  * Copyright (c) 2013,2014,2015,2017,2018,2019, 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
  38 #ifndef GMX_GMXLIB_NRNB_H
  39 #define GMX_GMXLIB_NRNB_H
  40
  41 #include <stdio.h>
  42
  43 #include "gromacs/utility/basedefinitions.h"
  44
  45 #define eNR_NBKERNEL_NONE (-1)
  46
  47 enum
  48 {
  49     eNR_NBKERNEL_VDW_VF,
  50     eNR_NBKERNEL_VDW_F,
  51     eNR_NBKERNEL_ELEC_VF,
  52     eNR_NBKERNEL_ELEC_F,
  53     eNR_NBKERNEL_ELEC_W3_VF,
  54     eNR_NBKERNEL_ELEC_W3_F,
  55     eNR_NBKERNEL_ELEC_W3W3_VF,
  56     eNR_NBKERNEL_ELEC_W3W3_F,
  57     eNR_NBKERNEL_ELEC_W4_VF,
  58     eNR_NBKERNEL_ELEC_W4_F,
  59     eNR_NBKERNEL_ELEC_W4W4_VF,
  60     eNR_NBKERNEL_ELEC_W4W4_F,
  61     eNR_NBKERNEL_ELEC_VDW_VF,
  62     eNR_NBKERNEL_ELEC_VDW_F,
  63     eNR_NBKERNEL_ELEC_VDW_W3_VF,
  64     eNR_NBKERNEL_ELEC_VDW_W3_F,
  65     eNR_NBKERNEL_ELEC_VDW_W3W3_VF,
  66     eNR_NBKERNEL_ELEC_VDW_W3W3_F,
  67     eNR_NBKERNEL_ELEC_VDW_W4_VF,
  68     eNR_NBKERNEL_ELEC_VDW_W4_F,
  69     eNR_NBKERNEL_ELEC_VDW_W4W4_VF,
  70     eNR_NBKERNEL_ELEC_VDW_W4W4_F,
  71
  72     eNR_NBKERNEL_NR, /* Total number of interaction-specific kernel entries */
  73
  74     eNR_NBKERNEL_GENERIC = eNR_NBKERNEL_NR, /* Reuse number; KERNEL_NR is not an entry itself */
  75     eNR_NBKERNEL_GENERIC_CG,
  76     eNR_NBKERNEL_FREE_ENERGY, /* Add other generic kernels _before_ the free energy one */
  77
  78     eNR_NBKERNEL_TOTAL_NR,
  79
  80     eNR_NBNXN_DIST2 = eNR_NBKERNEL_TOTAL_NR, // Reuse the symbolic constant that indicates the last kernel
  81     eNR_NBNXN_LJ_RF,
  82     eNR_NBNXN_LJ_RF_E,
  83     eNR_NBNXN_LJ_TAB,
  84     eNR_NBNXN_LJ_TAB_E,
  85     eNR_NBNXN_LJ_EWALD,
  86     eNR_NBNXN_LJ_EWALD_E,
  87     eNR_NBNXN_LJ,
  88     eNR_NBNXN_LJ_E,
  89     eNR_NBNXN_RF,
  90     eNR_NBNXN_RF_E,
  91     eNR_NBNXN_TAB,
  92     eNR_NBNXN_TAB_E,
  93     eNR_NBNXN_EWALD,
  94     eNR_NBNXN_EWALD_E,
  95     eNR_NBNXN_ADD_LJ_FSW,
  96     eNR_NBNXN_ADD_LJ_FSW_E,
  97     eNR_NBNXN_ADD_LJ_PSW,
  98     eNR_NBNXN_ADD_LJ_PSW_E,
  99     eNR_NBNXN_ADD_LJ_EWALD,
 100     eNR_NBNXN_ADD_LJ_EWALD_E,
 101     eNR_NB14,
 102     eNR_WEIGHTS,
 103     eNR_SPREAD,
 104     eNR_SPREADBSP,
 105     eNR_GATHERF,
 106     eNR_GATHERFBSP,
 107     eNR_FFT,
 108     eNR_CONV,
 109     eNR_SOLVEPME,
 110     eNR_NS,
 111     eNR_RESETX,
 112     eNR_SHIFTX,
 113     eNR_CGCM,
 114     eNR_FSUM,
 115     eNR_BONDS,
 116     eNR_G96BONDS,
 117     eNR_FENEBONDS,
 118     eNR_TABBONDS,
 119     eNR_RESTRBONDS,
 120     eNR_LINEAR_ANGLES,
 121     eNR_ANGLES,
 122     eNR_G96ANGLES,
 123     eNR_QANGLES,
 124     eNR_TABANGLES,
 125     eNR_PROPER,
 126     eNR_IMPROPER,
 127     eNR_RB,
 128     eNR_FOURDIH,
 129     eNR_TABDIHS,
 130     eNR_DISRES,
 131     eNR_ORIRES,
 132     eNR_DIHRES,
 133     eNR_POSRES,
 134     eNR_FBPOSRES,
 135     eNR_ANGRES,
 136     eNR_ANGRESZ,
 137     eNR_MORSE,
 138     eNR_CUBICBONDS,
 139     eNR_WALLS,
 140     eNR_POLARIZE,
 141     eNR_ANHARM_POL,
 142     eNR_WPOL,
 143     eNR_THOLE,
 144     eNR_VIRIAL,
 145     eNR_UPDATE,
 146     eNR_EXTUPDATE,
 147     eNR_STOPCM,
 148     eNR_PCOUPL,
 149     eNR_EKIN,
 150     eNR_LINCS,
 151     eNR_LINCSMAT,
 152     eNR_SHAKE,
 153     eNR_CONSTR_V,
 154     eNR_SHAKE_RIJ,
 155     eNR_CONSTR_VIR,
 156     eNR_SETTLE,
 157     eNR_VSITE2,
 158     eNR_VSITE2FD,
 159     eNR_VSITE3,
 160     eNR_VSITE3FD,
 161     eNR_VSITE3FAD,
 162     eNR_VSITE3OUT,
 163     eNR_VSITE4FD,
 164     eNR_VSITE4FDN,
 165     eNR_VSITEN,
 166     eNR_CMAP,
 167     eNR_UREY_BRADLEY,
 168     eNR_CROSS_BOND_BOND,
 169     eNR_CROSS_BOND_ANGLE,
 170     eNRNB
 171 };
 172
 173
 174 struct t_nrnb
 175 {
 176     double n[eNRNB] = { 0 };
 177 };
 178
 179 struct t_commrec;
 180
 181 void clear_nrnb(t_nrnb* nrnb);
 182
 183 void add_nrnb(t_nrnb* dest, t_nrnb* s1, t_nrnb* s2);
 184
 185 void print_nrnb(FILE* out, t_nrnb* nrnb);
 186
 187 void _inc_nrnb(t_nrnb* nrnb, int enr, int inc, char* file, int line);
 188
 189 #ifdef DEBUG_NRNB
 190 #    define inc_nrnb(nrnb, enr, inc) _inc_nrnb(nrnb, enr, inc, __FILE__, __LINE__)
 191 #else
 192 #    define inc_nrnb(nrnb, enr, inc) (nrnb)->n[enr] += inc
 193 #endif
 194
 195
 196 void print_flop(FILE* out, t_nrnb* nrnb, double* nbfs, double* mflop);
 197 /* Calculates the non-bonded forces and flop count.
 198  * When out!=NULL also prints the full count table.
 199  */
 200
 201 void print_perf(FILE* out, double nodetime, double realtime, int64_t nsteps, double delta_t, double nbfs, double mflop);
 202 /* Prints the performance, nbfs and mflop come from print_flop */
 203
 204 void pr_load(FILE* log, struct t_commrec* cr, t_nrnb nrnb[]);
 205 /* Print detailed load balancing info */
 206
 207 int cost_nrnb(int enr);
 208 /* Cost in i860 cycles of this component of MD */
 209
 210 const char* nrnb_str(int enr);
 211 /* Name of this component */
 212
 213 #endif /* GMX_GMXLIB_NRNB_H */