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, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 #ifndef _nb_kernel_h_
  36 #define _nb_kernel_h_
  37
  38 #include <stdio.h>
  39
  40 #include "gromacs/gmxlib/nrnb.h"
  41 #include "gromacs/math/vectypes.h"
  42 #include "gromacs/mdtypes/forcerec.h"
  43 #include "gromacs/mdtypes/mdatom.h"
  44 #include "gromacs/mdtypes/nblist.h"
  45 #include "gromacs/utility/real.h"
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50 #if 0
  51 } /* fixes auto-indentation problems */
  52 #endif
  53
  54 /*! \def gmx_inline
  55  * \brief
  56  * Keyword to use in C code instead of C99 `inline`.
  57  *
  58  * Some of the C compilers we support do not recognize the C99 keyword
  59  * `inline`.  This macro should be used in C code and in shared C/C++ headers
  60  * to indicate a function is inlined.
  61  * C++ code should use plain `inline`, as that is already in C++98.
  62  */
  63 #if !defined __cplusplus && defined _MSC_VER
  64 #define gmx_inline __inline
  65 #else
  66 /* C++ or C99 */
  67 #define gmx_inline inline
  68 #endif
  69
  70 struct t_blocka;
  71
  72 /* Structure to collect kernel data not available in forcerec or mdatoms structures.
  73  * This is only used inside the nonbonded module.
  74  */
  75 typedef struct
  76 {
  77     int                    flags;
  78     const struct t_blocka *exclusions;
  79     real                  *lambda;
  80     real                  *dvdl;
  81
  82     /* pointers to tables */
  83     t_forcetable *     table_elec;
  84     t_forcetable *     table_vdw;
  85     t_forcetable *     table_elec_vdw;
  86
  87     /* potentials */
  88     real *             energygrp_elec;
  89     real *             energygrp_vdw;
  90 }
  91 nb_kernel_data_t;
  92
  93
  94 typedef void
  95     nb_kernel_t (t_nblist *                nlist,
  96                  rvec *                    x,
  97                  rvec *                    f,
  98                  const struct t_forcerec * fr,
  99                  const t_mdatoms *         mdatoms,
 100                  nb_kernel_data_t *        kernel_data,
 101                  t_nrnb *                  nrnb);
 102
 103
 104 /* Structure with a kernel pointer and settings. This cannot be abstract
 105  * since we define the kernel list statically for each architecture in a header,
 106  * and use it to set up the kernel hash functions to find kernels.
 107  *
 108  * The electrostatics/vdw names should be obvious and correspond to the
 109  * forms of the interactions calculated in this function, and the interaction
 110  * modifiers describe switch/shift and similar alterations. Geometry refers
 111  * to whether this kernel calculates interactions between single particles or
 112  * waters (groups of 3/4 atoms) for better performance. Finally, the VF string
 113  * selects whether the kernel calculates only potential, only force, or both
 114  *
 115  * The allowed values for kernel interactions are described by the
 116  * enumerated types gmx_nbkernel_elec and gmx_nbkernel_vdw (see types/enums.h).
 117  * Note that these are deliberately NOT identical to the interactions the
 118  * user can set, since some user-specified interactions will be tabulated, and
 119  * Lennard-Jones and Buckingham use different kernels while their setting in
 120  * the input is decided by nonbonded parameter formats rather than mdp options.
 121  *
 122  * The interaction modifiers are described by the eintmod enum type, while
 123  * the kernel geometry is decided from the neighborlist geometry, which is
 124  * described by the enum gmx_nblist_kernel_geometry (again, see types/enums.h).
 125  * The
 126  *
 127  * Note that any particular implementation of kernels might not support all of
 128  * these strings. In fact, some might not be supported by any architecture yet.
 129  * The whole point of using strings and hashes is that we do not have to define a
 130  * unique set of strings in a single place. Thus, as long as you implement a
 131  * corresponding kernel, you could in theory provide any string you want.
 132  */
 133 typedef struct nb_kernel_info
 134 {
 135     nb_kernel_t *   kernelptr;
 136     const char *    kernelname;
 137     const char *    architecture;     /* e.g. "C", "SSE", "AVX_256", etc. */
 138
 139     const char *    electrostatics;
 140     const char *    electrostatics_modifier;
 141     const char *    vdw;
 142     const char *    vdw_modifier;
 143     const char *    geometry;
 144     const char *    other;  /* Any extra info you want/need to select a kernel */
 145     const char *    vf;     /* "PotentialAndForce", "Potential", or "Force" */
 146 }
 147 nb_kernel_info_t;
 148
 149
 150 void
 151 nb_kernel_list_add_kernels(nb_kernel_info_t *   new_kernelinfo,
 152                            int                  new_size);
 153
 154 int
 155 nb_kernel_list_hash_init(void);
 156
 157 /* Return a function pointer to the nonbonded kernel pointer with
 158  * settings according to the text strings provided. GROMACS does not guarantee
 159  * the existence of accelerated kernels for any combination, so the return value
 160  * can be NULL.
 161  * In that case, you can try a different/lower-level acceleration, and
 162  * eventually you need to prepare to fall back to generic kernels or change
 163  * your settings and try again.
 164  *
 165  * The names of the text strings are obviously meant to reflect settings in
 166  * GROMACS, but inside this routine they are merely used as a set of text
 167  * strings not defined here. The routine will simply compare the arguments with
 168  * the contents of the corresponding strings in the nb_kernel_list_t structure.
 169  *
 170  * This function does not check whether the kernel in question can run on the
 171  * present architecture since that would require a slow cpuid call for every
 172  * single invocation.
 173  */
 174 nb_kernel_t *
 175 nb_kernel_list_findkernel(FILE *              log,
 176                           const char *        architecture,
 177                           const char *        electrostatics,
 178                           const char *        electrostatics_modifier,
 179                           const char *        vdw,
 180                           const char *        vdw_modifier,
 181                           const char *        geometry,
 182                           const char *        other,
 183                           const char *        vf);
 184
 185
 186
 187 #ifdef __cplusplus
 188 }
 189 #endif
 190
 191 #endif /* _nb_kernel_h_ */