include/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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #include "visibility.h"
  39 #include "typedefs.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 #define   GRID_STDDEV_FAC  sqrt(3)
  46 #define NSGRID_STDDEV_FAC  2.0
  47 /*
  48  * GRID_STDDEV_FAC * stddev is used to estimate the interaction density.
  49  * sqrt(3) gives a uniform load for a rectangular block of cg's.
  50  * For a sphere it is not a bad approximation for 4x1x1 up to 4x2x2.
  51  *
  52  * The extent of the neighborsearch grid is a bit larger than sqrt(3)
  53  * to account for less dense regions at the edges of the system.
  54  */
  55
  56 #define NSGRID_SIGNAL_MOVED_FAC  4
  57 /* A cell index of NSGRID_SIGNAL_MOVED_FAC*ncells signals
  58  * that a charge group moved to another DD domain.
  59  */
  60
  61 GMX_LIBMD_EXPORT
  62 t_grid *init_grid(FILE *fplog, t_forcerec *fr);
  63
  64 void done_grid(t_grid *grid);
  65
  66 void get_nsgrid_boundaries(int nboundeddim, matrix box,
  67                            gmx_domdec_t *dd,
  68                            gmx_ddbox_t *ddbox,
  69                            rvec *gr0, rvec *gr1,
  70                            int ncg, rvec *cgcm,
  71                            rvec grid_x0, rvec grid_x1,
  72                            real *grid_density);
  73 /* Return the ns grid boundaries grid_x0 and grid_x1
  74  * and the estimate for the grid density.
  75  * For non-bounded dimensions the boundaries are determined
  76  * from the average and std.dev. of cgcm.
  77  * The are determined from box, unless gr0!=NULL or gr1!=NULL,
  78  * then they are taken from gr0 or gr1.
  79  * With dd and unbounded dimensions, the proper grid borders for cells
  80  * on the edges are determined from cgcm.
  81  */
  82
  83 void grid_first(FILE *log, t_grid *grid,
  84                 gmx_domdec_t *dd, const gmx_ddbox_t *ddbox,
  85                 int ePBC, matrix box, rvec izones_x0, rvec izones_x1,
  86                 real rlong, real grid_density);
  87
  88 void fill_grid(FILE *log,
  89                gmx_domdec_zones_t *dd_zones,
  90                t_grid *grid, int ncg_tot,
  91                int cg0, int cg1, rvec cg_cm[]);
  92 /* Allocates space on the grid for ncg_tot cg's.
  93  * Fills the grid with cg's from cg0 to cg1.
  94  * When cg0 is -1, contiues filling from grid->nr to cg1.
  95  */
  96
  97 void calc_elemnr(FILE *log, t_grid *grid, int cg0, int cg1, int ncg);
  98
  99 void calc_ptrs(t_grid *grid);
 100
 101 void grid_last(FILE *log, t_grid *grid, int cg0, int cg1, int ncg);
 102
 103 int xyz2ci_(int nry, int nrz, int x, int y, int z);
 104 #define xyz2ci(nry, nrz, x, y, z) ((nry)*(nrz)*(x)+(nrz)*(y)+(z))
 105 /* Return the cell index */
 106
 107 void ci2xyz(t_grid *grid, int i, int *x, int *y, int *z);
 108
 109 void check_grid(FILE *log, t_grid *grid);
 110
 111 void print_grid(FILE *log, t_grid *grid);
 112
 113 void mv_grid(t_commrec *cr, t_grid *grid);
 114 /* Move the grid over processors */
 115
 116 #ifdef __cplusplus
 117 }
 118 #endif