src/gromacs/legacyheaders/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, 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
  38 #include "gromacs/legacyheaders/typedefs.h"
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 /*! \brief Used when estimating the interaction density.
  45  *
  46  * GRID_STDDEV_FAC * stddev estimates the interaction density. The
  47  * value sqrt(3) == 1.73205080757 gives a uniform load for a
  48  * rectangular 3D block of charge groups. For a sphere, it is not a
  49  * bad approximation for 4x1x1 up to 4x2x2.
  50  *
  51  * \todo It would be nicer to use sqrt(3) here, when all code that
  52  * #includes this file is in C++, which will let us cope with the
  53  * std::sqrt<T> on Windows. */
  54 static const real GRID_STDDEV_FAC = 1.73205080757;
  55
  56 /*! \brief The extent of the neighborsearch grid is a bit larger than sqrt(3)
  57  * to account for less dense regions at the edges of the system.
  58  */
  59 static const real NSGRID_STDDEV_FAC = 2.0;
  60
  61 #define NSGRID_SIGNAL_MOVED_FAC  4
  62 /* A cell index of NSGRID_SIGNAL_MOVED_FAC*ncells signals
  63  * that a charge group moved to another DD domain.
  64  */
  65
  66 t_grid *init_grid(FILE *fplog, t_forcerec *fr);
  67
  68 void done_grid(t_grid *grid);
  69
  70 void get_nsgrid_boundaries(int nboundeddim, matrix box,
  71                            gmx_domdec_t *dd,
  72                            gmx_ddbox_t *ddbox,
  73                            rvec *gr0, rvec *gr1,
  74                            int ncg, rvec *cgcm,
  75                            rvec grid_x0, rvec grid_x1,
  76                            real *grid_density);
  77 /* Return the ns grid boundaries grid_x0 and grid_x1
  78  * and the estimate for the grid density.
  79  * For non-bounded dimensions the boundaries are determined
  80  * from the average and std.dev. of cgcm.
  81  * The are determined from box, unless gr0!=NULL or gr1!=NULL,
  82  * then they are taken from gr0 or gr1.
  83  * With dd and unbounded dimensions, the proper grid borders for cells
  84  * on the edges are determined from cgcm.
  85  */
  86
  87 void grid_first(FILE *log, t_grid *grid,
  88                 gmx_domdec_t *dd, const gmx_ddbox_t *ddbox, matrix box, rvec izones_x0, rvec izones_x1,
  89                 real rlong, real grid_density);
  90
  91 void fill_grid(gmx_domdec_zones_t *dd_zones,
  92                t_grid *grid, int ncg_tot,
  93                int cg0, int cg1, rvec cg_cm[]);
  94 /* Allocates space on the grid for ncg_tot cg's.
  95  * Fills the grid with cg's from cg0 to cg1.
  96  * When cg0 is -1, contiues filling from grid->nr to cg1.
  97  */
  98
  99 void calc_elemnr(t_grid *grid, int cg0, int cg1, int ncg);
 100
 101 void calc_ptrs(t_grid *grid);
 102
 103 void grid_last(t_grid *grid, int cg0, int cg1, int ncg);
 104
 105 int xyz2ci_(int nry, int nrz, int x, int y, int z);
 106 #define xyz2ci(nry, nrz, x, y, z) ((nry)*(nrz)*(x)+(nrz)*(y)+(z))
 107 /* Return the cell index */
 108
 109 void ci2xyz(t_grid *grid, int i, int *x, int *y, int *z);
 110
 111 void check_grid(t_grid *grid);
 112
 113 void print_grid(FILE *log, t_grid *grid);
 114
 115 #ifdef __cplusplus
 116 }
 117 #endif