space.c 58.2 KB
Newer Older
1
/*******************************************************************************
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 * This file is part of SWIFT.
 * Copyright (c) 2012 Pedro Gonnet (pedro.gonnet@durham.ac.uk)
 *                    Matthieu Schaller (matthieu.schaller@durham.ac.uk)
 *               2015 Peter W. Draper (p.w.draper@durham.ac.uk)
 *               2016 John A. Regan (john.a.regan@durham.ac.uk)
 *                    Tom Theuns (tom.theuns@durham.ac.uk)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/
Pedro Gonnet's avatar
Pedro Gonnet committed
23
24
25
26
27
28
29
30

/* Config parameters. */
#include "../config.h"

/* Some standard headers. */
#include <float.h>
#include <limits.h>
#include <math.h>
31
#include <stdlib.h>
32
#include <string.h>
Pedro Gonnet's avatar
Pedro Gonnet committed
33

34
35
/* MPI headers. */
#ifdef WITH_MPI
36
#include <mpi.h>
37
38
#endif

39
40
41
/* This object's header. */
#include "space.h"

Pedro Gonnet's avatar
Pedro Gonnet committed
42
/* Local headers. */
43
#include "atomic.h"
44
#include "const.h"
45
#include "cooling.h"
46
#include "engine.h"
47
#include "error.h"
48
49
#include "gravity.h"
#include "hydro.h"
50
#include "kernel_hydro.h"
51
#include "lock.h"
52
#include "minmax.h"
53
#include "runner.h"
54
#include "threadpool.h"
55
#include "tools.h"
Pedro Gonnet's avatar
Pedro Gonnet committed
56
57
58

/* Split size. */
int space_splitsize = space_splitsize_default;
59
int space_subsize = space_subsize_default;
60
int space_maxsize = space_maxsize_default;
61
int space_maxcount = space_maxcount_default;
Pedro Gonnet's avatar
Pedro Gonnet committed
62
63
64

/* Map shift vector to sortlist. */
const int sortlistID[27] = {
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
    /* ( -1 , -1 , -1 ) */ 0,
    /* ( -1 , -1 ,  0 ) */ 1,
    /* ( -1 , -1 ,  1 ) */ 2,
    /* ( -1 ,  0 , -1 ) */ 3,
    /* ( -1 ,  0 ,  0 ) */ 4,
    /* ( -1 ,  0 ,  1 ) */ 5,
    /* ( -1 ,  1 , -1 ) */ 6,
    /* ( -1 ,  1 ,  0 ) */ 7,
    /* ( -1 ,  1 ,  1 ) */ 8,
    /* (  0 , -1 , -1 ) */ 9,
    /* (  0 , -1 ,  0 ) */ 10,
    /* (  0 , -1 ,  1 ) */ 11,
    /* (  0 ,  0 , -1 ) */ 12,
    /* (  0 ,  0 ,  0 ) */ 0,
    /* (  0 ,  0 ,  1 ) */ 12,
    /* (  0 ,  1 , -1 ) */ 11,
    /* (  0 ,  1 ,  0 ) */ 10,
    /* (  0 ,  1 ,  1 ) */ 9,
    /* (  1 , -1 , -1 ) */ 8,
    /* (  1 , -1 ,  0 ) */ 7,
    /* (  1 , -1 ,  1 ) */ 6,
    /* (  1 ,  0 , -1 ) */ 5,
    /* (  1 ,  0 ,  0 ) */ 4,
    /* (  1 ,  0 ,  1 ) */ 3,
    /* (  1 ,  1 , -1 ) */ 2,
    /* (  1 ,  1 ,  0 ) */ 1,
    /* (  1 ,  1 ,  1 ) */ 0};

93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/**
 * @brief Interval stack necessary for parallel particle sorting.
 */
struct qstack {
  volatile ptrdiff_t i, j;
  volatile int min, max;
  volatile int ready;
};

/**
 * @brief Parallel particle-sorting stack
 */
struct parallel_sort {
  struct part *parts;
  struct gpart *gparts;
  struct xpart *xparts;
  int *ind;
  struct qstack *stack;
  unsigned int stack_size;
  volatile unsigned int first, last, waiting;
};

115
116
117
118
119
120
121
122
123
/**
 * @brief Information required to compute the particle cell indices.
 */
struct index_data {
  struct space *s;
  struct cell *cells;
  int *ind;
};

124
125
126
127
128
129
130
131
132
133
134
/**
 * @brief Get the shift-id of the given pair of cells, swapping them
 *      if need be.
 *
 * @param s The space
 * @param ci Pointer to first #cell.
 * @param cj Pointer second #cell.
 * @param shift Vector from ci to cj.
 *
 * @return The shift ID and set shift, may or may not swap ci and cj.
 */
