Tidy: modernize-use-nullptr
[alexxy/gromacs.git] / src / gromacs / mdlib / nsgrid.cpp
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,2017, 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 /* This file is completely threadsafe - keep it that way! */
38 #include "gmxpre.h"
39
40 #include "nsgrid.h"
41
42 #include <stdio.h>
43 #include <stdlib.h>
44
45 #include <cmath>
46
47 #include <algorithm>
48
49 #include "gromacs/domdec/domdec.h"
50 #include "gromacs/domdec/domdec_struct.h"
51 #include "gromacs/fileio/pdbio.h"
52 #include "gromacs/gmxlib/network.h"
53 #include "gromacs/math/vec.h"
54 #include "gromacs/pbcutil/pbc.h"
55 #include "gromacs/utility/fatalerror.h"
56 #include "gromacs/utility/futil.h"
57 #include "gromacs/utility/smalloc.h"
58
59 /***********************************
60  *         Grid Routines
61  ***********************************/
62
63 const char *range_warn =
64     "Explanation: During neighborsearching, we assign each particle to a grid\n"
65     "based on its coordinates. If your system contains collisions or parameter\n"
66     "errors that give particles very high velocities you might end up with some\n"
67     "coordinates being +-Infinity or NaN (not-a-number). Obviously, we cannot\n"
68     "put these on a grid, so this is usually where we detect those errors.\n"
69     "Make sure your system is properly energy-minimized and that the potential\n"
70     "energy seems reasonable before trying again.";
71
72 static void calc_x_av_stddev(int n, rvec *x, rvec av, rvec stddev)
73 {
74     dvec s1, s2;
75     int  i, d;
76
77     clear_dvec(s1);
78     clear_dvec(s2);
79
80     for (i = 0; i < n; i++)
81     {
82         for (d = 0; d < DIM; d++)
83         {
84             s1[d] += x[i][d];
85             s2[d] += x[i][d]*x[i][d];
86         }
87     }
88
89     dsvmul(1.0/n, s1, s1);
90     dsvmul(1.0/n, s2, s2);
91
92     for (d = 0; d < DIM; d++)
93     {
94         av[d]     = s1[d];
95         stddev[d] = std::sqrt(s2[d] - s1[d]*s1[d]);
96     }
97 }
98
99 void get_nsgrid_boundaries_vac(real av, real stddev,
100                                real *bound0, real *bound1,
101                                real *bdens0, real *bdens1)
102 {
103     /* Set the grid to 2 times the standard deviation of
104      * the charge group centers in both directions.
105      * For a uniform bounded distribution the width is sqrt(3)*stddev,
106      * so all charge groups fall within the width.
107      * For a sphere stddev is r/sqrt(5): 99.2% falls within the width.
108      * For a Gaussian distribution 98% fall within the width.
109      */
110     *bound0 = av - NSGRID_STDDEV_FAC*stddev;
111     *bound1 = av + NSGRID_STDDEV_FAC*stddev;
112
113     *bdens0 = av - GRID_STDDEV_FAC*stddev;
114     *bdens1 = av + GRID_STDDEV_FAC*stddev;
115 }
116
117 static void dd_box_bounds_to_ns_bounds(real box0, real box_size,
118                                        real *gr0, real *gr1)
119 {
120     real av, stddev;
121
122     /* Redetermine av and stddev from the DD box boundaries */
123     av     = box0 + 0.5*box_size;
124     stddev = 0.5*box_size/GRID_STDDEV_FAC;
125
126     *gr0 = av - NSGRID_STDDEV_FAC*stddev;
127     *gr1 = av + NSGRID_STDDEV_FAC*stddev;
128 }
129
130 void get_nsgrid_boundaries(int nboundeddim, matrix box,
131                            gmx_domdec_t *dd,
132                            gmx_ddbox_t *ddbox, rvec *gr0, rvec *gr1,
133                            int ncg, rvec *cgcm,
134                            rvec grid_x0, rvec grid_x1,
135                            real *grid_density)
136 {
137     rvec av, stddev;
138     real vol, bdens0, bdens1;
139     int  d;
140
141     if (nboundeddim < DIM)
142     {
143         calc_x_av_stddev(ncg, cgcm, av, stddev);
144     }
145
146     vol = 1;
147     for (d = 0; d < DIM; d++)
148     {
149         if (d < nboundeddim)
150         {
151             grid_x0[d] = (gr0 != nullptr ? (*gr0)[d] : 0);
152             grid_x1[d] = (gr1 != nullptr ? (*gr1)[d] : box[d][d]);
153             vol       *= (grid_x1[d] - grid_x0[d]);
154         }
155         else
156         {
157             if (ddbox == nullptr)
158             {
159                 get_nsgrid_boundaries_vac(av[d], stddev[d],
160                                           &grid_x0[d], &grid_x1[d],
161                                           &bdens0, &bdens1);
162             }
163             else
164             {
165                 /* Temporary fix which uses global ddbox boundaries
166                  * for unbounded dimensions.
167                  * Should be replaced by local boundaries, which makes
168                  * the ns grid smaller and does not require global comm.
169                  */
170                 dd_box_bounds_to_ns_bounds(ddbox->box0[d], ddbox->box_size[d],
171                                            &grid_x0[d], &grid_x1[d]);
172                 bdens0 = grid_x0[d];
173                 bdens1 = grid_x1[d];
174             }
175             /* Check for a DD cell not at a lower edge */
176             if (dd != nullptr && gr0 != nullptr && dd->ci[d] > 0)
177             {
178                 grid_x0[d] = (*gr0)[d];
179                 bdens0     = (*gr0)[d];
180             }
181             /* Check for a DD cell not at a higher edge */
182             if (dd != nullptr && gr1 != nullptr && dd->ci[d] < dd->nc[d]-1)
183             {
184                 grid_x1[d] = (*gr1)[d];
185                 bdens1     = (*gr1)[d];
186             }
187             vol *= (bdens1 - bdens0);
188         }
189
190         if (debug)
191         {
192             fprintf(debug, "Set grid boundaries dim %d: %f %f\n",
193                     d, grid_x0[d], grid_x1[d]);
194         }
195     }
196
197     *grid_density = ncg/vol;
198 }
199
200 static void set_grid_sizes(matrix box, rvec izones_x0, rvec izones_x1, real rlist,
201                            const gmx_domdec_t *dd, const gmx_ddbox_t *ddbox,
202                            t_grid *grid,
203                            real grid_density)
204 {
205     int      i, j;
206     gmx_bool bDD, bDDRect;
207     rvec     izones_size;
208     real     inv_r_ideal, size, add_tric, radd;
209
210     for (i = 0; (i < DIM); i++)
211     {
212         if (debug)
213         {
214             fprintf(debug,
215                     "set_grid_sizes, i-zone bounds for dim %d: %6.3f %6.3f\n",
216                     i, izones_x0[i], izones_x1[i]);
217         }
218         izones_size[i] = izones_x1[i] - izones_x0[i];
219     }
220
221     /* Use the ideal number of cg's per cell to set the ideal cell size */
222     inv_r_ideal = std::cbrt(grid_density/grid->ncg_ideal);
223     if (rlist > 0 && inv_r_ideal*rlist < 1)
224     {
225         inv_r_ideal = 1/rlist;
226     }
227     if (debug)
228     {
229         fprintf(debug, "CG density %f ideal ns cell size %f\n",
230                 grid_density, 1/inv_r_ideal);
231     }
232
233     clear_rvec(grid->cell_offset);
234     for (i = 0; (i < DIM); i++)
235     {
236         /* Initial settings, for DD might change below */
237         grid->cell_offset[i] = izones_x0[i];
238         size                 = izones_size[i];
239
240         bDD = dd && (dd->nc[i] > 1);
241         if (!bDD)
242         {
243             bDDRect = FALSE;
244         }
245         else
246         {
247             /* With DD grid cell jumps only the first decomposition
248              * direction has uniform DD cell boundaries.
249              */
250             bDDRect = !(ddbox->tric_dir[i] ||
251                         (dd_dlb_is_on(dd) && i != dd->dim[0]));
252
253             radd = rlist;
254             if (i >= ddbox->npbcdim &&
255                 (rlist == 0 ||
256                  izones_x1[i] + radd > ddbox->box0[i] + ddbox->box_size[i]))
257             {
258                 radd = ddbox->box0[i] + ddbox->box_size[i] - izones_x1[i];
259                 if (radd < 0)
260                 {
261                     radd = 0;
262                 }
263             }
264
265             /* With DD we only need a grid of one DD cell size + rlist */
266             if (bDDRect)
267             {
268                 size += radd;
269             }
270             else
271             {
272                 size += radd/ddbox->skew_fac[i];
273             }
274
275             /* Check if the cell boundary in this direction is
276              * perpendicular to the Cartesian axis.
277              * Since grid->npbcdim isan integer that in principle can take
278              * any value, we help the compiler avoid warnings and potentially
279              * optimize by ensuring that j < DIM here.
280              */
281             for (j = i+1; j < grid->npbcdim && j < DIM; j++)
282             {
283                 if (box[j][i] != 0)
284                 {
285                     /* Correct the offset for the home cell location */
286                     grid->cell_offset[i] += izones_x0[j]*box[j][i]/box[j][j];
287
288                     /* Correct the offset and size for the off-diagonal
289                      * displacement of opposing DD cell corners.
290                      */
291                     /* Without rouding we would need to add:
292                      * box[j][i]*rlist/(dd->skew_fac[i]*box[j][j])
293                      */
294                     /* Determine the shift for the corners of the triclinic box */
295                     add_tric = izones_size[j]*box[j][i]/box[j][j];
296                     if (dd->ndim == 1 && j == ZZ)
297                     {
298                         /* With 1D domain decomposition the cg's are not in
299                          * the triclinic box, but trilinic x-y and rectangular y-z.
300                          * Therefore we need to add the shift from the trilinic
301                          * corner to the corner at y=0.
302                          */
303                         add_tric += -box[YY][XX]*box[ZZ][YY]/box[YY][YY];
304                     }
305                     if (box[j][i] < 0)
306                     {
307                         grid->cell_offset[i] += add_tric;
308                         size                 -= add_tric;
309                     }
310                     else
311                     {
312                         size += add_tric;
313                     }
314                 }
315             }
316         }
317         if (!bDDRect)
318         {
319             /* No DD or the box is triclinic is this direction:
320              * we will use the normal grid ns that checks all cells
321              * that are within cut-off distance of the i-particle.
322              */
323             grid->n[i] = (int)(size*inv_r_ideal + 0.5);
324             if (grid->n[i] < 2)
325             {
326                 grid->n[i] = 2;
327             }
328             grid->cell_size[i] = size/grid->n[i];
329             grid->ncpddc[i]    = 0;
330         }
331         else
332         {
333             /* We use grid->ncpddc[i] such that all particles
334              * in one ns cell belong to a single DD cell only.
335              * We can then beforehand exclude certain ns grid cells
336              * for non-home i-particles.
337              */
338             grid->ncpddc[i] = (int)(izones_size[i]*inv_r_ideal + 0.5);
339             if (grid->ncpddc[i] < 2)
340             {
341                 grid->ncpddc[i] = 2;
342             }
343             grid->cell_size[i] = izones_size[i]/grid->ncpddc[i];
344             grid->n[i]         = grid->ncpddc[i] + (int)(radd/grid->cell_size[i]) + 1;
345         }
346         if (debug)
347         {
348             fprintf(debug, "grid dim %d size %d x %f: %f - %f\n",
349                     i, grid->n[i], grid->cell_size[i],
350                     grid->cell_offset[i],
351                     grid->cell_offset[i]+grid->n[i]*grid->cell_size[i]);
352         }
353     }
354
355     if (debug)
356     {
357         fprintf(debug, "CG ncg ideal %d, actual density %.1f\n",
358                 grid->ncg_ideal, grid_density*grid->cell_size[XX]*grid->cell_size[YY]*grid->cell_size[ZZ]);
359     }
360 }
361
362 t_grid *init_grid(FILE *fplog, t_forcerec *fr)
363 {
364     char   *ptr;
365     t_grid *grid;
366
367     snew(grid, 1);
368
369     grid->npbcdim = ePBC2npbcdim(fr->ePBC);
370
371     if (fr->ePBC == epbcXY && fr->nwall == 2)
372     {
373         grid->nboundeddim = 3;
374     }
375     else
376     {
377         grid->nboundeddim = grid->npbcdim;
378     }
379
380     if (debug)
381     {
382         fprintf(debug, "The coordinates are bounded in %d dimensions\n",
383                 grid->nboundeddim);
384     }
385
386     /* The ideal number of cg's per ns grid cell seems to be 10 */
387     grid->ncg_ideal = 10;
388     ptr             = getenv("GMX_NSCELL_NCG");
389     if (ptr)
390     {
391         sscanf(ptr, "%d", &grid->ncg_ideal);
392         if (fplog)
393         {
394             fprintf(fplog, "Set ncg_ideal to %d\n", grid->ncg_ideal);
395         }
396         if (grid->ncg_ideal <= 0)
397         {
398             gmx_fatal(FARGS, "The number of cg's per cell should be > 0");
399         }
400     }
401     if (debug)
402     {
403         fprintf(debug, "Set ncg_ideal to %d\n", grid->ncg_ideal);
404     }
405
406     return grid;
407 }
408
409 void done_grid(t_grid *grid)
410 {
411     grid->nr      = 0;
412     clear_ivec(grid->n);
413     grid->ncells  = 0;
414     sfree(grid->cell_index);
415     sfree(grid->a);
416     sfree(grid->index);
417     sfree(grid->nra);
418     grid->cells_nalloc = 0;
419     sfree(grid->dcx2);
420     sfree(grid->dcy2);
421     sfree(grid->dcz2);
422     grid->dc_nalloc = 0;
423
424     if (debug)
425     {
426         fprintf(debug, "Successfully freed memory for grid pointers.");
427     }
428 }
429
430 int xyz2ci_(int nry, int nrz, int x, int y, int z)
431 /* Return the cell index */
432 {
433     return (nry*nrz*x+nrz*y+z);
434 }
435
436 void ci2xyz(t_grid *grid, int i, int *x, int *y, int *z)
437 /* Return x,y and z from the cell index */
438 {
439     int ci;
440
441     range_check_mesg(i, 0, grid->nr, range_warn);
442
443     ci  = grid->cell_index[i];
444     *x  = ci / (grid->n[YY]*grid->n[ZZ]);
445     ci -= (*x)*grid->n[YY]*grid->n[ZZ];
446     *y  = ci / grid->n[ZZ];
447     ci -= (*y)*grid->n[ZZ];
448     *z  = ci;
449 }
450
451 static int ci_not_used(ivec n)
452 {
453     /* Return an improbable value */
454     return xyz2ci(n[YY], n[ZZ], 3*n[XX], 3*n[YY], 3*n[ZZ]);
455 }
456
457 static void set_grid_ncg(t_grid *grid, int ncg)
458 {
459     int nr_old, i;
460
461     grid->nr = ncg;
462     if (grid->nr+1 > grid->nr_alloc)
463     {
464         nr_old         = grid->nr_alloc;
465         grid->nr_alloc = over_alloc_dd(grid->nr) + 1;
466         srenew(grid->cell_index, grid->nr_alloc);
467         for (i = nr_old; i < grid->nr_alloc; i++)
468         {
469             grid->cell_index[i] = 0;
470         }
471         srenew(grid->a, grid->nr_alloc);
472     }
473 }
474
475 void grid_first(FILE *fplog, t_grid *grid,
476                 gmx_domdec_t *dd, const gmx_ddbox_t *ddbox,
477                 matrix box, rvec izones_x0, rvec izones_x1,
478                 real rlist, real grid_density)
479 {
480     int    i, m;
481
482     set_grid_sizes(box, izones_x0, izones_x1, rlist, dd, ddbox, grid, grid_density);
483
484     grid->ncells = grid->n[XX]*grid->n[YY]*grid->n[ZZ];
485
486     if (grid->ncells+1 > grid->cells_nalloc)
487     {
488         /* Allocate double the size so we have some headroom */
489         grid->cells_nalloc = 2*grid->ncells;
490         srenew(grid->nra,  grid->cells_nalloc+1);
491         srenew(grid->index, grid->cells_nalloc+1);
492
493         if (fplog)
494         {
495             fprintf(fplog, "Grid: %d x %d x %d cells\n",
496                     grid->n[XX], grid->n[YY], grid->n[ZZ]);
497         }
498     }
499
500     m = std::max(grid->n[XX], std::max(grid->n[YY], grid->n[ZZ]));
501     if (m > grid->dc_nalloc)
502     {
503         /* Allocate with double the initial size for box scaling */
504         grid->dc_nalloc = 2*m;
505         srenew(grid->dcx2, grid->dc_nalloc);
506         srenew(grid->dcy2, grid->dc_nalloc);
507         srenew(grid->dcz2, grid->dc_nalloc);
508     }
509
510     grid->nr = 0;
511     for (i = 0; (i < grid->ncells); i++)
512     {
513         grid->nra[i] = 0;
514     }
515 }
516
517 static void calc_bor(int cg0, int cg1, int ncg, int CG0[2], int CG1[2])
518 {
519     if (cg1 > ncg)
520     {
521         CG0[0] = cg0;
522         CG1[0] = ncg;
523         CG0[1] = 0;
524         CG1[1] = cg1-ncg;
525     }
526     else
527     {
528         CG0[0] = cg0;
529         CG1[0] = cg1;
530         CG0[1] = 0;
531         CG1[1] = 0;
532     }
533     if (debug)
534     {
535         int m;
536
537         fprintf(debug, "calc_bor: cg0=%d, cg1=%d, ncg=%d\n", cg0, cg1, ncg);
538         for (m = 0; (m < 2); m++)
539         {
540             fprintf(debug, "CG0[%d]=%d, CG1[%d]=%d\n", m, CG0[m], m, CG1[m]);
541         }
542     }
543
544 }
545
546 void calc_elemnr(t_grid *grid, int cg0, int cg1, int ncg)
547 {
548     int     CG0[2], CG1[2];
549     int    *cell_index = grid->cell_index;
550     int    *nra        = grid->nra;
551     int     i, m, ncells;
552     int     ci, not_used;
553
554     ncells = grid->ncells;
555     if (ncells <= 0)
556     {
557         gmx_fatal(FARGS, "Number of grid cells is zero. Probably the system and box collapsed.\n");
558     }
559
560     not_used = ci_not_used(grid->n);
561
562     calc_bor(cg0, cg1, ncg, CG0, CG1);
563     for (m = 0; (m < 2); m++)
564     {
565         for (i = CG0[m]; (i < CG1[m]); i++)
566         {
567             ci = cell_index[i];
568             if (ci != not_used)
569             {
570                 range_check_mesg(ci, 0, ncells, range_warn);
571                 nra[ci]++;
572             }
573         }
574     }
575 }
576
577 void calc_ptrs(t_grid *grid)
578 {
579     int *index = grid->index;
580     int *nra   = grid->nra;
581     int  ix, iy, iz, ci, nr;
582     int  nnra, ncells;
583
584     ncells = grid->ncells;
585     if (ncells <= 0)
586     {
587         gmx_fatal(FARGS, "Number of grid cells is zero. Probably the system and box collapsed.\n");
588     }
589
590     ci = nr = 0;
591     for (ix = 0; (ix < grid->n[XX]); ix++)
592     {
593         for (iy = 0; (iy < grid->n[YY]); iy++)
594         {
595             for (iz = 0; (iz < grid->n[ZZ]); iz++, ci++)
596             {
597                 range_check_mesg(ci, 0, ncells, range_warn);
598                 index[ci] = nr;
599                 nnra      = nra[ci];
600                 nr       += nnra;
601                 nra[ci]   = 0;
602             }
603         }
604     }
605 }
606
607 void grid_last(t_grid *grid, int cg0, int cg1, int ncg)
608 {
609     int     CG0[2], CG1[2];
610     int     i, m;
611     int     ci, not_used, ind, ncells;
612     int    *cell_index = grid->cell_index;
613     int    *nra        = grid->nra;
614     int    *index      = grid->index;
615     int    *a          = grid->a;
616
617     ncells = grid->ncells;
618     if (ncells <= 0)
619     {
620         gmx_fatal(FARGS, "Number of grid cells is zero. Probably the system and box collapsed.\n");
621     }
622
623     not_used = ci_not_used(grid->n);
624
625     calc_bor(cg0, cg1, ncg, CG0, CG1);
626     for (m = 0; (m < 2); m++)
627     {
628         for (i = CG0[m]; (i < CG1[m]); i++)
629         {
630             ci     = cell_index[i];
631             if (ci != not_used)
632             {
633                 range_check_mesg(ci, 0, ncells, range_warn);
634                 ind    = index[ci]+nra[ci]++;
635                 range_check_mesg(ind, 0, grid->nr, range_warn);
636                 a[ind] = i;
637             }
638         }
639     }
640 }
641
642 void fill_grid(gmx_domdec_zones_t *dd_zones,
643                t_grid *grid, int ncg_tot,
644                int cg0, int cg1, rvec cg_cm[])
645 {
646     int       *cell_index;
647     int        nry, nrz;
648     rvec       n_box, offset;
649     int        zone, ccg0, ccg1, cg, d, not_used;
650     ivec       shift0, useall, b0, b1, ind;
651     gmx_bool   bUse;
652
653     if (cg0 == -1)
654     {
655         /* We have already filled the grid up to grid->ncg,
656          * continue from there.
657          */
658         cg0 = grid->nr;
659     }
660
661     set_grid_ncg(grid, ncg_tot);
662
663     cell_index = grid->cell_index;
664
665     /* Initiate cell borders */
666     nry = grid->n[YY];
667     nrz = grid->n[ZZ];
668     for (d = 0; d < DIM; d++)
669     {
670         if (grid->cell_size[d] > 0)
671         {
672             n_box[d] = 1/grid->cell_size[d];
673         }
674         else
675         {
676             n_box[d] = 0;
677         }
678     }
679     copy_rvec(grid->cell_offset, offset);
680
681     if (debug)
682     {
683         fprintf(debug, "Filling grid from %d to %d\n", cg0, cg1);
684     }
685
686     if (dd_zones == nullptr)
687     {
688         for (cg = cg0; cg < cg1; cg++)
689         {
690             for (d = 0; d < DIM; d++)
691             {
692                 ind[d] = static_cast<int>((cg_cm[cg][d] - offset[d])*n_box[d]);
693                 /* With pbc we should be done here.
694                  * Without pbc cg's outside the grid
695                  * should be assigned to the closest grid cell.
696                  */
697                 if (ind[d] < 0)
698                 {
699                     ind[d] = 0;
700                 }
701                 else if (ind[d] >= grid->n[d])
702                 {
703                     ind[d] = grid->n[d] - 1;
704                 }
705             }
706             cell_index[cg] = xyz2ci(nry, nrz, ind[XX], ind[YY], ind[ZZ]);
707         }
708     }
709     else
710     {
711         for (zone = 0; zone < dd_zones->n; zone++)
712         {
713             ccg0 = dd_zones->cg_range[zone];
714             ccg1 = dd_zones->cg_range[zone+1];
715             if (ccg1 <= cg0 || ccg0 >= cg1)
716             {
717                 continue;
718             }
719
720             /* Determine the ns grid cell limits for this DD zone */
721             for (d = 0; d < DIM; d++)
722             {
723                 shift0[d] = dd_zones->shift[zone][d];
724                 useall[d] = (shift0[d] == 0 || d >= grid->npbcdim);
725                 /* Check if we need to do normal or optimized grid assignments.
726                  * Normal is required for dims without DD or triclinic dims.
727                  * DD edge cell on dims without pbc will be automatically
728                  * be correct, since the shift=0 zones with have b0 and b1
729                  * set to the grid boundaries and there are no shift=1 zones.
730                  */
731                 if (grid->ncpddc[d] == 0)
732                 {
733                     b0[d] = 0;
734                     b1[d] = grid->n[d];
735                 }
736                 else
737                 {
738                     if (shift0[d] == 0)
739                     {
740                         b0[d] = 0;
741                         b1[d] = grid->ncpddc[d];
742                     }
743                     else
744                     {
745                         /* shift = 1 */
746                         b0[d] = grid->ncpddc[d];
747                         b1[d] = grid->n[d];
748                     }
749                 }
750             }
751
752             not_used = ci_not_used(grid->n);
753
754             /* Put all the charge groups of this DD zone on the grid */
755             for (cg = ccg0; cg < ccg1; cg++)
756             {
757                 if (cell_index[cg] == -1)
758                 {
759                     /* This cg has moved to another node */
760                     cell_index[cg] = NSGRID_SIGNAL_MOVED_FAC*grid->ncells;
761                     continue;
762                 }
763
764                 bUse = TRUE;
765                 for (d = 0; d < DIM; d++)
766                 {
767                     ind[d] = static_cast<int>((cg_cm[cg][d] - offset[d])*n_box[d]);
768                     /* Here we have to correct for rounding problems,
769                      * as this cg_cm to cell index operation is not necessarily
770                      * binary identical to the operation for the DD zone assignment
771                      * and therefore a cg could end up in an unused grid cell.
772                      * For dimensions without pbc we need to check
773                      * for cells on the edge if charge groups are beyond
774                      * the grid and if so, store them in the closest cell.
775                      */
776                     if (ind[d] < b0[d])
777                     {
778                         ind[d] = b0[d];
779                     }
780                     else if (ind[d] >= b1[d])
781                     {
782                         if (useall[d])
783                         {
784                             ind[d] = b1[d] - 1;
785                         }
786                         else
787                         {
788                             /* Charge groups in this DD zone further away than the cut-off
789                              * in direction do not participate in non-bonded interactions.
790                              */
791                             bUse = FALSE;
792                         }
793                     }
794                 }
795                 if (cg > grid->nr_alloc)
796                 {
797                     fprintf(stderr, "WARNING: nra_alloc %d cg0 %d cg1 %d cg %d\n",
798                             grid->nr_alloc, cg0, cg1, cg);
799                 }
800                 if (bUse)
801                 {
802                     cell_index[cg] = xyz2ci(nry, nrz, ind[XX], ind[YY], ind[ZZ]);
803                 }
804                 else
805                 {
806                     cell_index[cg] = not_used;
807                 }
808             }
809         }
810     }
811
812 }
813
814 void check_grid(t_grid *grid)
815 {
816     int ix, iy, iz, ci, cci, nra;
817
818     if (grid->ncells <= 0)
819     {
820         gmx_fatal(FARGS, "Number of grid cells is zero. Probably the system and box collapsed.\n");
821     }
822
823     ci  = 0;
824     cci = 0;
825     for (ix = 0; (ix < grid->n[XX]); ix++)
826     {
827         for (iy = 0; (iy < grid->n[YY]); iy++)
828         {
829             for (iz = 0; (iz < grid->n[ZZ]); iz++, ci++)
830             {
831                 if (ci > 0)
832                 {
833                     nra = grid->index[ci]-grid->index[cci];
834                     if (nra != grid->nra[cci])
835                     {
836                         gmx_fatal(FARGS, "nra=%d, grid->nra=%d, cci=%d",
837                                   nra, grid->nra[cci], cci);
838                     }
839                 }
840                 cci = xyz2ci(grid->n[YY], grid->n[ZZ], ix, iy, iz);
841                 range_check_mesg(cci, 0, grid->ncells, range_warn);
842
843                 if (cci != ci)
844                 {
845                     gmx_fatal(FARGS, "ci = %d, cci = %d", ci, cci);
846                 }
847             }
848         }
849     }
850 }
851
852 void print_grid(FILE *log, t_grid *grid)
853 {
854     int i, nra, index;
855     int ix, iy, iz, ci;
856
857     fprintf(log, "nr:        %d\n", grid->nr);
858     fprintf(log, "nrx:       %d\n", grid->n[XX]);
859     fprintf(log, "nry:       %d\n", grid->n[YY]);
860     fprintf(log, "nrz:       %d\n", grid->n[ZZ]);
861     fprintf(log, "ncg_ideal: %d\n", grid->ncg_ideal);
862     fprintf(log, "    i  cell_index\n");
863     for (i = 0; (i < grid->nr); i++)
864     {
865         fprintf(log, "%5d  %5d\n", i, grid->cell_index[i]);
866     }
867     fprintf(log, "cells\n");
868     fprintf(log, " ix iy iz   nr  index  cgs...\n");
869     ci = 0;
870     for (ix = 0; (ix < grid->n[XX]); ix++)
871     {
872         for (iy = 0; (iy < grid->n[YY]); iy++)
873         {
874             for (iz = 0; (iz < grid->n[ZZ]); iz++, ci++)
875             {
876                 index = grid->index[ci];
877                 nra   = grid->nra[ci];
878                 fprintf(log, "%3d%3d%3d%5d%5d", ix, iy, iz, nra, index);
879                 for (i = 0; (i < nra); i++)
880                 {
881                     fprintf(log, "%5d", grid->a[index+i]);
882                 }
883                 fprintf(log, "\n");
884             }
885         }
886     }
887     fflush(log);
888 }