cell.c 154 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
int cell_link_parts(struct cell *c, struct part *parts) {
100

101
  c->hydro.parts = parts;
102
103

  /* Fill the progeny recursively, depth-first. */
Pedro Gonnet's avatar
Pedro Gonnet committed
104
105
106
107
  if (c->split) {
    int offset = 0;
    for (int k = 0; k < 8; k++) {
      if (c->progeny[k] != NULL)
108
        offset += cell_link_parts(c->progeny[k], &parts[offset]);
Pedro Gonnet's avatar
Pedro Gonnet committed
109
110
    }
  }
111

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

116
117
118
119
120
121
122
123
124
125
/**
 * @brief Link the cells recursively to the given #gpart array.
 *
 * @param c The #cell.
 * @param gparts The #gpart array.
 *
 * @return The number of particles linked.
 */
int cell_link_gparts(struct cell *c, struct gpart *gparts) {

126
  c->grav.parts = gparts;
127
128
129
130
131
132
133
134
135
136
137

  /* 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. */
138
  return c->grav.count;
139
140
}

141
142
143
144
145
146
147
148
149
150
/**
 * @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) {

151
  c->stars.parts = sparts;
152
153
154
155
156
157
158
159
160
161
162

  /* 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. */
163
  return c->stars.count;
164
165
}

166
167
168
169
170
171
/**
 * @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.
172
173
 * @param with_gravity Are we running with gravity and hence need
 *      to exchange multipoles?
174
175
176
 *
 * @return The number of packed cells.
 */