135
136
137
138
int space_getsid(struct space *s, struct cell **ci, struct cell **cj,
                 double *shift) {

  /* Get the relative distance between the pairs, wrapping. */
139
140
141
  const int periodic = s->periodic;
  double dx[3];
  for (int k = 0; k < 3; k++) {
142
143
144
145
146
147
148
149
150
151
152
    dx[k] = (*cj)->loc[k] - (*ci)->loc[k];
    if (periodic && dx[k] < -s->dim[k] / 2)
      shift[k] = s->dim[k];
    else if (periodic && dx[k] > s->dim[k] / 2)
      shift[k] = -s->dim[k];
    else
      shift[k] = 0.0;
    dx[k] += shift[k];
  }

  /* Get the sorting index. */
153
  int sid = 0;
154
  for (int k = 0; k < 3; k++)
155
156
157
158
    sid = 3 * sid + ((dx[k] < 0.0) ? 0 : ((dx[k] > 0.0) ? 2 : 1));

  /* Switch the cells around? */
  if (runner_flip[sid]) {
159
    struct cell *temp = *ci;
160
161
    *ci = *cj;
    *cj = temp;
162
    for (int k = 0; k < 3; k++) shift[k] = -shift[k];
163
164
165
166
167
168
  }
  sid = sortlistID[sid];

  /* Return the sort ID. */
  return sid;
}
169

170
/**
171
 * @brief Recursively dismantle a cell tree.
172
 *
173
174
 * @param s The #space.
 * @param c The #cell to recycle.
175
 */
176
177
178
void space_rebuild_recycle(struct space *s, struct cell *c) {

  if (c->split)
179
    for (int k = 0; k < 8; k++)
180
181
182
183
184
185
186
      if (c->progeny[k] != NULL) {
        space_rebuild_recycle(s, c->progeny[k]);
        space_recycle(s, c->progeny[k]);
        c->progeny[k] = NULL;
      }
}

187
188
189
/**
 * @brief Mapper function to clean out the cell hierarchies for a regrid.
 */
Pedro Gonnet's avatar
Pedro Gonnet committed
190
191
192
193

void space_clear_cells_mapper(void *map_data, int num_elements,
                              void *extra_data) {

194
195
  struct cell *cells = (struct cell *)map_data;
  struct space *s = (struct space *)extra_data;
Pedro Gonnet's avatar
Pedro Gonnet committed
196

197
198
  for (int k = 0; k < num_elements; k++) {
    struct cell *c = &cells[k];
Pedro Gonnet's avatar
Pedro Gonnet committed
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
    space_rebuild_recycle(s, c);
    c->sorts = NULL;
    c->nr_tasks = 0;
    c->density = NULL;
    c->gradient = NULL;
    c->force = NULL;
    c->grav = NULL;
    c->dx_max = 0.0f;
    c->sorted = 0;
    c->count = 0;
    c->gcount = 0;
    c->init = NULL;
    c->extra_ghost = NULL;
    c->ghost = NULL;
    c->kick = NULL;
    c->cooling = NULL;
    c->sourceterms = NULL;
    c->super = c;
217
#if WITH_MPI
Pedro Gonnet's avatar
Pedro Gonnet committed
218
219
220
221
222
223
224
225
226
    c->recv_xv = NULL;
    c->recv_rho = NULL;
    c->recv_gradient = NULL;
    c->recv_ti = NULL;

    c->send_xv = NULL;
    c->send_rho = NULL;
    c->send_gradient = NULL;
    c->send_ti = NULL;
227
228
229
230
#endif
  }
}

231
/**
232
 * @brief Re-build the top-level cell grid.
233
 *
234
 * @param s The #space.
235
 * @param verbose Print messages to stdout or not.
236
 */
