cell.c 158 KB
Newer Older
1
/*******************************************************************************
2
 * This file is part of SWIFT.
3
 * Copyright (c) 2012 Pedro Gonnet (pedro.gonnet@durham.ac.uk)
4
5
6
7
 *                    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)
8
 *
9
10
11
12
 * 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.
13
 *
14
15
16
17
 * 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.
18
 *
19
20
 * 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/>.
21
 *
22
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
32
33
34
#include <pthread.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
35

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

41
42
/* Switch off timers. */
#ifdef TIMER
43
#undef TIMER
44
45
#endif

46
47
48
/* This object's header. */
#include "cell.h"

49
/* Local headers. */
50
#include "active.h"
51
#include "atomic.h"
52
#include "chemistry.h"
53
#include "drift.h"
54
#include "engine.h"
55
#include "error.h"
56
#include "gravity.h"
57
#include "hydro.h"
Matthieu Schaller's avatar
Matthieu Schaller committed
58
#include "hydro_properties.h"
Pedro Gonnet's avatar
Pedro Gonnet committed
59
#include "memswap.h"
60
#include "minmax.h"
61
#include "scheduler.h"
62
#include "space.h"
63
#include "space_getsid.h"
Loic Hausammann's avatar
Loic Hausammann committed
64
#include "stars.h"
65
#include "timers.h"
66
#include "tools.h"
67
#include "tracers.h"
68

69
70
71
/* Global variables. */
int cell_next_tag = 0;

72
73
74
75
76
/**
 * @brief Get the size of the cell subtree.
 *
 * @param c The #cell.
 */
77
int cell_getsize(struct cell *c) {
78

Pedro Gonnet's avatar
Pedro Gonnet committed
79
80
  /* Number of cells in this subtree. */
  int count = 1;
81

82
83
  /* Sum up the progeny if split. */
  if (c->split)
Pedro Gonnet's avatar
Pedro Gonnet committed
84
    for (int k = 0; k < 8; k++)
85
86
87
88
89
90
      if (c->progeny[k] != NULL) count += cell_getsize(c->progeny[k]);

  /* Return the final count. */
  return count;
}

91
/**
92
 * @brief Link the cells recursively to the given #part array.
93
94
95
96
97
98
 *
 * @param c The #cell.
 * @param parts The #part array.
 *
 * @return The number of particles linked.
 */
99
100
int cell_link_parts(struct cell *c, struct part *parts) {

101
#ifdef SWIFT_DEBUG_CHECKS
102
103
104
  if (c->nodeID == engine_rank)
    error("Linking foreign particles in a local cell!");

105
  if (c->hydro.parts != NULL)
106
107
108
    error("Linking parts into a cell that was already linked");
#endif

109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
  c->hydro.parts = parts;

  /* Fill the progeny recursively, depth-first. */
  if (c->split) {
    int offset = 0;
    for (int k = 0; k < 8; k++) {
      if (c->progeny[k] != NULL)
        offset += cell_link_parts(c->progeny[k], &parts[offset]);
    }
  }

  /* Return the total number of linked particles. */
  return c->hydro.count;
}

/**
125
 * @brief Link the cells recursively to the given #gpart array.
126
127
 *
 * @param c The #cell.
128
 * @param gparts The #gpart array.
129
130
131
 *
 * @return The number of particles linked.
 */
132
int cell_link_gparts(struct cell *c, struct gpart *gparts) {
133
134
135
136
137

#ifdef SWIFT_DEBUG_CHECKS
  if (c->nodeID == engine_rank)
    error("Linking foreign particles in a local cell!");

138
  if (c->grav.parts != NULL)
139
    error("Linking gparts into a cell that was already linked");
140
#endif
141

142
  c->grav.parts = gparts;
143
144
145
146
147
148
149
150
151
152
153

  /* Fill the progeny recursively, depth-first. */
  if (c->split) {
    int offset = 0;
    for (int k = 0; k < 8; k++) {
      if (c->progeny[k] != NULL)
        offset += cell_link_gparts(c->progeny[k], &gparts[offset]);
    }
  }

  /* Return the total number of linked particles. */
154
  return c->grav.count;
155
156
}

157
158
159
160
161
162
163
164
165
166
/**
 * @brief Link the cells recursively to the given #spart array.
 *
 * @param c The #cell.
 * @param sparts The #spart array.
 *
 * @return The number of particles linked.
 */
int cell_link_sparts(struct cell *c, struct spart *sparts) {

167
168
169
170
#ifdef SWIFT_DEBUG_CHECKS
  if (c->nodeID == engine_rank)
    error("Linking foreign particles in a local cell!");

171
  if (c->stars.parts != NULL)
172
173
174
    error("Linking sparts into a cell that was already linked");
#endif

175
  c->stars.parts = sparts;
176
177
178
179
180
181
182
183
184
185
186

  /* Fill the progeny recursively, depth-first. */
  if (c->split) {
    int offset = 0;
    for (int k = 0; k < 8; k++) {
      if (c->progeny[k] != NULL)
        offset += cell_link_sparts(c->progeny[k], &sparts[offset]);
    }
  }

  /* Return the total number of linked particles. */
187
  return c->stars.count;
188
189
}

