cell.c 156 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
int depth_0_counter = 0;
int depth_1_counter = 0;
int depth_2_counter = 0;
int depth_3_counter = 0;

77
78
79
80
81
/**
 * @brief Get the size of the cell subtree.
 *
 * @param c The #cell.
 */
82
int cell_getsize(struct cell *c) {
83

Pedro Gonnet's avatar
Pedro Gonnet committed
84
85
  /* Number of cells in this subtree. */
  int count = 1;
86

87
88
  /* Sum up the progeny if split. */
  if (c->split)
Pedro Gonnet's avatar
Pedro Gonnet committed
89
    for (int k = 0; k < 8; k++)
90
91
92
93
94
95
      if (c->progeny[k] != NULL) count += cell_getsize(c->progeny[k]);

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

96
/**
97
 * @brief Link the cells recursively to the given #part array.
98
99
100
101
102
103
 *
 * @param c The #cell.
 * @param parts The #part array.
 *
 * @return The number of particles linked.
 */
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
int cell_link_parts(struct cell *c, struct part *parts) {

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


/**
 * @brief Link the cells recursively to the given #part array.
 *
 * @param c The #cell.
 * @param parts The #part array.
 *
 * @return The number of particles linked.
 */
int cell_link_foreign_parts(struct cell *c, struct part *parts) {
131
132
133
134
135

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

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

140
141
142
143
144
145
146
    /* 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;
147
  }
148

149
  /* Go deeper to find the level where the tasks are */
Pedro Gonnet's avatar
Pedro Gonnet committed
150
  if (c->split) {
151
    int count = 0;
Pedro Gonnet's avatar
Pedro Gonnet committed
152
    for (int k = 0; k < 8; k++) {
153
      if (c->progeny[k] != NULL) {
154
        count += cell_link_foreign_parts(c->progeny[k], parts);
155
      }
Pedro Gonnet's avatar
Pedro Gonnet committed
156
    }
157
    return count;
158
  } else {
159
    return 0;
160
  }
161
}
162

163
164
165
166
167
168
169
170
171
172
/**
 * @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) {

173
  c->grav.parts = gparts;
174
175
176
177
178
179
180
181
182
183
184

  /* 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. */
185
  return c->grav.count;
186
187
}

188
189
190
191
192
193
194
195
196
197
/**
 * @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) {

198
  c->stars.parts = sparts;
199
200
201
202
203
204
205
206
207
208
209

  /* 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. */
210
  return c->stars.count;
211
212
}

213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
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) {
    if (c->depth == 0) ++depth_0_counter;
    if (c->depth == 1) ++depth_1_counter;
    if (c->depth == 2) ++depth_2_counter;
    if (c->depth == 3) ++depth_3_counter;
    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]);
      }
    }
    return count;
  } else {
    return 0;
  }
}

242
243
244
245
246
247
/**
 * @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.
248
249
 * @param with_gravity Are we running with gravity and hence need
 *      to exchange multipoles?
250
251
252
 *
 * @return The number of packed cells.
 */