237
void space_regrid(struct space *s, int verbose) {
238

239
  const size_t nr_parts = s->nr_parts;
240
  const ticks tic = getticks();
241
  const int ti_current = (s->e != NULL) ? s->e->ti_current : 0;
242

243
  /* Run through the cells and get the current h_max. */
244
  // tic = getticks();
245
  float h_max = s->cell_min / kernel_gamma / space_stretch;
246
  if (nr_parts > 0) {
247
    if (s->cells_top != NULL) {
Tom Theuns's avatar
Tom Theuns committed
248
      for (int k = 0; k < s->nr_cells; k++) {
249
250
251
        if (s->cells_top[k].nodeID == engine_rank &&
            s->cells_top[k].h_max > h_max) {
          h_max = s->cells_top[k].h_max;
252
        }
253
254
      }
    } else {
255
      for (size_t k = 0; k < nr_parts; k++) {
Matthieu Schaller's avatar
Matthieu Schaller committed
256
        if (s->parts[k].h > h_max) h_max = s->parts[k].h;
257
      }
258
259
260
261
262
263
264
265
266
267
    }
  }

/* If we are running in parallel, make sure everybody agrees on
   how large the largest cell should be. */
#ifdef WITH_MPI
  {
    float buff;
    if (MPI_Allreduce(&h_max, &buff, 1, MPI_FLOAT, MPI_MAX, MPI_COMM_WORLD) !=
        MPI_SUCCESS)
268
      error("Failed to aggregate the rebuild flag across nodes.");
269
270
271
    h_max = buff;
  }
#endif
272
  if (verbose) message("h_max is %.3e (cell_min=%.3e).", h_max, s->cell_min);
273
274

  /* Get the new putative cell dimensions. */
275
  const int cdim[3] = {
276
277
278
279
280
281
      floor(s->dim[0] /
            fmax(h_max * kernel_gamma * space_stretch, s->cell_min)),
      floor(s->dim[1] /
            fmax(h_max * kernel_gamma * space_stretch, s->cell_min)),
      floor(s->dim[2] /
            fmax(h_max * kernel_gamma * space_stretch, s->cell_min))};
282
283
284
285
286

  /* Check if we have enough cells for periodicity. */
  if (s->periodic && (cdim[0] < 3 || cdim[1] < 3 || cdim[2] < 3))
    error(
        "Must have at least 3 cells in each spatial dimension when periodicity "
287
288
289
        "is switched on.\nThis error is often caused by any of the "
        "followings:\n"
        " - too few particles to generate a sensible grid,\n"
290
291
        " - the initial value of 'Scheduler:max_top_level_cells' is too "
        "small,\n"
292
        " - the (minimal) time-step is too large leading to particles with "
293
294
295
        "predicted smoothing lengths too large for the box size,\n"
        " - particle with velocities so large that they move by more than two "
        "box sizes per time-step.\n");
296

297
298
299
300
301
302
  /* Check if we have enough cells for gravity. */
  if (s->gravity && (cdim[0] < 8 || cdim[1] < 8 || cdim[2] < 8))
    error(
        "Must have at least 8 cells in each spatial dimension when gravity "
        "is switched on.");

303
304
305
/* In MPI-Land, changing the top-level cell size requires that the
 * global partition is recomputed and the particles redistributed.
 * Be prepared to do that. */
306
#ifdef WITH_MPI
Matthieu Schaller's avatar
Matthieu Schaller committed
307
  double oldwidth[3];
308
309
310
311
312
313
314
315
  double oldcdim[3];
  int *oldnodeIDs = NULL;
  if (cdim[0] < s->cdim[0] || cdim[1] < s->cdim[1] || cdim[2] < s->cdim[2]) {

    /* Capture state of current space. */
    oldcdim[0] = s->cdim[0];
    oldcdim[1] = s->cdim[1];
    oldcdim[2] = s->cdim[2];
316
317
318
    oldwidth[0] = s->width[0];
    oldwidth[1] = s->width[1];
    oldwidth[2] = s->width[2];
319
320
321
322
323
324
325
326
327

    if ((oldnodeIDs = (int *)malloc(sizeof(int) * s->nr_cells)) == NULL)
      error("Failed to allocate temporary nodeIDs.");

    int cid = 0;
    for (int i = 0; i < s->cdim[0]; i++) {
      for (int j = 0; j < s->cdim[1]; j++) {
        for (int k = 0; k < s->cdim[2]; k++) {
          cid = cell_getid(oldcdim, i, j, k);
328
          oldnodeIDs[cid] = s->cells_top[cid].nodeID;
329
330
331
332
333
        }
      }
    }
  }

334
335
336
337
#endif

  /* Do we need to re-build the upper-level cells? */
  // tic = getticks();
338
  if (s->cells_top == NULL || cdim[0] < s->cdim[0] || cdim[1] < s->cdim[1] ||
339
340
341
      cdim[2] < s->cdim[2]) {

    /* Free the old cells, if they were allocated. */
342
    if (s->cells_top != NULL) {
343
      for (int k = 0; k < s->nr_cells; k++) {
344
345
        space_rebuild_recycle(s, &s->cells_top[k]);
        if (s->cells_top[k].sort != NULL) free(s->cells_top[k].sort);
346
      }
347
      free(s->cells_top);
348
349
350
351
      s->maxdepth = 0;
    }

    /* Set the new cell dimensions only if smaller. */
352
    for (int k = 0; k < 3; k++) {
353
      s->cdim[k] = cdim[k];
354
355
      s->width[k] = s->dim[k] / cdim[k];
      s->iwidth[k] = 1.0 / s->width[k];
356
    }
357
    const float dmin = min(s->width[0], min(s->width[1], s->width[2]));
358
359
360

    /* Allocate the highest level of cells. */
    s->tot_cells = s->nr_cells = cdim[0] * cdim[1] * cdim[2];
361
    if (posix_memalign((void *)&s->cells_top, cell_align,
362
363
                       s->nr_cells * sizeof(struct cell)) != 0)
      error("Failed to allocate cells.");
364
    bzero(s->cells_top, s->nr_cells * sizeof(struct cell));
365
    for (int k = 0; k < s->nr_cells; k++)
366
367
      if (lock_init(&s->cells_top[k].lock) != 0)
        error("Failed to init spinlock.");
368
369

    /* Set the cell location and sizes. */
370
371
372
    for (int i = 0; i < cdim[0]; i++)
      for (int j = 0; j < cdim[1]; j++)
        for (int k = 0; k < cdim[2]; k++) {
373
          struct cell *restrict c = &s->cells_top[cell_getid(cdim, i, j, k)];
374
375
376
377
378
379
          c->loc[0] = i * s->width[0];
          c->loc[1] = j * s->width[1];
          c->loc[2] = k * s->width[2];
          c->width[0] = s->width[0];
          c->width[1] = s->width[1];
          c->width[2] = s->width[2];
380
381
382
383
384
          c->dmin = dmin;
          c->depth = 0;
          c->count = 0;
          c->gcount = 0;
          c->super = c;
385
          c->ti_old = ti_current;
386
          lock_init(&c->lock);
Pedro Gonnet's avatar
Pedro Gonnet committed
387
        }
388
389

    /* Be verbose about the change. */
390
391
392
    if (verbose)
      message("set cell dimensions to [ %i %i %i ].", cdim[0], cdim[1],
              cdim[2]);
393
394
    fflush(stdout);

395
#ifdef WITH_MPI
396
397
398
399
400
    if (oldnodeIDs != NULL) {
      /* We have changed the top-level cell dimension, so need to redistribute
       * cells around the nodes. We repartition using the old space node
       * positions as a grid to resample. */
      if (s->e->nodeID == 0)
401
402
403
        message(
            "basic cell dimensions have increased - recalculating the "
            "global partition.");
404

Matthieu Schaller's avatar
Matthieu Schaller committed
405
      if (!partition_space_to_space(oldwidth, oldcdim, oldnodeIDs, s)) {
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423

        /* Failed, try another technique that requires no settings. */
        message("Failed to get a new partition, trying less optimal method");
        struct partition initial_partition;
#ifdef HAVE_METIS
        initial_partition.type = INITPART_METIS_NOWEIGHT;
#else
        initial_partition.type = INITPART_VECTORIZE;
#endif
        partition_initial_partition(&initial_partition, s->e->nodeID,
                                    s->e->nr_nodes, s);
      }

      /* Re-distribute the particles to their new nodes. */
      engine_redistribute(s->e);

      /* Make the proxies. */
      engine_makeproxies(s->e);
424

425
426
      /* Finished with these. */
      free(oldnodeIDs);
427
    }
Pedro Gonnet's avatar
Pedro Gonnet committed
428
#endif /* WITH_MPI */
429
430
431
432

    // message( "rebuilding upper-level cells took %.3f %s." ,
    // clocks_from_ticks(double)(getticks() - tic), clocks_getunit());

433
434
  } /* re-build upper-level cells? */

435
  else { /* Otherwise, just clean up the cells. */
436
437

    /* Free the old cells, if they were allocated. */
Pedro Gonnet's avatar
Pedro Gonnet committed
438
439
    threadpool_map(&s->e->threadpool, space_clear_cells_mapper, s->cells_top,
                   s->nr_cells, sizeof(struct cell), 100, s);
440
    // space_clear_cells_mapper(s->cells_top, s->nr_cells, s);
441
442
    s->maxdepth = 0;
  }
443
444
445
446

  if (verbose)
    message("took %.3f %s.", clocks_from_ticks(getticks() - tic),
            clocks_getunit());
447
}
448
449
450
451
452

