src/gromacs/nbnxm/atomdata.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2016,2017,2018,2019, 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
  36 #ifndef GMX_NBNXN_ATOMDATA_H
  37 #define GMX_NBNXN_ATOMDATA_H
  38
  39 #include <cstdio>
  40
  41 #include "gromacs/math/vectypes.h"
  42 #include "gromacs/utility/basedefinitions.h"
  43 #include "gromacs/utility/real.h"
  44
  45 #include "locality.h"
  46
  47 namespace gmx
  48 {
  49 class MDLogger;
  50 }
  51
  52 struct nbnxn_atomdata_t;
  53 struct nbnxn_search;
  54 struct t_mdatoms;
  55 struct gmx_wallcycle;
  56
  57 /* Reallocate the nbnxn_atomdata_t for a size of n atoms */
  58 void nbnxn_atomdata_realloc(nbnxn_atomdata_t *nbat, int n);
  59
  60 /* Copy na rvec elements from x to xnb using nbatFormat, start dest a0,
  61  * and fills up to na_round with coordinates that are far away.
  62  */
  63 void copy_rvec_to_nbat_real(const int *a, int na, int na_round,
  64                             const rvec *x, int nbatFormat,
  65                             real *xnb, int a0);
  66
  67 enum {
  68     enbnxninitcombruleDETECT, enbnxninitcombruleGEOM, enbnxninitcombruleLB, enbnxninitcombruleNONE
  69 };
  70
  71 /* Initialize the non-bonded atom data structure.
  72  * The enum for nbatXFormat is in the file defining nbnxn_atomdata_t.
  73  * Copy the ntypes*ntypes*2 sized nbfp non-bonded parameter list
  74  * to the atom data structure.
  75  * enbnxninitcombrule sets what combination rule data gets stored in nbat.
  76  */
  77 void nbnxn_atomdata_init(const gmx::MDLogger &mdlog,
  78                          nbnxn_atomdata_t *nbat,
  79                          int nb_kernel_type,
  80                          int enbnxninitcombrule,
  81                          int ntype, const real *nbfp,
  82                          int n_energygroups,
  83                          int nout);
  84
  85 void nbnxn_atomdata_set(nbnxn_atomdata_t    *nbat,
  86                         const nbnxn_search  *nbs,
  87                         const t_mdatoms     *mdatoms,
  88                         const int           *atinfo);
  89
  90 /* Copy the shift vectors to nbat */
  91 void nbnxn_atomdata_copy_shiftvec(gmx_bool          dynamic_box,
  92                                   rvec             *shift_vec,
  93                                   nbnxn_atomdata_t *nbat);
  94
  95 /* Copy x to nbat->x.
  96  * FillLocal tells if the local filler particle coordinates should be zeroed.
  97  */
  98 void nbnxn_atomdata_copy_x_to_nbat_x(const nbnxn_search  *nbs,
  99                                      Nbnxm::AtomLocality  locality,
 100                                      gmx_bool             FillLocal,
 101                                      rvec                *x,
 102                                      nbnxn_atomdata_t    *nbat,
 103                                      gmx_wallcycle       *wcycle);
 104
 105 /* Add the forces stored in nbat to f, zeros the forces in nbat */
 106 void nbnxn_atomdata_add_nbat_f_to_f(nbnxn_search           *nbs,
 107                                     Nbnxm::AtomLocality     locality,
 108                                     nbnxn_atomdata_t       *nbat,
 109                                     rvec                   *f,
 110                                     gmx_wallcycle          *wcycle);
 111
 112 /* Add the fshift force stored in nbat to fshift */
 113 void nbnxn_atomdata_add_nbat_fshift_to_fshift(const nbnxn_atomdata_t *nbat,
 114                                               rvec                   *fshift);
 115
 116 #endif