src/gromacs/gmxlib/nonbonded/nb_kernel.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2014,2015,2017,2018 by the GROMACS development team.
   5  * Copyright (c) 2019,2020,2021, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 #ifndef _nb_kernel_h_
  37 #define _nb_kernel_h_
  38
  39 #include <stdio.h>
  40
  41 #include "gromacs/gmxlib/nrnb.h"
  42 #include "gromacs/math/vectypes.h"
  43 #include "gromacs/mdtypes/nblist.h"
  44 #include "gromacs/utility/arrayref.h"
  45 #include "gromacs/utility/real.h"
  46
  47 struct t_blocka;
  48 struct t_mdatoms;
  49
  50 /* Structure to collect kernel data not available in forcerec or mdatoms structures.
  51  * This is only used inside the nonbonded module.
  52  */
  53 typedef struct
  54 {
  55     int                       flags;
  56     const struct t_blocka*    exclusions;
  57     gmx::ArrayRef<const real> lambda;
  58     gmx::ArrayRef<real>       dvdl;
  59
  60     /* pointers to tables */
  61     t_forcetable* table_elec;
  62     t_forcetable* table_vdw;
  63     t_forcetable* table_elec_vdw;
  64
  65     /* potentials */
  66     real* energygrp_elec;
  67     real* energygrp_vdw;
  68 } nb_kernel_data_t;
  69
  70
  71 typedef void nb_kernel_t(t_nblist* gmx_restrict nlist,
  72                          rvec* gmx_restrict x,
  73                          rvec* gmx_restrict f,
  74                          struct t_forcerec* gmx_restrict fr,
  75                          t_mdatoms* gmx_restrict mdatoms,
  76                          nb_kernel_data_t* gmx_restrict kernel_data,
  77                          t_nrnb* gmx_restrict nrnb);
  78
  79 #endif /* _nb_kernel_h_ */