253
int cell_pack(struct cell *restrict c, struct pcell *restrict pc,
Matthieu Schaller's avatar
Matthieu Schaller committed
254
              const int with_gravity) {
255

256
257
#ifdef WITH_MPI

258
  /* Start by packing the data of the current cell. */
259
260
261
262
263
  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;
264
  pc->stars.ti_end_min = c->stars.ti_end_min;
265
266
  pc->hydro.ti_old_part = c->hydro.ti_old_part;
  pc->grav.ti_old_part = c->grav.ti_old_part;
267
268
  pc->grav.ti_old_multipole = c->grav.ti_old_multipole;
  pc->hydro.count = c->hydro.count;
269
270
  pc->grav.count = c->grav.count;
  pc->stars.count = c->stars.count;
271
  pc->maxdepth = c->maxdepth;
272

273
  /* Copy the Multipole related information */
Matthieu Schaller's avatar
Matthieu Schaller committed
274
  if (with_gravity) {
275
    const struct gravity_tensors *mp = c->grav.multipole;
276

277
278
279
280
281
282
283
284
285
    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;
286
287
  }

288
289
290
#ifdef SWIFT_DEBUG_CHECKS
  pc->cellID = c->cellID;
#endif
291
292

  /* Fill in the progeny, depth-first recursion. */
Pedro Gonnet's avatar
Pedro Gonnet committed
293
294
  int count = 1;
  for (int k = 0; k < 8; k++)
295
296
    if (c->progeny[k] != NULL) {
      pc->progeny[k] = count;
297
      count += cell_pack(c->progeny[k], &pc[count], with_gravity);
298
    } else {
299
      pc->progeny[k] = -1;
300
    }
301
302

  /* Return the number of packed cells used. */
303
  c->mpi.pcell_size = count;
304
  return count;
305
306
307
308
309

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

312
313
314
315
316
317
318
319
320
321
322
323
324
/**
 * @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. */
325
  tags[0] = c->mpi.tag;
326
327
328
329
330
331
332
333

  /* 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
334
  if (c->mpi.pcell_size != count) error("Inconsistent tag and pcell count!");
335
336
337
338
339
340
341
342
343
344
345
#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
}

346
347
348
349
350
351
/**
 * @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.
352
353
 * @param with_gravity Are we running with gravity and hence need
 *      to exchange multipoles?
354
355
356
 *
 * @return The number of cells created.
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
357
int cell_unpack(struct pcell *restrict pc, struct cell *restrict c,
358
                struct space *restrict s, const int with_gravity) {
359
360
361
362

#ifdef WITH_MPI

  /* Unpack the current pcell. */
363
364
365
366
367
  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;
368
  c->stars.ti_end_min = pc->stars.ti_end_min;
369
370
  c->hydro.ti_old_part = pc->hydro.ti_old_part;
  c->grav.ti_old_part = pc->grav.ti_old_part;
371
372
  c->grav.ti_old_multipole = pc->grav.ti_old_multipole;
  c->hydro.count = pc->hydro.count;
373
374
  c->grav.count = pc->grav.count;
  c->stars.count = pc->stars.count;
375
376
  c->maxdepth = pc->maxdepth;

377
378
379
#ifdef SWIFT_DEBUG_CHECKS
  c->cellID = pc->cellID;
#endif
380

381
  /* Copy the Multipole related information */
Matthieu Schaller's avatar
Matthieu Schaller committed
382
  if (with_gravity) {
383

384
    struct gravity_tensors *mp = c->grav.multipole;
385

386
387
388
389
390
391
392
393
394
    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;
395
  }
Matthieu Schaller's avatar
Matthieu Schaller committed
396

397
398
399
400
  /* Number of new cells created. */
  int count = 1;

  /* Fill the progeny recursively, depth-first. */
401
  c->split = 0;
402
403
404
405
  for (int k = 0; k < 8; k++)
    if (pc->progeny[k] >= 0) {
      struct cell *temp;
      space_getcells(s, 1, &temp);
406
      temp->hydro.count = 0;
407
408
      temp->grav.count = 0;
      temp->stars.count = 0;
409
410
411
412
413
414
415
416
417
418
419
420
      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;
421
      temp->hydro.dx_max_part = 0.f;
422
      temp->hydro.dx_max_sort = 0.f;
Loic Hausammann's avatar
Loic Hausammann committed
423
      temp->stars.dx_max_part = 0.f;
Loic Hausammann's avatar
Loic Hausammann committed
424
      temp->stars.dx_max_sort = 0.f;
425
426
427
428
      temp->nodeID = c->nodeID;
      temp->parent = c;
      c->progeny[k] = temp;
      c->split = 1;
429
      count += cell_unpack(&pc[pc->progeny[k]], temp, s, with_gravity);
430
431
432
    }

  /* Return the total number of unpacked cells. */
433
  c->mpi.pcell_size = count;
434
435
436
437
438
439
440
441
  return count;

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

442
443
444
445
446
447
448
449
450
451
452
453
454
/**
 * @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. */
455
  c->mpi.tag = tags[0];
456
457
458
459
460
461
462
463
464
465
466

  /* 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
467
  if (c->mpi.pcell_size != count) error("Inconsistent tag and pcell count!");
468
469
470
471
472
473
474
475
476
477
478
#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
}

479
480
481
482
/**
 * @brief Pack the time information of the given cell and all it's sub-cells.
 *
 * @param c The #cell.
483
 * @param pcells (output) The end-of-timestep information we pack into
484
485
486
 *
 * @return The number of packed cells.
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
487
488
int cell_pack_end_step(struct cell *restrict c,
                       struct pcell_step *restrict pcells) {
489

490
491
#ifdef WITH_MPI

492
  /* Pack this cell's data. */
493
494
495
496
  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;
497
  pcells[0].stars.ti_end_min = c->stars.ti_end_min;
498
  pcells[0].hydro.dx_max_part = c->hydro.dx_max_part;
Loic Hausammann's avatar
Loic Hausammann committed
499
  pcells[0].stars.dx_max_part = c->stars.dx_max_part;
500

501
502
503
504
  /* Fill in the progeny, depth-first recursion. */
  int count = 1;
  for (int k = 0; k < 8; k++)
    if (c->progeny[k] != NULL) {
505
      count += cell_pack_end_step(c->progeny[k], &pcells[count]);
506
507
508
509
    }

  /* Return the number of packed values. */
  return count;
510
511
512
513
514

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

517
518
519
520
/**
 * @brief Unpack the time information of a given cell and its sub-cells.
 *
 * @param c The #cell
521
 * @param pcells The end-of-timestep information to unpack
522
523
524
 *
 * @return The number of cells created.
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
525
526
int cell_unpack_end_step(struct cell *restrict c,
                         struct pcell_step *restrict pcells) {
527

528
529
#ifdef WITH_MPI

530
  /* Unpack this cell's data. */
531
532
533
534
  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;
535
  c->stars.ti_end_min = pcells[0].stars.ti_end_min;
536
  c->hydro.dx_max_part = pcells[0].hydro.dx_max_part;
Loic Hausammann's avatar
Loic Hausammann committed
537
  c->stars.dx_max_part = pcells[0].stars.dx_max_part;
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) {
543
      count += cell_unpack_end_step(c->progeny[k], &pcells[count]);
544
545
546
    }

  /* Return the number of packed values. */