177
int cell_pack(struct cell *restrict c, struct pcell *restrict pc,
Matthieu Schaller's avatar
Matthieu Schaller committed
178
              const int with_gravity) {
179

180
181
#ifdef WITH_MPI

182
  /* Start by packing the data of the current cell. */
183
184
185
186
187
  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;
188
  pc->stars.ti_end_min = c->stars.ti_end_min;
189
190
  pc->hydro.ti_old_part = c->hydro.ti_old_part;
  pc->grav.ti_old_part = c->grav.ti_old_part;
191
192
  pc->grav.ti_old_multipole = c->grav.ti_old_multipole;
  pc->hydro.count = c->hydro.count;
193
194
  pc->grav.count = c->grav.count;
  pc->stars.count = c->stars.count;
195
  pc->maxdepth = c->maxdepth;
196

197
  /* Copy the Multipole related information */
Matthieu Schaller's avatar
Matthieu Schaller committed
198
  if (with_gravity) {
199
    const struct gravity_tensors *mp = c->grav.multipole;
200

201
202
203
204
205
206
207
208
209
    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;
210
211
  }

212
213
214
#ifdef SWIFT_DEBUG_CHECKS
  pc->cellID = c->cellID;
#endif
215
216

  /* Fill in the progeny, depth-first recursion. */
Pedro Gonnet's avatar
Pedro Gonnet committed
217
218
  int count = 1;
  for (int k = 0; k < 8; k++)
219
220
    if (c->progeny[k] != NULL) {
      pc->progeny[k] = count;
221
      count += cell_pack(c->progeny[k], &pc[count], with_gravity);
222
    } else {
223
      pc->progeny[k] = -1;
224
    }
225
226

  /* Return the number of packed cells used. */
227
  c->mpi.pcell_size = count;
228
  return count;
229
230
231
232
233

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

236
237
238
239
240
241
242
243
244
245
246
247
248
/**
 * @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. */
249
  tags[0] = c->mpi.tag;
250
251
252
253
254
255
256
257

  /* 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
258
  if (c->mpi.pcell_size != count) error("Inconsistent tag and pcell count!");
259
260
261
262
263
264
265
266
267
268
269
#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
}

270
271
272
273
274
275
/**
 * @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.
276
277
 * @param with_gravity Are we running with gravity and hence need
 *      to exchange multipoles?
278
279
280
 *
 * @return The number of cells created.
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
281
int cell_unpack(struct pcell *restrict pc, struct cell *restrict c,
282
                struct space *restrict s, const int with_gravity) {
283
284
285
286

#ifdef WITH_MPI

  /* Unpack the current pcell. */
287
288
289
290
291
  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;
292
  c->stars.ti_end_min = pc->stars.ti_end_min;
293
294
  c->hydro.ti_old_part = pc->hydro.ti_old_part;
  c->grav.ti_old_part = pc->grav.ti_old_part;
295
296
  c->grav.ti_old_multipole = pc->grav.ti_old_multipole;
  c->hydro.count = pc->hydro.count;
297
298
  c->grav.count = pc->grav.count;
  c->stars.count = pc->stars.count;
299
300
  c->maxdepth = pc->maxdepth;

301
302
303
#ifdef SWIFT_DEBUG_CHECKS
  c->cellID = pc->cellID;
#endif
304

305
  /* Copy the Multipole related information */
Matthieu Schaller's avatar
Matthieu Schaller committed
306
  if (with_gravity) {
307

308
    struct gravity_tensors *mp = c->grav.multipole;
309

310
311
312
313
314
315
316
317
318
    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;
319
  }
Matthieu Schaller's avatar
Matthieu Schaller committed
320

321
322
323
324
  /* Number of new cells created. */
  int count = 1;

  /* Fill the progeny recursively, depth-first. */
325
  c->split = 0;
326
327
328
329
  for (int k = 0; k < 8; k++)
    if (pc->progeny[k] >= 0) {
      struct cell *temp;
      space_getcells(s, 1, &temp);
330
      temp->hydro.count = 0;
331
332
      temp->grav.count = 0;
      temp->stars.count = 0;
333
334
335
336
337
338
339
340
341
342
343
344
      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;
345
      temp->hydro.dx_max_part = 0.f;
346
      temp->hydro.dx_max_sort = 0.f;
Loic Hausammann's avatar
Loic Hausammann committed
347
      temp->stars.dx_max_part = 0.f;
Loic Hausammann's avatar
Loic Hausammann committed
348
      temp->stars.dx_max_sort = 0.f;
349
350
351
352
      temp->nodeID = c->nodeID;
      temp->parent = c;
      c->progeny[k] = temp;
      c->split = 1;
353
      count += cell_unpack(&pc[pc->progeny[k]], temp, s, with_gravity);
354
355
356
    }

  /* Return the total number of unpacked cells. */
357
  c->mpi.pcell_size = count;
358
359
360
361
362
363
364
365
  return count;

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

366
367
368
369
370
371
372
373
374
375
376
377
378
/**
 * @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. */
379
  c->mpi.tag = tags[0];
380
381
382
383
384
385
386
387
388
389
390

  /* 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
391
  if (c->mpi.pcell_size != count) error("Inconsistent tag and pcell count!");
392
393
394
395
396
397
398
399
400
401
402
#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
}

403
404
405
406
/**
 * @brief Pack the time information of the given cell and all it's sub-cells.
 *
 * @param c The #cell.
407
 * @param pcells (output) The end-of-timestep information we pack into
408
409
410
 *
 * @return The number of packed cells.
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
411
412
int cell_pack_end_step(struct cell *restrict c,
                       struct pcell_step *restrict pcells) {
413

414
415
#ifdef WITH_MPI

416
  /* Pack this cell's data. */
417
418
419
420
  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;
421
  pcells[0].stars.ti_end_min = c->stars.ti_end_min;
422
  pcells[0].hydro.dx_max_part = c->hydro.dx_max_part;
Loic Hausammann's avatar
Loic Hausammann committed
423
  pcells[0].stars.dx_max_part = c->stars.dx_max_part;
424

425
426
427
428
  /* Fill in the progeny, depth-first recursion. */
  int count = 1;
  for (int k = 0; k < 8; k++)
    if (c->progeny[k] != NULL) {
429
      count += cell_pack_end_step(c->progeny[k], &pcells[count]);
430
431
432
433
    }

  /* Return the number of packed values. */
  return count;
434
435
436
437
438

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

441
442
443
444
/**
 * @brief Unpack the time information of a given cell and its sub-cells.
 *
 * @param c The #cell
445
 * @param pcells The end-of-timestep information to unpack
446
447
448
 *
 * @return The number of cells created.
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
449
450
int cell_unpack_end_step(struct cell *restrict c,
                         struct pcell_step *restrict pcells) {
451

452
453
#ifdef WITH_MPI

454
  /* Unpack this cell's data. */
455
456
457
458
  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;
459
  c->stars.ti_end_min = pcells[0].stars.ti_end_min;
460
  c->hydro.dx_max_part = pcells[0].hydro.dx_max_part;
Loic Hausammann's avatar
Loic Hausammann committed
461
  c->stars.dx_max_part = pcells[0].stars.dx_max_part;
462

463
464
465
466
  /* Fill in the progeny, depth-first recursion. */
  int count = 1;
  for (int k = 0; k < 8; k++)
    if (c->progeny[k] != NULL) {
467
      count += cell_unpack_end_step(c->progeny[k], &pcells[count]);
468
469
470
    }

  /* Return the number of packed values. */
471
  return count;
472
473
474
475
476

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

479
/**
Matthieu Schaller's avatar
Matthieu Schaller committed
480
481
 * @brief Pack the multipole information of the given cell and all it's
 * sub-cells.
482
483
484
485
486
487
488
 *
 * @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
489
                         struct gravity_tensors *restrict pcells) {
490
491
492
493

#ifdef WITH_MPI

  /* Pack this cell's data. */
494
  pcells[0] = *c->grav.multipole;
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520

  /* 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
521
                           struct gravity_tensors *restrict pcells) {
522
523
524
525

#ifdef WITH_MPI

  /* Unpack this cell's data. */
526
  *c->grav.multipole = pcells[0];
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543

  /* 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
}

544
/**
545
 * @brief Lock a cell for access to its array of #part and hold its parents.
546
547
 *
 * @param c The #cell.
548
 * @return 0 on success, 1 on failure
549
 */
550
551
552
553
554
int cell_locktree(struct cell *c) {

  TIMER_TIC

  /* First of all, try to lock this cell. */
555
  if (c->hydro.hold || lock_trylock(&c->hydro.lock) != 0) {
556
557
558
559
560
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
561
  if (c->hydro.hold) {
562
563

    /* Unlock this cell. */
564
    if (lock_unlock(&c->hydro.lock) != 0) error("Failed to unlock cell.");
565
566
567
568
569
570
571

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

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

    /* Lock this cell. */
576
    if (lock_trylock(&finger->hydro.lock) != 0) break;
577
578

    /* Increment the hold. */
579
    atomic_inc(&finger->hydro.hold);
580
581

    /* Unlock the cell. */
582
    if (lock_unlock(&finger->hydro.lock) != 0) error("Failed to unlock cell.");
583
584
585
586
587
588
589
590
591
592
593
594
  }

  /* 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
595
596
    for (struct cell *finger2 = c->parent; finger2 != finger;
         finger2 = finger2->parent)
597
      atomic_dec(&finger2->hydro.hold);
598
599

    /* Unlock this cell. */
600
    if (lock_unlock(&c->hydro.lock) != 0) error("Failed to unlock cell.");
601
602
603
604
605
606
607

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

608
609
610
611
612
613
/**
 * @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
 */
614
615
616
617
618
int cell_glocktree(struct cell *c) {

  TIMER_TIC

  /* First of all, try to lock this cell. */
619
  if (c->grav.phold || lock_trylock(&c->grav.plock) != 0) {
620
621
622
623
624
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
625
  if (c->grav.phold) {
626
627

    /* Unlock this cell. */
628
    if (lock_unlock(&c->grav.plock) != 0) error("Failed to unlock cell.");
629
630
631
632
633
634
635

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

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

    /* Lock this cell. */
640
    if (lock_trylock(&finger->grav.plock) != 0) break;
641
642

    /* Increment the hold. */
643
    atomic_inc(&finger->grav.phold);
644
645

    /* Unlock the cell. */
646
    if (lock_unlock(&finger->grav.plock) != 0) error("Failed to unlock cell.");
647
648
649
650
651
652
653
654
655
656
657
658
  }

  /* 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
659
660
    for (struct cell *finger2 = c->parent; finger2 != finger;
         finger2 = finger2->parent)
661
      atomic_dec(&finger2->grav.phold);
662
663

    /* Unlock this cell. */
664
    if (lock_unlock(&c->grav.plock) != 0) error("Failed to unlock cell.");
665
666
667
668
669
670

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

672
673
674
675
676
677
678
679
680
681
682
/**
 * @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. */
683
  if (c->grav.mhold || lock_trylock(&c->grav.mlock) != 0) {
684
685
686
687
688
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
689
  if (c->grav.mhold) {
690
691

    /* Unlock this cell. */
692
    if (lock_unlock(&c->grav.mlock) != 0) error("Failed to unlock cell.");
693
694
695
696
697
698
699
700
701
702
703

    /* 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. */
704
    if (lock_trylock(&finger->grav.mlock) != 0) break;
705
706

    /* Increment the hold. */
707
    atomic_inc(&finger->grav.mhold);
708
709

    /* Unlock the cell. */
710
    if (lock_unlock(&finger->grav.mlock) != 0) error("Failed to unlock cell.");
711
712
713
714
715
716
717
718
719
720
721
722
723
724
  }

  /* 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)
725
      atomic_dec(&finger2->grav.mhold);
726
727

    /* Unlock this cell. */
728
    if (lock_unlock(&c->grav.mlock) != 0) error("Failed to unlock cell.");
729
730
731
732
733
734
735

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

736
737
738
739
740
741
742
743
744
745
746
/**
 * @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. */
747
  if (c->stars.hold || lock_trylock(&c->stars.lock) != 0) {
748
749
750
751
752
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
753
  if (c->stars.hold) {
754
755

    /* Unlock this cell. */
756
    if (lock_unlock(&c->stars.lock) != 0) error("Failed to unlock cell.");
757
758
759
760
761
762
763
764
765
766
767

    /* 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. */
768
    if (lock_trylock(&finger->stars.lock) != 0) break;
769
770

    /* Increment the hold. */
771
    atomic_inc(&finger->stars.hold);
772
773

    /* Unlock the cell. */
774
    if (lock_unlock(&finger->stars.lock) != 0) error("Failed to unlock cell.");
775
776
777
778
779
780
781
782
783
784
785
786
787
788
  }

  /* 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)
789
      atomic_dec(&finger2->stars.hold);
790
791

    /* Unlock this cell. */
792
    if (lock_unlock(&c->stars.lock) != 0) error("Failed to unlock cell.");
793
794
795
796
797
798
799

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

800
/**
801
 * @brief Unlock a cell's parents for access to #part array.
802
803
804
 *
 * @param c The #cell.
 */
805
806
807
808
809
void cell_unlocktree(struct cell *c) {

  TIMER_TIC

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

  /* Climb up the tree and unhold the parents. */
Pedro Gonnet's avatar
Pedro Gonnet committed
813
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
814
    atomic_dec(&finger->hydro.hold);
815
816
817
818

  TIMER_TOC(timer_locktree);
}

819
820
821
822
823
/**
 * @brief Unlock a cell's parents for access to #gpart array.
 *
 * @param c The #cell.
 */
824
825
826
827
828
void cell_gunlocktree(struct cell *c) {

  TIMER_TIC

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

  /* Climb up the tree and unhold the parents. */
Pedro Gonnet's avatar
Pedro Gonnet committed
832
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
833
    atomic_dec(&finger->grav.phold);
834
835
836
837

  TIMER_TOC(timer_locktree);
}

838
839
840
841
842
843
844
845
846
847
/**
 * @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. */
848
  if (lock_unlock(&c->grav.mlock) != 0) error("Failed to unlock cell.");
849
850
851

  /* Climb up the tree and unhold the parents. */
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
852
    atomic_dec(&finger->grav.mhold);
853
854
855
856

  TIMER_TOC(timer_locktree);
}

857
858
859
860
861
862
863
864
865
866
/**
 * @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. */
867
  if (lock_unlock(&c->stars.lock) != 0) error("Failed to unlock cell.");
868
869
870

  /* Climb up the tree and unhold the parents. */
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
871
    atomic_dec(&finger->stars.hold);
872
873
874
875

  TIMER_TOC(timer_locktree);
}

876
877
878
879
/**
 * @brief Sort the parts into eight bins along the given pivots.
 *
 * @param c The #cell array to be sorted.
880
 * @param parts_offset Offset of the cell parts array relative to the
881
 *        space's parts array, i.e. c->hydro.parts - s->parts.
882
 * @param sparts_offset Offset of the cell sparts array relative to the
883
884
 *        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)
885
 * entries, used for sorting indices.
886
887
888
 * @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)
889
 * entries, used for sorting indices for the gparts.
890
 */
891
892
void cell_split(struct cell *c, ptrdiff_t parts_offset, ptrdiff_t sparts_offset,
                struct cell_buff *buff, struct cell_buff *sbuff,
893
                struct cell_buff *gbuff) {
894

895
896
  const int count = c->hydro.count, gcount = c->grav.count,
            scount = c->stars.count;
897
898
  struct part *parts = c->hydro.parts;
  struct xpart *xparts = c->hydro.xparts;
899
900
  struct gpart *gparts = c->grav.parts;
  struct spart *sparts = c->stars.parts;
901
902
903
904
905
906
  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];

907
908
909
#ifdef SWIFT_DEBUG_CHECKS
  /* Check that the buffs are OK. */
  for (int k = 0; k < count; k++) {
910
    if (buff[k].x[0] != parts[k].x[0] || buff[k].x[1] != parts[k].x[1] ||
911
        buff[k].x[2] != parts[k].x[2])
912
913
      error("Inconsistent buff contents.");
  }
914
915
916
917
918
919
920
921
922
923
  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.");
  }
924
#endif /* SWIFT_DEBUG_CHECKS */
925
926
927

  /* Fill the buffer with the indices. */
  for (int k = 0; k < count; k++) {
928
929
    const int bid = (buff[k].x[0] >= pivot[0]) * 4 +
                    (buff[k].x[1] >= pivot[1]) * 2 + (buff[k].x[2] >= pivot[2]);
930
    bucket_count[bid]++;
Matthieu Schaller's avatar
Matthieu Schaller committed
931
    buff[k].ind = bid;
932
  }
933

934
935
936
937
938
  /* 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;
939
940
  }

941
942
943
944
  /* 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
945
      int bid = buff[k].ind;
946
947
948
      if (bid != bucket) {
        struct part part = parts[k];
        struct xpart xpart = xparts[k];
949
        struct cell_buff temp_buff = buff[k];
950
951
        while (bid != bucket) {
          int j = bucket_offset[bid] + bucket_count[bid]++;
Matthieu Schaller's avatar
Matthieu Schaller committed
952
          while (buff[j].ind == bid) {
953
954
955
            j++;
            bucket_count[bid]++;
          }
Pedro Gonnet's avatar
Pedro Gonnet committed
956
957
          memswap(&parts[j], &part, sizeof(struct part));
          memswap(&xparts[j], &xpart, sizeof(struct xpart));
958
          memswap(&buff[j], &temp_buff, sizeof(struct cell_buff));
959
960
          if (parts[j].gpart)
            parts[j].gpart->id_or_neg_offset = -(j + parts_offset);
961
          bid = temp_buff.ind;
962
963
964
        }
        parts[k] = part;
        xparts[k] = xpart;
965
        buff[k] = temp_buff;
966
967
        if (parts[k].gpart)
          parts[k].gpart->id_or_neg_offset = -(k + parts_offset);
968
      }
969
      bucket_count[bid]++;
970
971
972
973
    }
  }

  /* Store the counts and offsets. */
Pedro Gonnet's avatar
Pedro Gonnet committed
974
  for (int k = 0; k < 8; k++) {
975
    c->progeny[k]->hydro.count = bucket_count[k];
976
    c->progeny[k]->hydro.count_total = c->progeny[k]->hydro.count;
977
978
    c->progeny[k]->hydro.parts = &c->hydro.parts[bucket_offset[k]];
    c->progeny[k]->hydro.xparts = &c->hydro.xparts[bucket_offset[k]];
979
980
  }

981
#ifdef SWIFT_DEBUG_CHECKS
982
983
984
985
986
987
988
989
  /* 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);
  }

990
  /* Verify that _all_ the parts have been assigned to a cell. */
991
  for (int k = 1; k < 8; k++)
992
993
    if (&c->progeny[k - 1]->hydro.parts[c->progeny[k - 1]->hydro.count] !=
        c->progeny[k]->hydro.parts)
994
      error("Particle sorting failed (internal consistency).");
995
  if (c->progeny[0]->hydro.parts != c->hydro.parts)
996
    error("Particle sorting failed (left edge).");
997
998
  if (&c->progeny[7]->hydro.parts[c->progeny[7]->hydro.count] !=
      &c->hydro.parts[count])
999
    error("Particle sorting failed (right edge).");
1000
1001

  /* Verify a few sub-cells. */
1002
1003
1004
1005
  for (int k = 0; k < c->progeny[0]->hydro.count; k++)
    if (c->progeny[0]->hydro.parts[k].x[0] >= pivot[0] ||
        c->progeny[0]->hydro.parts[k].x[1] >= pivot[1] ||
        c->progeny[0]->hydro.parts[k].x[2] >= pivot[2])
1006
      error("Sorting failed (progeny=0).");
1007
1008
1009
1010
  for (int k = 0; k < c->progeny[1]->hydro.count; k++)
    if (c->progeny[1]->hydro.parts[k].x[0] >= pivot[0] ||
        c->progeny[1]->hydro.parts[k].x[1] >= pivot[1] ||
        c->progeny[1]->hydro.parts[k].x[2] < pivot[2])
1011
      error("Sorting failed (progeny=1).");
1012
1013
1014
1015
  for (int k = 0; k < c->progeny[2]->hydro.count; k++)
    if (c->progeny[2]->hydro.parts[k].x[0] >= pivot[0] ||
        c->progeny[2]->hydro.parts[k].x[1] < pivot[1] ||
        c->progeny[2]->hydro.parts[k].x[2] >= pivot[2])
1016
      error("Sorting failed (progeny=2).");
1017
1018
1019
1020
  for (int k = 0; k < c->progeny[3]->hydro.count; k++)
    if (c->progeny[3]->hydro.parts[k].x[0] >= pivot[0] ||
        c->progeny[3]->hydro.parts[k].x[1] < pivot[1] ||
        c->progeny[3]->hydro.parts[k].x[2] < pivot[2])
1021
      error("Sorting failed (progeny=3).");
1022
1023
1024
1025
  for (int k = 0; k < c->progeny[4]->hydro.count; k++)
    if (c->progeny[4]->hydro.parts[k].x[0] < pivot[0] ||
        c->progeny[4]->hydro.parts[k].x[1] >= pivot[1] ||
        c->progeny[4]->hydro.parts[k].x[2] >= pivot[2])
1026
      error("Sorting failed (progeny=4).");
1027
1028
1029
1030
  for (int k = 0; k < c->progeny[5]->hydro.count; k++)
    if (c->progeny[5]->hydro.parts[k].x[0] < pivot[0] ||
        c->progeny[5]->hydro.parts[k].x[1] >= pivot[1] ||
        c->progeny[5]->hydro.parts[k].x[2] < pivot[2])
1031
      error("Sorting failed (progeny=5).");
1032
1033
1034
1035
  for (int k = 0; k < c->progeny[6]->hydro.count; k++)
    if (c->progeny[6]->hydro.parts[k].x[0] < pivot[0] ||
        c->progeny[6]->hydro.parts[k].x[1] < pivot[1] ||
        c->progeny[6]->hydro.parts[k].x[2] >= pivot[2])
1036
      error("Sorting failed (progeny=6).");
1037
1038
1039
1040
  for (int k = 0; k < c->progeny[7]->hydro.count; k++)
    if (c->progeny[7]->hydro.parts[k].x[0] < pivot[0] ||
        c->progeny[7]->hydro.parts[k].x[1] < pivot[1] ||
        c->progeny[7]->hydro.parts[k].x[2] < pivot[2])
1041
      error("Sorting failed (progeny=7).");
1042
#endif
1043

1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
  /* Now do the same song and dance for the sparts. */
  for (int k = 0; k < 8; k++) bucket_count[k] = 0;

  /* Fill the buffer with the indices. */
  for (int k = 0; k < scount; k++) {
    const int bid = (sbuff[k].x[0] > pivot[0]) * 4 +
                    (sbuff[k].x[1] > pivot[1]) * 2 + (sbuff[k].x[2] > pivot[2]);
    bucket_count[bid]++;
    sbuff[k].ind = bid;
  }

  /* 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;
  }

  /* 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++) {
      int bid = sbuff[k].ind;
      if (bid != bucket) {
        struct spart spart = sparts[k];
        struct cell_buff temp_buff = sbuff[k];
        while (bid != bucket) {
          int j = bucket_offset[bid] + bucket_count[bid]++;
          while (sbuff[j].ind == bid) {
            j++;
            bucket_count[bid]++;
          }
          memswap(&sparts[j], &spart, sizeof(struct spart));
          memswap(&sbuff[j], &temp_buff, sizeof(struct cell_buff));
1078
1079
          if (sparts[j].gpart)
            sparts[j].gpart->id_or_neg_offset = -(j + sparts_offset);
1080
1081
1082
1083
          bid = temp_buff.ind;
        }
        sparts[k] = spart;
        sbuff[k] = temp_buff;
1084
1085
        if (sparts[k].gpart)
          sparts[k].gpart->id_or_neg_offset = -(k + sparts_offset);
1086
1087
1088
1089
1090
1091
1092
      }
      bucket_count[bid]++;
    }
  }

  /* Store the counts and offsets. */
  for (int k = 0; k < 8; k++) {
1093