cell.c 151 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

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

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

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

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

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

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

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

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

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

115
116
117
118
119
120
121
122
123
124
/**
 * @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) {

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

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

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

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

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

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

179
180
#ifdef WITH_MPI

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

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

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

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

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

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

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

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

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

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

#ifdef WITH_MPI

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

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

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

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

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

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

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

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

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

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

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

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

413
414
#ifdef WITH_MPI

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

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

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

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

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

451
452
#ifdef WITH_MPI

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

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

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

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

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

#ifdef WITH_MPI

  /* Pack this cell's data. */
493
  pcells[0] = *c->grav.multipole;
494
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

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

#ifdef WITH_MPI

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

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

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

  TIMER_TIC

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

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

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

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

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

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

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

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

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

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

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

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

  TIMER_TIC

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  TIMER_TIC

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

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

  TIMER_TOC(timer_locktree);
}

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

  TIMER_TIC

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

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

  TIMER_TOC(timer_locktree);
}

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

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

  TIMER_TOC(timer_locktree);
}

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

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

  TIMER_TOC(timer_locktree);
}

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

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

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

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

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

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

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

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

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

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

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
  /* 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));
1077
1078
          if (sparts[j].gpart)
            sparts[j].gpart->id_or_neg_offset = -(j + sparts_offset);
1079
1080
1081
1082
          bid = temp_buff.ind;
        }
        sparts[k] = spart;
        sbuff[k] = temp_buff;
1083
1084
        if (sparts[k].gpart)
          sparts[k].gpart->id_or_neg_offset = -(k + sparts_offset);
1085
1086
1087
1088
1089
1090
1091
      }
      bucket_count[bid]++;
    }
  }

  /* Store the counts and offsets. */
  for (int k = 0; k < 8; k++) {
1092
    c->progeny[k]->stars.count = bucket_count[k];