547
  return count;
548
549
550
551
552

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

555
/**
Matthieu Schaller's avatar
Matthieu Schaller committed
556
557
 * @brief Pack the multipole information of the given cell and all it's
 * sub-cells.
558
559
560
561
562
563
564
 *
 * @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
565
                         struct gravity_tensors *restrict pcells) {
566
567
568
569

#ifdef WITH_MPI

  /* Pack this cell's data. */
570
  pcells[0] = *c->grav.multipole;
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596

  /* 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
597
                           struct gravity_tensors *restrict pcells) {
598
599
600
601

#ifdef WITH_MPI

  /* Unpack this cell's data. */
602
  *c->grav.multipole = pcells[0];
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619

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

620
/**
621
 * @brief Lock a cell for access to its array of #part and hold its parents.
622
623
 *
 * @param c The #cell.
624
 * @return 0 on success, 1 on failure
625
 */
626
627
628
629
630
int cell_locktree(struct cell *c) {

  TIMER_TIC

  /* First of all, try to lock this cell. */
631
  if (c->hydro.hold || lock_trylock(&c->hydro.lock) != 0) {
632
633
634
635
636
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
637
  if (c->hydro.hold) {
638
639

    /* Unlock this cell. */
640
    if (lock_unlock(&c->hydro.lock) != 0) error("Failed to unlock cell.");
641
642
643
644
645
646
647

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

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

    /* Lock this cell. */
652
    if (lock_trylock(&finger->hydro.lock) != 0) break;
653
654

    /* Increment the hold. */
655
    atomic_inc(&finger->hydro.hold);
656
657

    /* Unlock the cell. */
658
    if (lock_unlock(&finger->hydro.lock) != 0) error("Failed to unlock cell.");
659
660
661
662
663
664
665
666
667
668
669
670
  }

  /* 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
671
672
    for (struct cell *finger2 = c->parent; finger2 != finger;
         finger2 = finger2->parent)
673
      atomic_dec(&finger2->hydro.hold);
674
675

    /* Unlock this cell. */
676
    if (lock_unlock(&c->hydro.lock) != 0) error("Failed to unlock cell.");
677
678
679
680
681
682
683

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

684
685
686
687
688
689
/**
 * @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
 */
690
691
692
693
694
int cell_glocktree(struct cell *c) {

  TIMER_TIC

  /* First of all, try to lock this cell. */
695
  if (c->grav.phold || lock_trylock(&c->grav.plock) != 0) {
696
697
698
699
700
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
701
  if (c->grav.phold) {
702
703

    /* Unlock this cell. */
704
    if (lock_unlock(&c->grav.plock) != 0) error("Failed to unlock cell.");
705
706
707
708
709
710
711

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

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

    /* Lock this cell. */
716
    if (lock_trylock(&finger->grav.plock) != 0) break;
717
718

    /* Increment the hold. */
719
    atomic_inc(&finger->grav.phold);
720
721

    /* Unlock the cell. */
722
    if (lock_unlock(&finger->grav.plock) != 0) error("Failed to unlock cell.");
723
724
725
726
727
728
729
730
731
732
733
734
  }

  /* 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
735
736
    for (struct cell *finger2 = c->parent; finger2 != finger;
         finger2 = finger2->parent)
737
      atomic_dec(&finger2->grav.phold);
738
739

    /* Unlock this cell. */
740
    if (lock_unlock(&c->grav.plock) != 0) error("Failed to unlock cell.");
741
742
743
744
745
746

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

748
749
750
751
752
753
754
755
756
757
758
/**
 * @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. */
759
  if (c->grav.mhold || lock_trylock(&c->grav.mlock) != 0) {
760
761
762
763
764
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
765
  if (c->grav.mhold) {
766
767

    /* Unlock this cell. */
768
    if (lock_unlock(&c->grav.mlock) != 0) error("Failed to unlock cell.");
769
770
771
772
773
774
775
776
777
778
779

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

    /* Increment the hold. */
783
    atomic_inc(&finger->grav.mhold);
784
785

    /* Unlock the cell. */
786
    if (lock_unlock(&finger->grav.mlock) != 0) error("Failed to unlock cell.");
787
788
789
790
791
792
793
794
795
796
797
798
799
800
  }

  /* 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)
801
      atomic_dec(&finger2->grav.mhold);
802
803

    /* Unlock this cell. */
804
    if (lock_unlock(&c->grav.mlock) != 0) error("Failed to unlock cell.");
805
806
807
808
809
810
811

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

812
813
814
815
816
817
818
819
820
821
822
/**
 * @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. */
823
  if (c->stars.hold || lock_trylock(&c->stars.lock) != 0) {
824
825
826
827
828
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
829
  if (c->stars.hold) {
830
831

    /* Unlock this cell. */
832
    if (lock_unlock(&c->stars.lock) != 0) error("Failed to unlock cell.");
833
834
835
836
837
838
839
840
841
842
843

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

    /* Increment the hold. */
847
    atomic_inc(&finger->stars.hold);
848
849

    /* Unlock the cell. */
850
    if (lock_unlock(&finger->stars.lock) != 0) error("Failed to unlock cell.");
851
852
853
854
855
856
857
858
859
860
861
862
863
864
  }

  /* 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)
865
      atomic_dec(&finger2->stars.hold);
866
867

    /* Unlock this cell. */
868
    if (lock_unlock(&c->stars.lock) != 0) error("Failed to unlock cell.");
869
870
871
872
873
874
875

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

876
/**
877
 * @brief Unlock a cell's parents for access to #part array.
878
879
880
 *
 * @param c The #cell.
 */
881
882
883
884
885
void cell_unlocktree(struct cell *c) {

  TIMER_TIC

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

  /* Climb up the tree and unhold the parents. */
Pedro Gonnet's avatar
Pedro Gonnet committed
889
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
890
    atomic_dec(&finger->hydro.hold);
891
892
893
894

  TIMER_TOC(timer_locktree);
}

895
896
897
898
899
/**
 * @brief Unlock a cell's parents for access to #gpart array.
 *
 * @param c The #cell.
 */
900
901
902
903
904
void cell_gunlocktree(struct cell *c) {

  TIMER_TIC

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

  /* Climb up the tree and unhold the parents. */
Pedro Gonnet's avatar
Pedro Gonnet committed
908
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
909
    atomic_dec(&finger->grav.phold);
910
911
912
913

  TIMER_TOC(timer_locktree);
}

914
915
916
917
918
919
920
921
922
923
/**
 * @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. */
924
  if (lock_unlock(&c->grav.mlock) != 0) error("Failed to unlock cell.");
925
926
927

  /* Climb up the tree and unhold the parents. */
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
928
    atomic_dec(&finger->grav.mhold);
929
930
931
932

  TIMER_TOC(timer_locktree);
}

933
934
935
936
937
938
939
940
941
942
/**
 * @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. */
943
  if (lock_unlock(&c->stars.lock) != 0) error("Failed to unlock cell.");
944
945
946

  /* Climb up the tree and unhold the parents. */
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
947
    atomic_dec(&finger->stars.hold);
948
949
950
951

  TIMER_TOC(timer_locktree);
}

952
953
954
955
/**
 * @brief Sort the parts into eight bins along the given pivots.
 *
 * @param c The #cell array to be sorted.
956
 * @param parts_offset Offset of the cell parts array relative to the
957
 *        space's parts array, i.e. c->hydro.parts - s->parts.
958
 * @param sparts_offset Offset of the cell sparts array relative to the
959
960
 *        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)
961
 * entries, used for sorting indices.
962
963
964
 * @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)
965
 * entries, used for sorting indices for the gparts.
966
 */
967
968
void cell_split(struct cell *c, ptrdiff_t parts_offset, ptrdiff_t sparts_offset,
                struct cell_buff *buff, struct cell_buff *sbuff,
969
                struct cell_buff *gbuff) {
970

971
972
  const int count = c->hydro.count, gcount = c->grav.count,
            scount = c->stars.count;
973
974
  struct part *parts = c->hydro.parts;
  struct xpart *xparts = c->hydro.xparts;
975
976
  struct gpart *gparts = c->grav.parts;
  struct spart *sparts = c->stars.parts;
977
978
979
980
981
982
  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];

983
984
985
#ifdef SWIFT_DEBUG_CHECKS
  /* Check that the buffs are OK. */
  for (int k = 0; k < count; k++) {
986
    if (buff[k].x[0] != parts[k].x[0] || buff[k].x[1] != parts[k].x[1] ||
987
        buff[k].x[2] != parts[k].x[2])
988
989
      error("Inconsistent buff contents.");
  }
990
991
992
993
994
995
996
997
998
999
  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.");
  }
1000
#endif /* SWIFT_DEBUG_CHECKS */
1001
1002
1003

  /* Fill the buffer with the indices. */
  for (int k = 0; k < count; k++) {
1004
1005
    const int bid = (buff[k].x[0] >= pivot[0]) * 4 +
                    (buff[k].x[1] >= pivot[1]) * 2 + (buff[k].x[2] >= pivot[2]);
1006
    bucket_count[bid]++;
Matthieu Schaller's avatar
Matthieu Schaller committed
1007
    buff[k].ind = bid;
1008
  }
1009

1010
1011
1012
1013
1014
  /* 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;
1015
1016
  }

1017
1018
1019
1020
  /* 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
1021
      int bid = buff[k].ind;
1022
1023
1024
      if (bid != bucket) {
        struct part part = parts[k];
        struct xpart xpart = xparts[k];
1025
        struct cell_buff temp_buff = buff[k];
1026
1027
        while (bid != bucket) {
          int j = bucket_offset[bid] + bucket_count[bid]++;
Matthieu Schaller's avatar
Matthieu Schaller committed
1028
          while (buff[j].ind == bid) {
1029
1030
1031
            j++;
            bucket_count[bid]++;
          }
Pedro Gonnet's avatar
Pedro Gonnet committed
1032
1033
          memswap(&parts[j], &part, sizeof(struct part));
          memswap(&xparts[j], &xpart, sizeof(struct xpart));
1034
          memswap(&buff[j], &temp_buff, sizeof(struct cell_buff));
1035
1036
          if (parts[j].gpart)
            parts[j].gpart->id_or_neg_offset = -(j + parts_offset);
1037
          bid = temp_buff.ind;
1038
1039
1040
        }
        parts[k] = part;
        xparts[k] = xpart;
1041
        buff[k] = temp_buff;
1042
1043
        if (parts[k].gpart)
          parts[k].gpart->id_or_neg_offset = -(k + parts_offset);
1044
      }
1045
      bucket_count[bid]++;
1046
1047
1048
1049
    }
  }

  /* Store the counts and offsets. */
Pedro Gonnet's avatar
Pedro Gonnet committed
1050
  for (int k = 0; k < 8; k++) {
1051
    c->progeny[k]->hydro.count = bucket_count[k];
1052
    c->progeny[k]->hydro.count_total = c->progeny[k]->hydro.count;
1053
1054
    c->progeny[k]->hydro.parts = &c->hydro.parts[bucket_offset[k]];
    c->progeny[k]->hydro.xparts = &c->hydro.xparts[bucket_offset[k]];
1055
1056
  }

1057
#ifdef SWIFT_DEBUG_CHECKS
1058
1059
1060
1061
1062
1063
1064
1065
  /* 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);
  }

1066
  /* Verify that _all_ the parts have been assigned to a cell. */
1067
  for (int k = 1; k < 8; k++)
1068
1069
    if (&c->progeny[k - 1]->hydro.parts[c->progeny[k - 1]->hydro.count] !=
        c->progeny[k]->hydro.parts)
1070
      error("Particle sorting failed (internal consistency).");
1071
  if (c->progeny[0]->hydro.parts != c->hydro.parts)
1072
    error("Particle sorting failed (left edge).");
1073
1074
  if (&c->progeny[7]->hydro.parts[c->progeny[7]->hydro.count] !=
      &c->hydro.parts[count])
1075
    error("Particle sorting failed (right edge).");
1076
1077

  /* Verify a few sub-cells. */
1078
1079
1080
1081
  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])
1082
      error("Sorting failed (progeny=0).");
1083
1084
1085
1086
  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])
1087
      error("Sorting failed (progeny=1).");
1088
1089
1090
1091
  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])
1092
      error("Sorting failed (progeny=2).");
1093
1094
1095
1096
  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])
1097
      error("Sorting failed (progeny=3).");
1098
1099
1100
1101
  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])
1102
      error("Sorting failed (progeny=4).");
1103
1104
1105
1106
  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])
1107
      error("Sorting failed (progeny=5).");
1108
1109
1110
1111
  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.</