/**
 * @brief Re-build the cells as well as the tasks.
 *
 * @param s The #space in which to update the cells.
453
 * @param verbose Print messages to stdout or not
454
455
 *
 */
456
void space_rebuild(struct space *s, int verbose) {
457

Matthieu Schaller's avatar
Matthieu Schaller committed
458
  const ticks tic = getticks();
459
460

  /* Be verbose about this. */
461
  // message("re)building space..."); fflush(stdout);
462
463

  /* Re-grid if necessary, or just re-set the cell data. */
464
  space_regrid(s, verbose);
465

Pedro Gonnet's avatar
Pedro Gonnet committed
466
467
  size_t nr_parts = s->nr_parts;
  size_t nr_gparts = s->nr_gparts;
468
  struct cell *restrict cells_top = s->cells_top;
469
  const int ti_current = (s->e != NULL) ? s->e->ti_current : 0;
470
471

  /* Run through the particles and get their cell index. */
472
  const size_t ind_size = s->size_parts + 100;
473
474
  int *ind;
  if ((ind = (int *)malloc(sizeof(int) * ind_size)) == NULL)
475
    error("Failed to allocate temporary particle indices.");
476
  if (s->size_parts > 0) space_parts_get_cell_index(s, ind, cells_top, verbose);
477

478
  /* Run through the gravity particles and get their cell index. */
479
  const size_t gind_size = s->size_gparts + 100;
480
481
482
  int *gind;
  if ((gind = (int *)malloc(sizeof(int) * gind_size)) == NULL)
    error("Failed to allocate temporary g-particle indices.");
Pedro Gonnet's avatar
Pedro Gonnet committed
483
484
  if (s->size_gparts > 0)
    space_gparts_get_cell_index(s, gind, cells_top, verbose);
485
486

#ifdef WITH_MPI
487

488
  /* Move non-local parts to the end of the list. */
489
  const int local_nodeID = s->e->nodeID;
490
  for (size_t k = 0; k < nr_parts;) {
491
    if (cells_top[ind[k]].nodeID != local_nodeID) {
492
      nr_parts -= 1;
Matthieu Schaller's avatar
Bug fix    
Matthieu Schaller committed
493
      const struct part tp = s->parts[k];
494
495
      s->parts[k] = s->parts[nr_parts];
      s->parts[nr_parts] = tp;
496
      if (s->parts[k].gpart != NULL) {
497
        s->parts[k].gpart->id_or_neg_offset = -k;
498
499
      }
      if (s->parts[nr_parts].gpart != NULL) {
500
        s->parts[nr_parts].gpart->id_or_neg_offset = -nr_parts;
501
      }
Matthieu Schaller's avatar
Bug fix    
Matthieu Schaller committed
502
      const struct xpart txp = s->xparts[k];
503
504
      s->xparts[k] = s->xparts[nr_parts];
      s->xparts[nr_parts] = txp;
Matthieu Schaller's avatar
Bug fix    
Matthieu Schaller committed
505
      const int t = ind[k];
506
507
      ind[k] = ind[nr_parts];
      ind[nr_parts] = t;
Matthieu Schaller's avatar
Matthieu Schaller committed
508
    } else {
509
510
511
512
      /* Increment when not exchanging otherwise we need to retest "k".*/
      k++;
    }
  }
513

514
#ifdef SWIFT_DEBUG_CHECKS
Peter W. Draper's avatar
Peter W. Draper committed
515
  /* Check that all parts are in the correct places. */
516
  for (size_t k = 0; k < nr_parts; k++) {
517
    if (cells_top[ind[k]].nodeID != local_nodeID) {
518
519
520
521
      error("Failed to move all non-local parts to send list");
    }
  }
  for (size_t k = nr_parts; k < s->nr_parts; k++) {
522
    if (cells_top[ind[k]].nodeID == local_nodeID) {
523
      error("Failed to remove local parts from send list");
524
    }
525
526
  }
#endif
527

528
  /* Move non-local gparts to the end of the list. */
529
  for (size_t k = 0; k < nr_gparts;) {
530
    if (cells_top[gind[k]].nodeID != local_nodeID) {
531
      nr_gparts -= 1;
Matthieu Schaller's avatar
Bug fix    
Matthieu Schaller committed
532
      const struct gpart tp = s->gparts[k];
533
534
      s->gparts[k] = s->gparts[nr_gparts];
      s->gparts[nr_gparts] = tp;
535
536
      if (s->gparts[k].id_or_neg_offset <= 0) {
        s->parts[-s->gparts[k].id_or_neg_offset].gpart = &s->gparts[k];
537
      }
538
539
540
      if (s->gparts[nr_gparts].id_or_neg_offset <= 0) {
        s->parts[-s->gparts[nr_gparts].id_or_neg_offset].gpart =
            &s->gparts[nr_gparts];
541
      }
Matthieu Schaller's avatar
Bug fix    
Matthieu Schaller committed
542
543
544
      const int t = gind[k];
      gind[k] = gind[nr_gparts];
      gind[nr_gparts] = t;
Matthieu Schaller's avatar
Matthieu Schaller committed
545
    } else {
546
547
548
549
      /* Increment when not exchanging otherwise we need to retest "k".*/
      k++;
    }
  }
550

551
#ifdef SWIFT_DEBUG_CHECKS
552
553
  /* Check that all gparts are in the correct place (untested). */
  for (size_t k = 0; k < nr_gparts; k++) {
554
    if (cells_top[gind[k]].nodeID != local_nodeID) {
555
556
557
558
      error("Failed to move all non-local gparts to send list");
    }
  }
  for (size_t k = nr_gparts; k < s->nr_gparts; k++) {
559
    if (cells_top[gind[k]].nodeID == local_nodeID) {
560
      error("Failed to remove local gparts from send list");
561
    }
562
563
  }
#endif
564

565
566
  /* Exchange the strays, note that this potentially re-allocates
     the parts arrays. */
567
  size_t nr_parts_exchanged = s->nr_parts - nr_parts;
568
  size_t nr_gparts_exchanged = s->nr_gparts - nr_gparts;
Pedro Gonnet's avatar
Pedro Gonnet committed
569
570
571
572
  engine_exchange_strays(s->e, nr_parts, &ind[nr_parts], &nr_parts_exchanged,
                         nr_gparts, &gind[nr_gparts], &nr_gparts_exchanged);

  /* Set the new particle counts. */
573
  s->nr_parts = nr_parts + nr_parts_exchanged;
574
  s->nr_gparts = nr_gparts + nr_gparts_exchanged;
575
576

  /* Re-allocate the index array if needed.. */
577
  if (s->nr_parts + 1 > ind_size) {
578
    int *ind_new;
579
    if ((ind_new = (int *)malloc(sizeof(int) * (s->nr_parts + 1))) == NULL)
580
      error("Failed to allocate temporary particle indices.");
581
    memcpy(ind_new, ind, sizeof(int) * nr_parts);
582
583
    free(ind);
    ind = ind_new;
584
585
  }

586
587
588
  const int cdim[3] = {s->cdim[0], s->cdim[1], s->cdim[2]};
  const double ih[3] = {s->iwidth[0], s->iwidth[1], s->iwidth[2]};

589
  /* Assign each particle to its cell. */
Pedro Gonnet's avatar
Pedro Gonnet committed
590
  for (size_t k = nr_parts; k < s->nr_parts; k++) {
Matthieu Schaller's avatar
Matthieu Schaller committed
591
    const struct part *const p = &s->parts[k];
592
    ind[k] =
593
        cell_getid(cdim, p->x[0] * ih[0], p->x[1] * ih[1], p->x[2] * ih[2]);
594
#ifdef SWIFT_DEBUG_CHECKS
595
    if (cells_top[ind[k]].nodeID != local_nodeID)
596
      error("Received part that does not belong to me (nodeID=%i).",
597
            cells_top[ind[k]].nodeID);
598
#endif
599
  }
600
  nr_parts = s->nr_parts;
601
602

#endif /* WITH_MPI */
603
604

  /* Sort the parts according to their cells. */
605
606
  if (nr_parts > 0)
    space_parts_sort(s, ind, nr_parts, 0, s->nr_cells - 1, verbose);
607
608

  /* Re-link the gparts. */
609
  if (nr_parts > 0 && nr_gparts > 0) part_relink_gparts(s->parts, nr_parts, 0);
610

611
#ifdef SWIFT_DEBUG_CHECKS
612
  /* Verify space_sort_struct. */
613
614
615
  for (size_t k = 1; k < nr_parts; k++) {
    if (ind[k - 1] > ind[k]) {
      error("Sort failed!");
616
    } else if (ind[k] != cell_getid(s->cdim, s->parts[k].x[0] * s->iwidth[0],
617
618
                                    s->parts[k].x[1] * s->iwidth[1],
                                    s->parts[k].x[2] * s->iwidth[2])) {
619
620
621
622
      error("Incorrect indices!");
    }
  }
#endif
623

624
625
626
627
628
629
630
631
632
633
  /* Extract the cell counts from the sorted indices. */
  size_t last_index = 0;
  ind[nr_parts] = s->nr_cells;  // sentinel.
  for (size_t k = 0; k < nr_parts; k++) {
    if (ind[k] < ind[k + 1]) {
      cells_top[ind[k]].count = k - last_index + 1;
      last_index = k + 1;
    }
  }

634
  /* We no longer need the indices as of here. */
635
  free(ind);
636

637
638
639
#ifdef WITH_MPI

  /* Re-allocate the index array if needed.. */
640
  if (s->nr_gparts + 1 > gind_size) {
641
    int *gind_new;
642
    if ((gind_new = (int *)malloc(sizeof(int) * (s->nr_gparts + 1))) == NULL)
643
      error("Failed to allocate temporary g-particle indices.");
644
    memcpy(gind_new, gind, sizeof(int) * nr_gparts);
645
646
647
648
649
    free(gind);
    gind = gind_new;
  }

  /* Assign each particle to its cell. */
650
  for (size_t k = nr_gparts; k < s->nr_gparts; k++) {
Matthieu Schaller's avatar
Matthieu Schaller committed
651
    const struct gpart *const p = &s->gparts[k];
652
653
    gind[k] =
        cell_getid(cdim, p->x[0] * ih[0], p->x[1] * ih[1], p->x[2] * ih[2]);
654
655
656
657
658
659

#ifdef SWIFT_DEBUG_CHECKS
    if (cells_top[ind[k]].nodeID != s->e->nodeID)
      error("Received part that does not belong to me (nodeID=%i).",
            cells_top[ind[k]].nodeID);
#endif
660
661
662
663
  }
  nr_gparts = s->nr_gparts;

#endif
664

665
  /* Sort the gparts according to their cells. */
666
667
  if (nr_gparts > 0)
    space_gparts_sort(s, gind, nr_gparts, 0, s->nr_cells - 1, verbose);
668
669

  /* Re-link the parts. */
670
671
  if (nr_parts > 0 && nr_gparts > 0)
    part_relink_parts(s->gparts, nr_gparts, s->parts);
672

673
674
675
676
677
678
679
680
681
682
  /* Extract the cell counts from the sorted indices. */
  size_t last_gindex = 0;
  gind[nr_parts] = s->nr_cells;
  for (size_t k = 0; k < nr_gparts; k++) {
    if (gind[k] < gind[k + 1]) {
      cells_top[ind[k]].gcount = k - last_gindex + 1;
      last_gindex = k + 1;
    }
  }

683
  /* We no longer need the indices as of here. */
684
  free(gind);
685

686
#ifdef SWIFT_DEBUG_CHECKS
687
688
689
  /* Verify that the links are correct */
  for (size_t k = 0; k < nr_gparts; ++k) {

690
    if (s->gparts[k].id_or_neg_offset < 0) {
691

692
      const struct part *part = &s->parts[-s->gparts[k].id_or_neg_offset];
693

694
695
696
697
      if (part->gpart != &s->gparts[k]) error("Linking problem !");

      if (s->gparts[k].x[0] != part->x[0] || s->gparts[k].x[1] != part->x[1] ||
          s->gparts[k].x[2] != part->x[2])
698
699
700
701
702
        error("Linked particles are not at the same position !");
    }
  }
  for (size_t k = 0; k < nr_parts; ++k) {

703
    if (s->parts[k].gpart != NULL &&
704
        s->parts[k].gpart->id_or_neg_offset != -(ptrdiff_t)k) {
705
      error("Linking problem !");
706
707
    }
  }
708
#endif
709

710
711
  /* Hook the cells up to the parts. */
  // tic = getticks();
712
713
714
  struct part *finger = s->parts;
  struct xpart *xfinger = s->xparts;
  struct gpart *gfinger = s->gparts;
715
  for (int k = 0; k < s->nr_cells; k++) {
716
    struct cell *restrict c = &cells_top[k];
717
    c->ti_old = ti_current;
718
719
720
721
722
723
724
    c->parts = finger;
    c->xparts = xfinger;
    c->gparts = gfinger;
    finger = &finger[c->count];
    xfinger = &xfinger[c->count];
    gfinger = &gfinger[c->gcount];
  }
725
  // message( "hooking up cells took %.3f %s." ,
Matthieu Schaller's avatar
Matthieu Schaller committed
726
  // clocks_from_ticks(getticks() - tic), clocks_getunit());
727
728
729

  /* At this point, we have the upper-level cells, old or new. Now make
     sure that the parts in each cell are ok. */
730
  space_split(s, cells_top, s->nr_cells, verbose);
731
732
733
734
735
736
737
738
739

  if (verbose)
    message("took %.3f %s.", clocks_from_ticks(getticks() - tic),
            clocks_getunit());
}