190
191
192
193
194
195
196
197
198
199
/**
 * @brief Recurse down foreign cells until reaching one with hydro
 * tasks; then trigger the linking of the #part array from that
 * level.
 *
 * @param c The #cell.
 * @param parts The #part array.
 *
 * @return The number of particles linked.
 */
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
int cell_link_foreign_parts(struct cell *c, struct part *parts) {

#ifdef SWIFT_DEBUG_CHECKS
  if (c->nodeID == engine_rank)
    error("Linking foreign particles in a local cell!");
#endif

  /* Do we have a hydro task at this level? */
  if (c->hydro.density != NULL) {

    /* Recursively attach the parts */
    const int counts = cell_link_parts(c, parts);
#ifdef SWIFT_DEBUG_CHECKS
    if (counts != c->hydro.count)
      error("Something is wrong with the foreign counts");
#endif
    return counts;
  }

  /* Go deeper to find the level where the tasks are */
  if (c->split) {
    int count = 0;
    for (int k = 0; k < 8; k++) {
      if (c->progeny[k] != NULL) {
        count += cell_link_foreign_parts(c->progeny[k], &parts[count]);
      }
    }
  }
228
229

  return c->hydro.count;
230
231
}

232
233
234
235
236
237
238
239
240
241
/**
 * @brief Recurse down foreign cells until reaching one with gravity
 * tasks; then trigger the linking of the #gpart array from that
 * level.
 *
 * @param c The #cell.
 * @param gparts The #gpart array.
 *
 * @return The number of particles linked.
 */
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
int cell_link_foreign_gparts(struct cell *c, struct gpart *gparts) {

#ifdef SWIFT_DEBUG_CHECKS
  if (c->nodeID == engine_rank)
    error("Linking foreign particles in a local cell!");
#endif

  /* Do we have a hydro task at this level? */
  if (c->grav.grav != NULL) {

    /* Recursively attach the parts */
    const int counts = cell_link_gparts(c, gparts);
#ifdef SWIFT_DEBUG_CHECKS
    if (counts != c->grav.count)
      error("Something is wrong with the foreign counts");
#endif
    return counts;
  }

  /* Go deeper to find the level where the tasks are */
  if (c->split) {
    int count = 0;
    for (int k = 0; k < 8; k++) {
      if (c->progeny[k] != NULL) {
        count += cell_link_foreign_gparts(c->progeny[k], &gparts[count]);
      }
    }
  }
270
271

  return c->grav.count;
272
273
}

274
275
276
277
278
279
280
281
/**
 * @brief Recursively count the number of #part in foreign cells that
 * are in cells with hydro-related tasks.
 *
 * @param c The #cell.
 *
 * @return The number of particles linked.
 */
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
int cell_count_parts_for_tasks(const struct cell *c) {

#ifdef SWIFT_DEBUG_CHECKS
  if (c->nodeID == engine_rank)
    error("Counting foreign particles in a local cell!");
#endif

  /* Do we have a hydro task at this level? */
  if (c->hydro.density != NULL) {
    return c->hydro.count;
  }

  if (c->split) {
    int count = 0;
    for (int k = 0; k < 8; ++k) {
      if (c->progeny[k] != NULL) {
        count += cell_count_parts_for_tasks(c->progeny[k]);
      }
    }
  }
302
303

  return c->hydro.count;
304
305
}

306
307
308
309
310
311
312
313
/**
 * @brief Recursively count the number of #gpart in foreign cells that
 * are in cells with gravity-related tasks.
 *
 * @param c The #cell.
 *
 * @return The number of particles linked.
 */
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
int cell_count_gparts_for_tasks(const struct cell *c) {

#ifdef SWIFT_DEBUG_CHECKS
  if (c->nodeID == engine_rank)
    error("Counting foreign particles in a local cell!");
#endif

  /* Do we have a hydro task at this level? */
  if (c->grav.grav != NULL) {
    return c->grav.count;
  }

  if (c->split) {
    int count = 0;
    for (int k = 0; k < 8; ++k) {
      if (c->progeny[k] != NULL) {
        count += cell_count_gparts_for_tasks(c->progeny[k]);
      }
    }
  }
334
335

  return c->grav.count;
336
337
}

338
339
340
341
342
343
/**
 * @brief Pack the data of the given cell and all it's sub-cells.
 *
 * @param c The #cell.
 * @param pc Pointer to an array of packed cells in which the
 *      cells will be packed.
344
345
 * @param with_gravity Are we running with gravity and hence need
 *      to exchange multipoles?
346
347
348
 *
 * @return The number of packed cells.
 */
