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