/*
 * This file is part of the GROMACS molecular simulation package.
 *
 * Copyright 1991- The GROMACS Authors
 * and the project initiators Erik Lindahl, Berk Hess and David van der Spoel.
 * Consult the AUTHORS/COPYING files and https://www.gromacs.org for details.
 *
 * GROMACS is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * GROMACS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with GROMACS; if not, see
 * https://www.gnu.org/licenses, or write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
 *
 * If you want to redistribute modifications to GROMACS, please
 * consider that scientific software is very special. Version
 * control is crucial - bugs must be traceable. We will be happy to
 * consider code for inclusion in the official distribution, but
 * derived work must not be called official GROMACS. Details are found
 * in the README & COPYING files - if they are missing, get the
 * official version at https://www.gromacs.org.
 *
 * To help us fund GROMACS development, we humbly ask that you cite
 * the research papers on the package. Check out https://www.gromacs.org.
 */

#ifndef GMX_GMXLIB_NRNB_H
#define GMX_GMXLIB_NRNB_H

#include <cstdint>
#include <cstdio>

#include <array>

enum
{
    eNR_NBKERNEL_VDW_VF,
    eNR_NBKERNEL_VDW_F,
    eNR_NBKERNEL_ELEC_VF,
    eNR_NBKERNEL_ELEC_F,
    eNR_NBKERNEL_ELEC_W3_VF,
    eNR_NBKERNEL_ELEC_W3_F,
    eNR_NBKERNEL_ELEC_W3W3_VF,
    eNR_NBKERNEL_ELEC_W3W3_F,
    eNR_NBKERNEL_ELEC_W4_VF,
    eNR_NBKERNEL_ELEC_W4_F,
    eNR_NBKERNEL_ELEC_W4W4_VF,
    eNR_NBKERNEL_ELEC_W4W4_F,
    eNR_NBKERNEL_ELEC_VDW_VF,
    eNR_NBKERNEL_ELEC_VDW_F,
    eNR_NBKERNEL_ELEC_VDW_W3_VF,
    eNR_NBKERNEL_ELEC_VDW_W3_F,
    eNR_NBKERNEL_ELEC_VDW_W3W3_VF,
    eNR_NBKERNEL_ELEC_VDW_W3W3_F,
    eNR_NBKERNEL_ELEC_VDW_W4_VF,
    eNR_NBKERNEL_ELEC_VDW_W4_F,
    eNR_NBKERNEL_ELEC_VDW_W4W4_VF,
    eNR_NBKERNEL_ELEC_VDW_W4W4_F,

    eNR_NBKERNEL_NR, /* Total number of interaction-specific kernel entries */

    eNR_NBKERNEL_GENERIC = eNR_NBKERNEL_NR, /* Reuse number; KERNEL_NR is not an entry itself */
    eNR_NBKERNEL_GENERIC_CG,
    eNR_NBKERNEL_FREE_ENERGY, /* Add other generic kernels _before_ the free energy one */

    eNR_NBKERNEL_TOTAL_NR,

