src/gromacs/mdlib/nsgrid.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,2019,2021, 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 #ifndef GMX_MDLIB_NSGRID_H
  38 #define GMX_MDLIB_NSGRID_H
  39
  40 #include <cstdio>
  41
  42 #include "gromacs/math/vectypes.h"
  43 #include "gromacs/utility/real.h"
  44
  45 struct gmx_domdec_t;
  46 struct gmx_domdec_zones_t;
  47 struct gmx_ddbox_t;
  48 struct t_forcerec;
  49
  50 /*! \brief Used when estimating the interaction density.
  51  *
  52  * GRID_STDDEV_FAC * stddev estimates the interaction density. The
  53  * value sqrt(3) == 1.73205080757 gives a uniform load for a
  54  * rectangular 3D block of charge groups. For a sphere, it is not a
  55  * bad approximation for 4x1x1 up to 4x2x2.
  56  *
  57  * \todo It would be nicer to use sqrt(3) here, when all code that
  58  * includes this file is in C++, which will let us cope with the
  59  * std::sqrt<T> on Windows. */
  60 static const real GRID_STDDEV_FAC = 1.73205080757;
  61
  62 /*! \brief The extent of the neighborsearch grid is a bit larger than sqrt(3)
  63  * to account for less dense regions at the edges of the system.
  64  */
  65 static const real NSGRID_STDDEV_FAC = 2.0;
  66
  67 #define NSGRID_SIGNAL_MOVED_FAC 4
  68 /* A cell index of NSGRID_SIGNAL_MOVED_FAC*ncells signals
  69  * that a charge group moved to another DD domain.
  70  */
  71
  72 void get_nsgrid_boundaries(int                  nboundeddim,
  73                            matrix               box,
  74                            struct gmx_domdec_t* dd,
  75                            gmx_ddbox_t*         ddbox,
  76                            gmx::RVec*           gr0,
  77                            gmx::RVec*           gr1,
  78                            int                  ncg,
  79                            rvec*                cgcm,
  80                            rvec                 grid_x0,
  81                            rvec                 grid_x1,
  82                            real*                grid_density);
  83 /* Return the ns grid boundaries grid_x0 and grid_x1
  84  * and the estimate for the grid density.
  85  * For non-bounded dimensions the boundaries are determined
  86  * from the average and std.dev. of cgcm.
  87  * The are determined from box, unless gr0!=NULL or gr1!=NULL,
  88  * then they are taken from gr0 or gr1.
  89  * With dd and unbounded dimensions, the proper grid borders for cells
  90  * on the edges are determined from cgcm.
  91  */
  92
  93 #endif