/**
 * @brief Split particles between cells of a hierarchy
 *
740
741
 * This is done in parallel using threads in the #threadpool.
 *
742
 * @param s The #space.
743
744
 * @param cells The cell hierarchy.
 * @param nr_cells The number of cells.
745
746
 * @param verbose Are we talkative ?
 */
747
748
void space_split(struct space *s, struct cell *cells, int nr_cells,
                 int verbose) {
749

Matthieu Schaller's avatar
Matthieu Schaller committed
750
  const ticks tic = getticks();
751

752
  threadpool_map(&s->e->threadpool, space_split_mapper, cells, nr_cells,
753
                 sizeof(struct cell), 1, s);
754

755
756
757
  if (verbose)
    message("took %.3f %s.", clocks_from_ticks(getticks() - tic),
            clocks_getunit());
758
}
759

760
761
762
763
764
765
766
767
/**
 * @brief Runs through the top-level cells and checks whether tasks associated
 * with them can be split. If not, try to sanitize the cells.
 *
 * @param s The #space to act upon.
 */
void space_sanitize(struct space *s) {

768
769
  s->sanitized = 1;

770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
  for (int k = 0; k < s->nr_cells; k++) {

    struct cell *c = &s->cells_top[k];
    const double min_width = c->dmin;

    /* Do we have a problem ? */
    if (c->h_max * kernel_gamma * space_stretch > min_width * 0.5 &&
        c->count > space_maxcount) {

      /* Ok, clean-up the mess */
      cell_sanitize(c);
    }
  }
}