349
int cell_pack(struct cell *restrict c, struct pcell *restrict pc,
Matthieu Schaller's avatar
Matthieu Schaller committed
350
              const int with_gravity) {
351

352
353
#ifdef WITH_MPI

354
  /* Start by packing the data of the current cell. */
355
356
357
358
359
  pc->hydro.h_max = c->hydro.h_max;
  pc->hydro.ti_end_min = c->hydro.ti_end_min;
  pc->hydro.ti_end_max = c->hydro.ti_end_max;
  pc->grav.ti_end_min = c->grav.ti_end_min;
  pc->grav.ti_end_max = c->grav.ti_end_max;
360
  pc->stars.ti_end_min = c->stars.ti_end_min;
361
362
  pc->hydro.ti_old_part = c->hydro.ti_old_part;
  pc->grav.ti_old_part = c->grav.ti_old_part;
363
364
  pc->grav.ti_old_multipole = c->grav.ti_old_multipole;
  pc->hydro.count = c->hydro.count;
365
366
  pc->grav.count = c->grav.count;
  pc->stars.count = c->stars.count;
367
  pc->maxdepth = c->maxdepth;
368

369
  /* Copy the Multipole related information */
Matthieu Schaller's avatar
Matthieu Schaller committed
370
  if (with_gravity) {
371
    const struct gravity_tensors *mp = c->grav.multipole;
372

373
374
375
376
377
378
379
380
381
    pc->grav.m_pole = mp->m_pole;
    pc->grav.CoM[0] = mp->CoM[0];
    pc->grav.CoM[1] = mp->CoM[1];
    pc->grav.CoM[2] = mp->CoM[2];
    pc->grav.CoM_rebuild[0] = mp->CoM_rebuild[0];
    pc->grav.CoM_rebuild[1] = mp->CoM_rebuild[1];
    pc->grav.CoM_rebuild[2] = mp->CoM_rebuild[2];
    pc->grav.r_max = mp->r_max;
    pc->grav.r_max_rebuild = mp->r_max_rebuild;
382
383
  }

384
385
386
#ifdef SWIFT_DEBUG_CHECKS
  pc->cellID = c->cellID;
#endif
387
388

  /* Fill in the progeny, depth-first recursion. */
Pedro Gonnet's avatar
Pedro Gonnet committed
389
390
  int count = 1;
  for (int k = 0; k < 8; k++)
391
392
    if (c->progeny[k] != NULL) {
      pc->progeny[k] = count;
393
      count += cell_pack(c->progeny[k], &pc[count], with_gravity);
394
    } else {
395
      pc->progeny[k] = -1;
396
    }
397
398

  /* Return the number of packed cells used. */
399
  c->mpi.pcell_size = count;
400
  return count;
401
402
403
404
405

#else
  error("SWIFT was not compiled with MPI support.");
  return 0;
#endif
406
407
}

408
409
410
411
412
413
414
415
416
417
418
419
420
/**
 * @brief Pack the tag of the given cell and all it's sub-cells.
 *
 * @param c The #cell.
 * @param tags Pointer to an array of packed tags.
 *
 * @return The number of packed tags.
 */
int cell_pack_tags(const struct cell *c, int *tags) {

#ifdef WITH_MPI

  /* Start by packing the data of the current cell. */
421
  tags[0] = c->mpi.tag;
422
423
424
425
426
427
428
429

  /* Fill in the progeny, depth-first recursion. */
  int count = 1;
  for (int k = 0; k < 8; k++)
    if (c->progeny[k] != NULL)
      count += cell_pack_tags(c->progeny[k], &tags[count]);

#ifdef SWIFT_DEBUG_CHECKS
430
  if (c->mpi.pcell_size != count) error("Inconsistent tag and pcell count!");
431
432
433
434
435
436
437
438
439
440
441
#endif  // SWIFT_DEBUG_CHECKS

  /* Return the number of packed tags used. */
  return count;

#else
  error("SWIFT was not compiled with MPI support.");
  return 0;
#endif
}

442
443
444
445
446
447
/**
 * @brief Unpack the data of a given cell and its sub-cells.
 *
 * @param pc An array of packed #pcell.
 * @param c The #cell in which to unpack the #pcell.
 * @param s The #space in which the cells are created.
448
449
 * @param with_gravity Are we running with gravity and hence need
 *      to exchange multipoles?
450
451
452
 *
 * @return The number of cells created.
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
453
int cell_unpack(struct pcell *restrict pc, struct cell *restrict c,
454
                struct space *restrict s, const int with_gravity) {
455
456
457
458

#ifdef WITH_MPI

  /* Unpack the current pcell. */
459
460
461
462
463
  c->hydro.h_max = pc->hydro.h_max;
  c->hydro.ti_end_min = pc->hydro.ti_end_min;
  c->hydro.ti_end_max = pc->hydro.ti_end_max;
  c->grav.ti_end_min = pc->grav.ti_end_min;
  c->grav.ti_end_max = pc->grav.ti_end_max;
464
  c->stars.ti_end_min = pc->stars.ti_end_min;
465
466
  c->hydro.ti_old_part = pc->hydro.ti_old_part;
  c->grav.ti_old_part = pc->grav.ti_old_part;
467
468
  c->grav.ti_old_multipole = pc->grav.ti_old_multipole;
  c->hydro.count = pc->hydro.count;
469
470
  c->grav.count = pc->grav.count;
  c->stars.count = pc->stars.count;
471
472
  c->maxdepth = pc->maxdepth;

473
474
475
#ifdef SWIFT_DEBUG_CHECKS
  c->cellID = pc->cellID;
#endif
476

477
  /* Copy the Multipole related information */
Matthieu Schaller's avatar
Matthieu Schaller committed
478
  if (with_gravity) {
479

480
    struct gravity_tensors *mp = c->grav.multipole;
481

482
483
484
485
486
487
488
489
490
    mp->m_pole = pc->grav.m_pole;
    mp->CoM[0] = pc->grav.CoM[0];
    mp->CoM[1] = pc->grav.CoM[1];
    mp->CoM[2] = pc->grav.CoM[2];
    mp->CoM_rebuild[0] = pc->grav.CoM_rebuild[0];
    mp->CoM_rebuild[1] = pc->grav.CoM_rebuild[1];
    mp->CoM_rebuild[2] = pc->grav.CoM_rebuild[2];
    mp->r_max = pc->grav.r_max;
    mp->r_max_rebuild = pc->grav.r_max_rebuild;
491
  }