    eNR_NBNXN_DIST2 = eNR_NBKERNEL_TOTAL_NR, // Reuse the symbolic constant that indicates the last kernel
    eNR_NBNXN_LJ_RF,
    eNR_NBNXN_LJ_RF_E,
    eNR_NBNXN_LJ_TAB,
    eNR_NBNXN_LJ_TAB_E,
    eNR_NBNXN_LJ_EWALD,
    eNR_NBNXN_LJ_EWALD_E,
    eNR_NBNXN_LJ,
    eNR_NBNXN_LJ_E,
    eNR_NBNXN_RF,
    eNR_NBNXN_RF_E,
    eNR_NBNXN_TAB,
    eNR_NBNXN_TAB_E,
    eNR_NBNXN_EWALD,
    eNR_NBNXN_EWALD_E,
    eNR_NBNXN_ADD_LJ_FSW,
    eNR_NBNXN_ADD_LJ_FSW_E,
    eNR_NBNXN_ADD_LJ_PSW,
    eNR_NBNXN_ADD_LJ_PSW_E,
    eNR_NBNXN_ADD_LJ_EWALD,
    eNR_NBNXN_ADD_LJ_EWALD_E,
    eNR_NB14,
    eNR_WEIGHTS,
    eNR_SPREAD,
    eNR_SPREADBSP,
    eNR_GATHERF,
    eNR_GATHERFBSP,
    eNR_FFT,
    eNR_CONV,
    eNR_SOLVEPME,
    eNR_NS,
    eNR_RESETX,
    eNR_SHIFTX,
    eNR_CGCM,
    eNR_FSUM,
    eNR_BONDS,
    eNR_G96BONDS,
    eNR_FENEBONDS,
    eNR_TABBONDS,
    eNR_RESTRBONDS,
    eNR_LINEAR_ANGLES,
    eNR_ANGLES,
    eNR_G96ANGLES,
    eNR_QANGLES,
    eNR_TABANGLES,
    eNR_PROPER,
    eNR_IMPROPER,
    eNR_RB,
    eNR_FOURDIH,
    eNR_TABDIHS,
    eNR_DISRES,
    eNR_ORIRES,
    eNR_DIHRES,
    eNR_POSRES,
    eNR_FBPOSRES,
    eNR_ANGRES,
    eNR_ANGRESZ,
    eNR_MORSE,
    eNR_CUBICBONDS,
    eNR_WALLS,
    eNR_POLARIZE,
    eNR_ANHARM_POL,
    eNR_WPOL,
    eNR_THOLE,
    eNR_VIRIAL,
    eNR_UPDATE,
    eNR_EXTUPDATE,
    eNR_STOPCM,
    eNR_PCOUPL,
    eNR_EKIN,
    eNR_LINCS,
    eNR_LINCSMAT,
    eNR_SHAKE,
    eNR_CONSTR_V,
    eNR_SHAKE_RIJ,
    eNR_CONSTR_VIR,
    eNR_SETTLE,
    eNR_VSITE1,
    eNR_VSITE2,
    eNR_VSITE2FD,
    eNR_VSITE3,
    eNR_VSITE3FD,
    eNR_VSITE3FAD,
    eNR_VSITE3OUT,
    eNR_VSITE4FD,
    eNR_VSITE4FDN,
    eNR_VSITEN,
    eNR_CMAP,
    eNR_UREY_BRADLEY,
    eNR_CROSS_BOND_BOND,
    eNR_CROSS_BOND_ANGLE,
    eNRNB
};


struct t_nrnb
{
    std::array<double, eNRNB> n = { 0 };
};

void clear_nrnb(t_nrnb* nrnb);

void print_nrnb(FILE* out, t_nrnb* nrnb);

/*! \brief Increment the nonbonded kernel flop counters
 *
 * \param nrnb The nonbonded kernel flop counters.
 * \param index Which counter to increment.
 * \param increment How much to increment the counter by.
 */
static inline void inc_nrnb(t_nrnb* nrnb, int index, int increment)
{
    nrnb->n[index] += increment;
}

/*! \brief Atomic increment of nonbonded kernel flop counters
 *
 * \param nrnb The nonbonded kernel flop counters.
 * \param index Which counter to increment.
 * \param increment How much to increment the counter by.
 *
 * Same as inc_nrnb but includes omp atomic pragma
 */
void atomicNrnbIncrement(t_nrnb* nrnb, int index, int increment);

void print_flop(FILE* out, t_nrnb* nrnb, double* nbfs, double* mflop);
/* Calculates the non-bonded forces and flop count.
 * When out!=NULL also prints the full count table.
 */

void print_perf(FILE*   out,
                double  timePerThread,
                double  timePerNode,
                int64_t nrSteps,
                double  timeStep,
                double  nbfs,
                double  mFlop,
                int64_t nrAtoms);
/* Prints the performance, nbfs and mFlop come from print_flop */

int cost_nrnb(int enr);
/* Cost in i860 cycles of this component of MD */

const char* nrnb_str(int enr);
/* Name of this component */

#endif /* GMX_GMXLIB_NRNB_H */