785
/**
786
 * @brief #threadpool mapper function to compute the particle cell indices.
787
 *
788
 * @param map_data Pointer towards the particles.
789
 * @param nr_parts The number of particles to treat.
790
 * @param extra_data Pointers to the space and index list
791
 */
792
793
void space_parts_get_cell_index_mapper(void *map_data, int nr_parts,
                                       void *extra_data) {
794

795
796
797
798
  /* Unpack the data */
  struct part *restrict parts = (struct part *)map_data;
  struct index_data *data = (struct index_data *)extra_data;
  struct space *s = data->s;
799
  int *const ind = data->ind + (ptrdiff_t)(parts - s->parts);
800
801

  /* Get some constants */
802
803
804
  const double dim_x = s->dim[0];
  const double dim_y = s->dim[1];
  const double dim_z = s->dim[2];
Matthieu Schaller's avatar
Matthieu Schaller committed
805
  const int cdim[3] = {s->cdim[0], s->cdim[1], s->cdim[2]};
806
807
808
  const double ih_x = s->iwidth[0];
  const double ih_y = s->iwidth[1];
  const double ih_z = s->iwidth[2];
809

810
  for (int k = 0; k < nr_parts; k++) {
811
812
813
814

    /* Get the particle */
    struct part *restrict p = &parts[k];

815
816
817
818
    const double old_pos_x = p->x[0];
    const double old_pos_y = p->x[1];
    const double old_pos_z = p->x[2];

819
    /* Put it back into the simulation volume */
820
821
822
    const double pos_x = box_wrap(old_pos_x, 0.0, dim_x);
    const double pos_y = box_wrap(old_pos_y, 0.0, dim_y);
    const double pos_z = box_wrap(old_pos_z, 0.0, dim_z);
823
824

    /* Get its cell index */
Matthieu Schaller's avatar
Matthieu Schaller committed
825
826
    const int index =
        cell_getid(cdim, pos_x * ih_x, pos_y * ih_y, pos_z * ih_z);
827
    ind[k] = index;
828

829
830
831
832
    /* Update the position */
    p->x[0] = pos_x;
    p->x[1] = pos_y;
    p->x[2] = pos_z;
833
834
835
836
  }
}