Matthieu Schaller's avatar
Matthieu Schaller committed
492

493
494
495
496
  /* Number of new cells created. */
  int count = 1;

  /* Fill the progeny recursively, depth-first. */
497
  c->split = 0;
498
499
500
501
  for (int k = 0; k < 8; k++)
    if (pc->progeny[k] >= 0) {
      struct cell *temp;
      space_getcells(s, 1, &temp);
502
      temp->hydro.count = 0;
503
504
      temp->grav.count = 0;
      temp->stars.count = 0;
505
506
507
508
509
510
511
512
513
514
515
516
      temp->loc[0] = c->loc[0];
      temp->loc[1] = c->loc[1];
      temp->loc[2] = c->loc[2];
      temp->width[0] = c->width[0] / 2;
      temp->width[1] = c->width[1] / 2;
      temp->width[2] = c->width[2] / 2;
      temp->dmin = c->dmin / 2;
      if (k & 4) temp->loc[0] += temp->width[0];
      if (k & 2) temp->loc[1] += temp->width[1];
      if (k & 1) temp->loc[2] += temp->width[2];
      temp->depth = c->depth + 1;
      temp->split = 0;
517
      temp->hydro.dx_max_part = 0.f;
518
      temp->hydro.dx_max_sort = 0.f;
Loic Hausammann's avatar
Loic Hausammann committed
519
      temp->stars.dx_max_part = 0.f;
Loic Hausammann's avatar
Loic Hausammann committed
520
      temp->stars.dx_max_sort = 0.f;
521
522
523
524
      temp->nodeID = c->nodeID;
      temp->parent = c;
      c->progeny[k] = temp;
      c->split = 1;
525
      count += cell_unpack(&pc[pc->progeny[k]], temp, s, with_gravity);
526
527
528
    }

  /* Return the total number of unpacked cells. */
529
  c->mpi.pcell_size = count;
530
531
532
533
534
535
536
537
  return count;

#else
  error("SWIFT was not compiled with MPI support.");
  return 0;
#endif
}

538
539
540
541
542
543
544
545
546
547
548
549
550
/**
 * @brief Unpack the tags of a given cell and its sub-cells.
 *
 * @param tags An array of tags.
 * @param c The #cell in which to unpack the tags.
 *
 * @return The number of tags created.
 */
int cell_unpack_tags(const int *tags, struct cell *restrict c) {

#ifdef WITH_MPI

  /* Unpack the current pcell. */
551
  c->mpi.tag = tags[0];
552
553
554
555
556
557
558
559
560
561
562

  /* Number of new cells created. */
  int count = 1;

  /* Fill the progeny recursively, depth-first. */
  for (int k = 0; k < 8; k++)
    if (c->progeny[k] != NULL) {
      count += cell_unpack_tags(&tags[count], c->progeny[k]);
    }

#ifdef SWIFT_DEBUG_CHECKS
563
  if (c->mpi.pcell_size != count) error("Inconsistent tag and pcell count!");
564
565
566
567
568
569
570
571
572
573
574
#endif  // SWIFT_DEBUG_CHECKS

  /* Return the total number of unpacked tags. */
  return count;

#else
  error("SWIFT was not compiled with MPI support.");
  return 0;
#endif
}

575
576
577
578
/**
 * @brief Pack the time information of the given cell and all it's sub-cells.
 *
 * @param c The #cell.
579
 * @param pcells (output) The end-of-timestep information we pack into
580
581
582
 *
 * @return The number of packed cells.
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
583
584
int cell_pack_end_step(struct cell *restrict c,
                       struct pcell_step *restrict pcells) {
585

586
587
#ifdef WITH_MPI

588
  /* Pack this cell's data. */
589
590
591
592
  pcells[0].hydro.ti_end_min = c->hydro.ti_end_min;
  pcells[0].hydro.ti_end_max = c->hydro.ti_end_max;
  pcells[0].grav.ti_end_min = c->grav.ti_end_min;
  pcells[0].grav.ti_end_max = c->grav.ti_end_max;
593
  pcells[0].stars.ti_end_min = c->stars.ti_end_min;
594
  pcells[0].hydro.dx_max_part = c->hydro.dx_max_part;
Loic Hausammann's avatar
Loic Hausammann committed
595
  pcells[0].stars.dx_max_part = c->stars.dx_max_part;
596

597
598
599
600
  /* Fill in the progeny, depth-first recursion. */
  int count = 1;
  for (int k = 0; k < 8; k++)
    if (c->progeny[k] != NULL) {
601
      count += cell_pack_end_step(c->progeny[k], &pcells[count]);
602
603
604
605
    }

  /* Return the number of packed values. */
  return count;
606
607
608
609
610

#else
  error("SWIFT was not compiled with MPI support.");
  return 0;
#endif
611
612
}