/**
837
 * @brief #threadpool mapper function to compute the g-particle cell indices.
838
 *
839
 * @param map_data Pointer towards the g-particles.
840
 * @param nr_gparts The number of g-particles to treat.
841
 * @param extra_data Pointers to the space and index list
842
 */
843
844
void space_gparts_get_cell_index_mapper(void *map_data, int nr_gparts,
                                        void *extra_data) {
845

846
847
848
849
  /* Unpack the data */
  struct gpart *restrict gparts = (struct gpart *)map_data;
  struct index_data *data = (struct index_data *)extra_data;
  struct space *s = data->s;
850
  int *const ind = data->ind + (ptrdiff_t)(gparts - s->gparts);
851
852

  /* Get some constants */
Matthieu Schaller's avatar
Matthieu Schaller committed
853
854
855
  const double dim_x = s->dim[0];
  const double dim_y = s->dim[1];
  const double dim_z = s->dim[2];
856
  const int cdim[3] = {s->cdim[0], s->cdim[1], s->cdim[2]};
Matthieu Schaller's avatar
Matthieu Schaller committed
857
858
859
  const double ih_x = s->iwidth[0];
  const double ih_y = s->iwidth[1];
  const double ih_z = s->iwidth[2];
860

861
  for (int k = 0; k < nr_gparts; k++) {
862
863
864
865

    /* Get the particle */
    struct gpart *restrict gp = &gparts[k];

Matthieu Schaller's avatar
Matthieu Schaller committed
866
867
868
869
    const double old_pos_x = gp->x[0];
    const double old_pos_y = gp->x[1];
    const double old_pos_z = gp->x[2];

870
    /* Put it back into the simulation volume */
Matthieu Schaller's avatar
Matthieu Schaller committed
871
872
873
    const double pos_x = box_wrap(old_pos_x, 0.0, dim_x);
    const double pos_y = box_wrap(old_pos_y, 0.0, dim_y);
    const double pos_z = box_wrap(old_pos_z, 0.0, dim_z);
874
875
876

    /* Get its cell index */
    const int index =
Matthieu Schaller's avatar
Matthieu Schaller committed
877
        cell_getid(cdim, pos_x * ih_x, pos_y * ih_y, pos_z * ih_z);
878
    ind[k] = index;
Matthieu Schaller's avatar
Matthieu Schaller committed
879
880
881
882
883

    /* Update the position */
    gp->x[0] = pos_x;
    gp->x[1] = pos_y;
    gp->x[2] = pos_z;
884
885
886
  }
}

887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
/**
 * @brief Computes the cell index of all the particles and update the cell
 * count.
 *
 * @param s The #space.
 * @param ind The array of indices to fill.
 * @param cells The array of #cell to update.
 * @param verbose Are we talkative ?
 */
void space_parts_get_cell_index(struct space *s, int *ind, struct cell *cells,
                                int verbose) {

  const ticks tic = getticks();

  /* Pack the extra information */
  struct index_data data;
  data.s = s;
  data.cells = cells;
  data.ind = ind;

  threadpool_map(&s->e->threadpool, space_parts_get_cell_index_mapper, s->parts,
                 s->nr_parts, sizeof(struct part), 1000, &data);

  if (verbose)
    message("took %.3f %s.", clocks_from_ticks(getticks() - tic),
            clocks_getunit());
}

/**
 * @brief Computes the cell index of all the g-particles and update the cell
 * gcount.
 *
 * @param s The #space.
 * @param gind The array of indices to fill.
 * @param cells The array of #cell to update.
 * @param verbose Are we talkative ?
 */
void space_gparts_get_cell_index(struct space *s, int *gind, struct cell *cells,
                                 int verbose) {

  const ticks tic = getticks();

  /* Pack the extra information */
  struct index_data data;
  data.s = s;
  data.cells = cells;
  data.ind = gind;

  threadpool_map(&s->e->threadpool, space_gparts_get_cell_index_mapper,
                 s->gparts, s->nr_gparts, sizeof(struct gpart), 1000, &data);

  if (verbose)
    message("took %.3f %s.", clocks_from_ticks(getticks() - tic),
            clocks_getunit());
}

943
/**
944
 * @brief Sort the particles and condensed particles according to the given
945
 * indices.
946
 *
Matthieu Schaller's avatar
Matthieu Schaller committed
947
 * @param s The #space.
948
949
950
951
 * @param ind The indices with respect to which the parts are sorted.
 * @param N The number of parts
 * @param min Lowest index.
 * @param max highest index.
952
 * @param verbose Are we talkative ?
953
 */
954
void space_parts_sort(struct space *s, int *ind, size_t N, int min, int max,
955
956
                      int verbose) {

Matthieu Schaller's avatar
Matthieu Schaller committed
957
  const ticks tic = getticks();
958

959
960
961
962
963
964
  /* Populate a parallel_sort structure with the input data */
  struct parallel_sort sort_struct;
  sort_struct.parts = s->parts;
  sort_struct.xparts = s->xparts;
  sort_struct.ind = ind;
  sort_struct.stack_size = 2 * (max - min + 1) + 10 + s->e->nr_threads;
965
966
  if ((sort_struct.stack =
           malloc(sizeof(struct qstack) * sort_struct.stack_size)) == NULL)
967
    error("Failed to allocate sorting stack.");
Matthieu Schaller's avatar
Matthieu Schaller committed
968
  for (unsigned int i = 0; i < sort_struct.stack_size; i++)
969
    sort_struct.stack[i].ready = 0;
970

971
  /* Add the first interval. */
972
973
974
975
976
977
978
979
980
981
982
  sort_struct.stack[0].i = 0;
  sort_struct.stack[0].j = N - 1;
  sort_struct.stack[0].min = min;
  sort_struct.stack[0].max = max;
  sort_struct.stack[0].ready = 1;
  sort_struct.first = 0;
  sort_struct.last = 1;
  sort_struct.waiting = 1;

  /* Launch the sorting tasks with a stride of zero such that the same
     map data is passed to each thread. */
983
984
  threadpool_map(&s->e->threadpool, space_parts_sort_mapper, &sort_struct,
                 s->e->threadpool.num_threads, 0, 1, NULL);
985