613
614
615
616
/**
 * @brief Unpack the time information of a given cell and its sub-cells.
 *
 * @param c The #cell
617
 * @param pcells The end-of-timestep information to unpack
618
619
620
 *
 * @return The number of cells created.
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
621
622
int cell_unpack_end_step(struct cell *restrict c,
                         struct pcell_step *restrict pcells) {
623

624
625
#ifdef WITH_MPI

626
  /* Unpack this cell's data. */
627
628
629
630
  c->hydro.ti_end_min = pcells[0].hydro.ti_end_min;
  c->hydro.ti_end_max = pcells[0].hydro.ti_end_max;
  c->grav.ti_end_min = pcells[0].grav.ti_end_min;
  c->grav.ti_end_max = pcells[0].grav.ti_end_max;
631
  c->stars.ti_end_min = pcells[0].stars.ti_end_min;
632
  c->hydro.dx_max_part = pcells[0].hydro.dx_max_part;
Loic Hausammann's avatar
Loic Hausammann committed
633
  c->stars.dx_max_part = pcells[0].stars.dx_max_part;
634

635
636
637
638
  /* Fill in the progeny, depth-first recursion. */
  int count = 1;
  for (int k = 0; k < 8; k++)
    if (c->progeny[k] != NULL) {
639
      count += cell_unpack_end_step(c->progeny[k], &pcells[count]);
640
641
642
    }

  /* Return the number of packed values. */
643
  return count;
644
645
646
647
648

#else
  error("SWIFT was not compiled with MPI support.");
  return 0;
#endif
649
}
650

651
/**
Matthieu Schaller's avatar
Matthieu Schaller committed
652
653
 * @brief Pack the multipole information of the given cell and all it's
 * sub-cells.
654
655
656
657
658
659
660
 *
 * @param c The #cell.
 * @param pcells (output) The multipole information we pack into
 *
 * @return The number of packed cells.
 */
int cell_pack_multipoles(struct cell *restrict c,
Matthieu Schaller's avatar
Matthieu Schaller committed
661
                         struct gravity_tensors *restrict pcells) {
662
663
664
665

#ifdef WITH_MPI

  /* Pack this cell's data. */
666
  pcells[0] = *c->grav.multipole;
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692

  /* Fill in the progeny, depth-first recursion. */
  int count = 1;
  for (int k = 0; k < 8; k++)
    if (c->progeny[k] != NULL) {
      count += cell_pack_multipoles(c->progeny[k], &pcells[count]);
    }

  /* Return the number of packed values. */
  return count;

#else
  error("SWIFT was not compiled with MPI support.");
  return 0;
#endif
}

/**
 * @brief Unpack the multipole information of a given cell and its sub-cells.
 *
 * @param c The #cell
 * @param pcells The multipole information to unpack
 *
 * @return The number of cells created.
 */
int cell_unpack_multipoles(struct cell *restrict c,
Matthieu Schaller's avatar
Matthieu Schaller committed
693
                           struct gravity_tensors *restrict pcells) {
694
695
696
697

#ifdef WITH_MPI

  /* Unpack this cell's data. */
698
  *c->grav.multipole = pcells[0];
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715

  /* Fill in the progeny, depth-first recursion. */
  int count = 1;
  for (int k = 0; k < 8; k++)
    if (c->progeny[k] != NULL) {
      count += cell_unpack_multipoles(c->progeny[k], &pcells[count]);
    }

  /* Return the number of packed values. */
  return count;

#else
  error("SWIFT was not compiled with MPI support.");
  return 0;
#endif
}

716
/**
717
 * @brief Lock a cell for access to its array of #part and hold its parents.
718
719
 *
 * @param c The #cell.
720
 * @return 0 on success, 1 on failure
721
 */
722
723
724
725
726
int cell_locktree(struct cell *c) {

  TIMER_TIC

  /* First of all, try to lock this cell. */
727
  if (c->hydro.hold || lock_trylock(&c->hydro.lock) != 0) {
728
729
730
731
732
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
733
  if (c->hydro.hold) {
734
735

    /* Unlock this cell. */
736
    if (lock_unlock(&c->hydro.lock) != 0) error("Failed to unlock cell.");
737
738
739
740
741
742
743

    /* Admit defeat. */
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Climb up the tree and lock/hold/unlock. */
Pedro Gonnet's avatar
Pedro Gonnet committed
744
  struct cell *finger;
745
746
747
  for (finger = c->parent; finger != NULL; finger = finger->parent) {

    /* Lock this cell. */
748
    if (lock_trylock(&finger->hydro.lock) != 0) break;
749
750

    /* Increment the hold. */
751
    atomic_inc(&finger->hydro.hold);
752
753

    /* Unlock the cell. */
754
    if (lock_unlock(&finger->hydro.lock) != 0) error("Failed to unlock cell.");
755
756
757
758
759
760
761
762
763
764
765
766
  }

  /* If we reached the top of the tree, we're done. */
  if (finger == NULL) {
    TIMER_TOC(timer_locktree);
    return 0;
  }

  /* Otherwise, we hit a snag. */
  else {

    /* Undo the holds up to finger. */
Pedro Gonnet's avatar
Pedro Gonnet committed
767
768
    for (struct cell *finger2 = c->parent; finger2 != finger;
         finger2 = finger2->parent)
769
      atomic_dec(&finger2->hydro.hold);
770
771

    /* Unlock this cell. */
772
    if (lock_unlock(&c->hydro.lock) != 0) error("Failed to unlock cell.");
773
774
775
776
777
778
779

    /* Admit defeat. */
    TIMER_TOC(timer_locktree);
    return 1;
  }
}

780
781
782
783
784
785
/**
 * @brief Lock a cell for access to its array of #gpart and hold its parents.
 *
 * @param c The #cell.
 * @return 0 on success, 1 on failure
 */
786
787
788
789
790
int cell_glocktree(struct cell *c) {

  TIMER_TIC

  /* First of all, try to lock this cell. */
791
  if (c->grav.phold || lock_trylock(&c->grav.plock) != 0) {
792
793
794
795
796
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
797
  if (c->grav.phold) {
798
799

    /* Unlock this cell. */
800
    if (lock_unlock(&c->grav.plock) != 0) error("Failed to unlock cell.");
801
802
803
804
805
806
807

    /* Admit defeat. */
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Climb up the tree and lock/hold/unlock. */
Pedro Gonnet's avatar
Pedro Gonnet committed
808
  struct cell *finger;
809
810
811
  for (finger = c->parent; finger != NULL; finger = finger->parent) {

    /* Lock this cell. */
812
    if (lock_trylock(&finger->grav.plock) != 0) break;
813
814

    /* Increment the hold. */
815
    atomic_inc(&finger->grav.phold);
816
817

    /* Unlock the cell. */
818
    if (lock_unlock(&finger->grav.plock) != 0) error("Failed to unlock cell.");
819
820
821
822
823
824
825
826
827
828
829
830
  }

  /* If we reached the top of the tree, we're done. */
  if (finger == NULL) {
    TIMER_TOC(timer_locktree);
    return 0;
  }

  /* Otherwise, we hit a snag. */
  else {

    /* Undo the holds up to finger. */
Pedro Gonnet's avatar
Pedro Gonnet committed
831
832
    for (struct cell *finger2 = c->parent; finger2 != finger;
         finger2 = finger2->parent)
833
      atomic_dec(&finger2->grav.phold);
834
835

    /* Unlock this cell. */
836
    if (lock_unlock(&c->grav.plock) != 0) error("Failed to unlock cell.");
837
838
839
840
841
842

    /* Admit defeat. */
    TIMER_TOC(timer_locktree);
    return 1;
  }
}
843

844
845
846
847
848
849
850
851
852
853
854
/**
 * @brief Lock a cell for access to its #multipole and hold its parents.
 *
 * @param c The #cell.
 * @return 0 on success, 1 on failure
 */
int cell_mlocktree(struct cell *c) {

  TIMER_TIC

  /* First of all, try to lock this cell. */
855
  if (c->grav.mhold || lock_trylock(&c->grav.mlock) != 0) {
856
857
858
859
860
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
861
  if (c->grav.mhold) {
862
863

    /* Unlock this cell. */
864
    if (lock_unlock(&c->grav.mlock) != 0) error("Failed to unlock cell.");
865
866
867
868
869
870
871
872
873
874
875

    /* Admit defeat. */
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Climb up the tree and lock/hold/unlock. */
  struct cell *finger;
  for (finger = c->parent; finger != NULL; finger = finger->parent) {

    /* Lock this cell. */
876
    if (lock_trylock(&finger->grav.mlock) != 0) break;
877
878

    /* Increment the hold. */
879
    atomic_inc(&finger->grav.mhold);
880
881

    /* Unlock the cell. */
882
    if (lock_unlock(&finger->grav.mlock) != 0) error("Failed to unlock cell.");
883
884
885
886
887
888
889
890
891
892
893
894
895
896
  }

  /* If we reached the top of the tree, we're done. */
  if (finger == NULL) {
    TIMER_TOC(timer_locktree);
    return 0;
  }

  /* Otherwise, we hit a snag. */
  else {

    /* Undo the holds up to finger. */
    for (struct cell *finger2 = c->parent; finger2 != finger;
         finger2 = finger2->parent)
897
      atomic_dec(&finger2->grav.mhold);
898
899

    /* Unlock this cell. */
900
    if (lock_unlock(&c->grav.mlock) != 0) error("Failed to unlock cell.");
901
902
903
904
905
906
907

    /* Admit defeat. */
    TIMER_TOC(timer_locktree);
    return 1;
  }
}

908
909
910
911
912
913
914
915
916
917
918
/**
 * @brief Lock a cell for access to its array of #spart and hold its parents.
 *
 * @param c The #cell.
 * @return 0 on success, 1 on failure
 */
int cell_slocktree(struct cell *c) {

  TIMER_TIC

  /* First of all, try to lock this cell. */
919
  if (c->stars.hold || lock_trylock(&c->stars.lock) != 0) {
920
921
922
923
924
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
925
  if (c->stars.hold) {
926
927

    /* Unlock this cell. */
928
    if (lock_unlock(&c->stars.lock) != 0) error("Failed to unlock cell.");
929
930
931
932
933
934
935
936
937
938
939

    /* Admit defeat. */
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Climb up the tree and lock/hold/unlock. */
  struct cell *finger;
  for (finger = c->parent; finger != NULL; finger = finger->parent) {

    /* Lock this cell. */
940
    if (lock_trylock(&finger->stars.lock) != 0) break;
941
942

    /* Increment the hold. */
943
    atomic_inc(&finger->stars.hold);
944
945

    /* Unlock the cell. */
946
    if (lock_unlock(&finger->stars.lock) != 0) error("Failed to unlock cell.");
947
948
949
950
951
952
953
954
955
956
957
958
959
960
  }

  /* If we reached the top of the tree, we're done. */
  if (finger == NULL) {
    TIMER_TOC(timer_locktree);
    return 0;
  }

  /* Otherwise, we hit a snag. */
  else {

    /* Undo the holds up to finger. */
    for (struct cell *finger2 = c->parent; finger2 != finger;
         finger2 = finger2->parent)
961
      atomic_dec(&finger2->stars.hold);
962
963

    /* Unlock this cell. */
964
    if (lock_unlock(&c->stars.lock) != 0) error("Failed to unlock cell.");
965
966
967
968
969
970
971

    /* Admit defeat. */
    TIMER_TOC(timer_locktree);
    return 1;
  }
}

972
/**
973
 * @brief Unlock a cell's parents for access to #part array.
974
975
976
 *
 * @param c The #cell.
 */
977
978
979
980
981
void cell_unlocktree(struct cell *c) {

  TIMER_TIC

  /* First of all, try to unlock this cell. */
982
  if (lock_unlock(&c->hydro.lock) != 0) error("Failed to unlock cell.");
983
984

  /* Climb up the tree and unhold the parents. */
Pedro Gonnet's avatar
Pedro Gonnet committed
985
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
986
    atomic_dec(&finger->hydro.hold);
987
988
989
990

  TIMER_TOC(timer_locktree);
}

991
992
993
994
995
/**
 * @brief Unlock a cell's parents for access to #gpart array.
 *
 * @param c The #cell.
 */
996
997
998
999
1000
void cell_gunlocktree(struct cell *c) {

  TIMER_TIC

  /* First of all, try to unlock this cell. */
1001
  if (lock_unlock(&c->grav.plock) != 0) error("Failed to unlock cell.");
1002
1003

  /* Climb up the tree and unhold the parents. */
Pedro Gonnet's avatar
Pedro Gonnet committed
1004
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
1005
    atomic_dec(&finger->grav.phold);
1006
1007
1008
1009

  TIMER_TOC(timer_locktree);
}

1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
/**
 * @brief Unlock a cell's parents for access to its #multipole.
 *
 * @param c The #cell.
 */
void cell_munlocktree(struct cell *c) {

  TIMER_TIC

  /* First of all, try to unlock this cell. */
1020
  if (lock_unlock(&c->grav.mlock) != 0) error("Failed to unlock cell.");
1021
1022
1023

  /* Climb up the tree and unhold the parents. */
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
1024
    atomic_dec(&finger->grav.mhold);
1025
1026
1027
1028

  TIMER_TOC(timer_locktree);
}

1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
/**
 * @brief Unlock a cell's parents for access to #spart array.
 *
 * @param c The #cell.
 */
void cell_sunlocktree(struct cell *c) {

  TIMER_TIC

  /* First of all, try to unlock this cell. */
1039
  if (lock_unlock(&c->stars.lock) != 0) error("Failed to unlock cell.");
1040
1041
1042

  /* Climb up the tree and unhold the parents. */
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
1043
    atomic_dec(&finger->stars.hold);
1044
1045
1046
1047

  TIMER_TOC(timer_locktree);
}

1048
1049
1050
1051
/**
 * @brief Sort the parts into eight bins along the given pivots.
 *
 * @param c The #cell array to be sorted.
1052
 * @param parts_offset Offset of the cell parts array relative to the
1053
 *        space's parts array, i.e. c->hydro.parts - s->parts.
1054
 * @param sparts_offset Offset of the cell sparts array relative to the
1055
1056
 *        space's sparts array, i.e. c->stars.parts - s->stars.parts.
 * @param buff A buffer with at least max(c->hydro.count, c->grav.count)
1057
 * entries, used for sorting indices.
1058
1059
1060
 * @param sbuff A buffer with at least max(c->stars.count, c->grav.count)
 * entries, used for sorting indices for the sparts.
 * @param gbuff A buffer with at least max(c->hydro.count, c->grav.count)
1061
 * entries, used for sorting indices for the gparts.
1062
 */
1063
1064
void cell_split(struct cell *c, ptrdiff_t parts_offset, ptrdiff_t sparts_offset,
                struct cell_buff *buff, struct cell_buff *sbuff,
1065
                struct cell_buff *gbuff) {
1066

1067
1068
  const int count = c->hydro.count, gcount = c->grav.count,
            scount = c->stars.count;
1069
1070
  struct part *parts = c->hydro.parts;
  struct xpart *xparts = c->hydro.xparts;
1071
1072
  struct gpart *gparts = c->grav.parts;
  struct spart *sparts = c->stars.parts;
1073
1074
1075
1076
1077
1078
  const double pivot[3] = {c->loc[0] + c->width[0] / 2,
                           c->loc[1] + c->width[1] / 2,
                           c->loc[2] + c->width[2] / 2};
  int bucket_count[8] = {0, 0, 0, 0, 0, 0, 0, 0};
  int bucket_offset[9];

1079
1080
1081
#ifdef SWIFT_DEBUG_CHECKS
  /* Check that the buffs are OK. */
  for (int k = 0; k < count; k++) {
1082
    if (buff[k].x[0] != parts[k].x[0] || buff[k].x[1] != parts[k].x[1] ||
1083
        buff[k].x[2] != parts[k].x[2])
1084
1085
      error("Inconsistent buff contents.");
  }
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
  for (int k = 0; k < gcount; k++) {
    if (gbuff[k].x[0] != gparts[k].x[0] || gbuff[k].x[1] != gparts[k].x[1] ||
        gbuff[k].x[2] != gparts[k].x[2])
      error("Inconsistent gbuff contents.");
  }
  for (int k = 0; k < scount; k++) {
    if (sbuff[k].x[0] != sparts[k].x[0] || sbuff[k].x[1] != sparts[k].x[1] ||
        sbuff[k].x[2] != sparts[k].x[2])
      error("Inconsistent sbuff contents.");
  }
1096
#endif /* SWIFT_DEBUG_CHECKS */
1097
1098
1099

  /* Fill the buffer with the indices. */
  for (int k = 0; k < count; k++) {
1100
1101
    const int bid = (buff[k].x[0] >= pivot[0]) * 4 +
                    (buff[k].x[1] >= pivot[1]) * 2 + (buff[k].x[2] >= pivot[2]);
1102
    bucket_count[bid]++;
Matthieu Schaller's avatar
Matthieu Schaller committed
1103
    buff[k].ind = bid;
1104
  }
1105

1106
1107
1108
1109
1110
  /* Set the buffer offsets. */
  bucket_offset[0] = 0;
  for (int k = 1; k <= 8; k++) {
    bucket_offset[k] = bucket_offset[k - 1] + bucket_count[k - 1];
    bucket_count[k - 1] = 0;
1111
1112
  }

1113
1114
1115
1116
  /* Run through the buckets, and swap particles to their correct spot. */
  for (int bucket = 0; bucket < 8; bucket++) {
    for (int k = bucket_offset[bucket] + bucket_count[bucket];
         k < bucket_offset[bucket + 1]; k++) {
Matthieu Schaller's avatar
Matthieu Schaller committed
1117
      int bid = buff[k].ind;
1118
1119
1120
      if (bid != bucket) {
        struct part part = parts[k];
        struct xpart xpart = xparts[k];
1121
        struct cell_buff temp_buff = buff[k];
1122
1123
        while (bid != bucket) {
          int j = bucket_offset[bid] + bucket_count[bid]++;
Matthieu Schaller's avatar
Matthieu Schaller committed
1124
          while (buff[j].ind == bid) {
1125
1126
1127
            j++;
            bucket_count[bid]++;
          }
Pedro Gonnet's avatar
Pedro Gonnet committed
1128
1129
          memswap(&parts[j], &part, sizeof(struct part));
          memswap(&xparts[j], &xpart, sizeof(struct xpart));
1130
          memswap(&buff[j], &temp_buff, sizeof(struct cell_buff));
1131
1132
          if (parts[j].gpart)
            parts[j].gpart->id_or_neg_offset = -(j + parts_offset);
1133
          bid = temp_buff.ind;
1134
1135
1136
        }
        parts[k] = part;
        xparts[k] = xpart;
1137
        buff[k] = temp_buff;
1138
1139
        if (parts[k].gpart)
          parts[k].gpart->id_or_neg_offset = -(k + parts_offset);
1140
      }
1141
      bucket_count[bid]++;
1142
1143
1144
1145
    }
  }

  /* Store the counts and offsets. */
Pedro Gonnet's avatar
Pedro Gonnet committed
1146
  for (int k = 0; k < 8; k++) {
1147
    c->progeny[k]->hydro.count = bucket_count[k];
1148
    c->progeny[k]->hydro.count_total = c->progeny[k]->hydro.count;
1149
1150
    c->progeny[k]->hydro.parts = &c->hydro.parts[bucket_offset[k]];
    c->progeny[k]->hydro.xparts = &c->hydro.xparts[bucket_offset[k]];
1151
1152
  }

1153
#ifdef SWIFT_DEBUG_CHECKS
1154
1155
1156
1157
1158
1159
1160
1161
  /* Check that the buffs are OK. */
  for (int k = 1; k < count; k++) {
    if (buff[k].ind < buff[k - 1].ind) error("Buff not sorted.");
    if (buff[k].x[0] != parts[k].x[0] || buff[k].x[1] != parts[k].x[1] ||
        buff[k].x[2] != parts[k].x[2])
      error("Inconsistent buff contents (k=%i).", k);
  }

1162
  /* Verify that _all_ the parts have been assigned to a cell. */
1163
  for (int k = 1; k < 8; k++)
1164
1165
    if (&c->progeny[k - 1]->hydro.parts[c->progeny[k - 1]->hydro.count] !=
        c->progeny[k]->hydro.parts)
1166
      error("Particle sorting failed (internal consistency).");
1167
  if (c->progeny[0]->hydro.parts != c->hydro.parts)
1168
    error("Particle sorting failed (left edge).");
1169
1170
  if (&c->progeny[7]->hydro.parts[c->progeny[7]->hydro.count] !=
      &c->hydro.parts[count])
1171
    error("Particle sorting failed (right edge).");