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

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

/* Some standard headers. */
#include <float.h>
#include <limits.h>
#include <math.h>
31
32
33
34
#include <pthread.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
35

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

233
234
235
236
237
238
239
240
241
242
/**
 * @brief Recurse down foreign cells until reaching one with gravity
 * tasks; then trigger the linking of the #gpart array from that
 * level.
 *
 * @param c The #cell.
 * @param gparts The #gpart array.
 *
 * @return The number of particles linked.
 */
243
244
245
246
247
248
249
250
251
252
int cell_link_foreign_gparts(struct cell *c, struct gpart *gparts) {

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

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

253
    /* Recursively attach the gparts */
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
    const int counts = cell_link_gparts(c, gparts);
#ifdef SWIFT_DEBUG_CHECKS
    if (counts != c->grav.count)
      error("Something is wrong with the foreign counts");
#endif
    return counts;
  }

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

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

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

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

  if (c->split) {
    int count = 0;
    for (int k = 0; k < 8; ++k) {
      if (c->progeny[k] != NULL) {
        count += cell_count_parts_for_tasks(c->progeny[k]);
      }
    }
303
304
305
    return count;
  } else {
    return 0;
306
307
308
  }
}

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

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

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

  if (c->split) {
    int count = 0;
    for (int k = 0; k < 8; ++k) {
      if (c->progeny[k] != NULL) {
        count += cell_count_gparts_for_tasks(c->progeny[k]);
      }
    }
336
337
338
    return count;
  } else {
    return 0;
339
340
341
  }
}

342
343
344
345
346
347
/**
 * @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.
348
349
 * @param with_gravity Are we running with gravity and hence need
 *      to exchange multipoles?
350
351
352
 *
 * @return The number of packed cells.
 */
353
int cell_pack(struct cell *restrict c, struct pcell *restrict pc,
Matthieu Schaller's avatar
Matthieu Schaller committed
354
              const int with_gravity) {
355

356
357
#ifdef WITH_MPI

358
  /* Start by packing the data of the current cell. */
359
360
361
362
363
  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;
364
  pc->stars.ti_end_min = c->stars.ti_end_min;
365
366
  pc->hydro.ti_old_part = c->hydro.ti_old_part;
  pc->grav.ti_old_part = c->grav.ti_old_part;
367
368
  pc->grav.ti_old_multipole = c->grav.ti_old_multipole;
  pc->hydro.count = c->hydro.count;
369
370
  pc->grav.count = c->grav.count;
  pc->stars.count = c->stars.count;
371
  pc->maxdepth = c->maxdepth;
372

373
  /* Copy the Multipole related information */
Matthieu Schaller's avatar
Matthieu Schaller committed
374
  if (with_gravity) {
375
    const struct gravity_tensors *mp = c->grav.multipole;
376

377
378
379
380
381
382
383
384
385
    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;
386
387
  }

388
389
390
#ifdef SWIFT_DEBUG_CHECKS
  pc->cellID = c->cellID;
#endif
391
392

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

  /* Return the number of packed cells used. */
403
  c->mpi.pcell_size = count;
404
  return count;
405
406
407
408
409

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

412
413
414
415
416
417
418
419
420
421
422
423
424
/**
 * @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. */
425
  tags[0] = c->mpi.tag;
426
427
428
429
430
431
432
433

  /* 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
434
  if (c->mpi.pcell_size != count) error("Inconsistent tag and pcell count!");
435
436
437
438
439
440
441
442
443
444
445
#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
}

446
447
448
449
450
451
/**
 * @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.
452
453
 * @param with_gravity Are we running with gravity and hence need
 *      to exchange multipoles?
454
455
456
 *
 * @return The number of cells created.
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
457
int cell_unpack(struct pcell *restrict pc, struct cell *restrict c,
458
                struct space *restrict s, const int with_gravity) {
459
460
461
462

#ifdef WITH_MPI

  /* Unpack the current pcell. */
463
464
465
466
467
  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;
468
  c->stars.ti_end_min = pc->stars.ti_end_min;
469
470
  c->hydro.ti_old_part = pc->hydro.ti_old_part;
  c->grav.ti_old_part = pc->grav.ti_old_part;
471
472
  c->grav.ti_old_multipole = pc->grav.ti_old_multipole;
  c->hydro.count = pc->hydro.count;
473
474
  c->grav.count = pc->grav.count;
  c->stars.count = pc->stars.count;
475
476
  c->maxdepth = pc->maxdepth;

477
478
479
#ifdef SWIFT_DEBUG_CHECKS
  c->cellID = pc->cellID;
#endif
480

481
  /* Copy the Multipole related information */
Matthieu Schaller's avatar
Matthieu Schaller committed
482
  if (with_gravity) {
483

484
    struct gravity_tensors *mp = c->grav.multipole;
485

486
487
488
489
490
491
492
493
494
    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;
495
  }
Matthieu Schaller's avatar
Matthieu Schaller committed
496

497
498
499
500
  /* Number of new cells created. */
  int count = 1;

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

  /* Return the total number of unpacked cells. */
533
  c->mpi.pcell_size = count;
534
535
536
537
538
539
540
541
  return count;

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

542
543
544
545
546
547
548
549
550
551
552
553
554
/**
 * @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. */
555
  c->mpi.tag = tags[0];
556
557
558
559
560
561
562
563
564
565
566

  /* 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
567
  if (c->mpi.pcell_size != count) error("Inconsistent tag and pcell count!");
568
569
570
571
572
573
574
575
576
577
578
#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
}

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

590
591
#ifdef WITH_MPI

592
  /* Pack this cell's data. */
593
594
595
596
  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;
597
  pcells[0].stars.ti_end_min = c->stars.ti_end_min;
598
  pcells[0].hydro.dx_max_part = c->hydro.dx_max_part;
Loic Hausammann's avatar
Loic Hausammann committed
599
  pcells[0].stars.dx_max_part = c->stars.dx_max_part;
600

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

  /* Return the number of packed values. */
  return count;
610
611
612
613
614

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

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

628
629
#ifdef WITH_MPI

630
  /* Unpack this cell's data. */
631
632
633
634
  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;
635
  c->stars.ti_end_min = pcells[0].stars.ti_end_min;
636
  c->hydro.dx_max_part = pcells[0].hydro.dx_max_part;
Loic Hausammann's avatar
Loic Hausammann committed
637
  c->stars.dx_max_part = pcells[0].stars.dx_max_part;
638

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

  /* Return the number of packed values. */
647
  return count;
648
649
650
651
652

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

655
/**
Matthieu Schaller's avatar
Matthieu Schaller committed
656
657
 * @brief Pack the multipole information of the given cell and all it's
 * sub-cells.
658
659
660
661
662
663
664
 *
 * @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
665
                         struct gravity_tensors *restrict pcells) {
666
667
668
669

#ifdef WITH_MPI

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

  /* 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
697
                           struct gravity_tensors *restrict pcells) {
698
699
700
701

#ifdef WITH_MPI

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

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

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

  TIMER_TIC

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

  /* Did somebody hold this cell in the meantime? */
737
  if (c->hydro.hold) {
738
739

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

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

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

    /* Lock this cell. */
752
    if (lock_trylock(&finger->hydro.lock) != 0) break;
753
754

    /* Increment the hold. */
755
    atomic_inc(&finger->hydro.hold);
756
757

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

  /* 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
771
772
    for (struct cell *finger2 = c->parent; finger2 != finger;
         finger2 = finger2->parent)
773
      atomic_dec(&finger2->hydro.hold);
774
775

    /* Unlock this cell. */
776
    if (lock_unlock(&c->hydro.lock) != 0) error("Failed to unlock cell.");
777
778
779
780
781
782
783

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

784
785
786
787
788
789
/**
 * @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
 */
790
791
792
793
794
int cell_glocktree(struct cell *c) {

  TIMER_TIC

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

  /* Did somebody hold this cell in the meantime? */
801
  if (c->grav.phold) {
802
803

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

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

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

    /* Lock this cell. */
816
    if (lock_trylock(&finger->grav.plock) != 0) break;
817
818

    /* Increment the hold. */
819
    atomic_inc(&finger->grav.phold);
820
821

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

  /* 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
835
836
    for (struct cell *finger2 = c->parent; finger2 != finger;
         finger2 = finger2->parent)
837
      atomic_dec(&finger2->grav.phold);
838
839

    /* Unlock this cell. */
840
    if (lock_unlock(&c->grav.plock) != 0) error("Failed to unlock cell.");
841
842
843
844
845
846

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

848
849
850
851
852
853
854
855
856
857
858
/**
 * @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. */
859
  if (c->grav.mhold || lock_trylock(&c->grav.mlock) != 0) {
860
861
862
863
864
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
865
  if (c->grav.mhold) {
866
867

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

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

    /* Increment the hold. */
883
    atomic_inc(&finger->grav.mhold);
884
885

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

  /* 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)
901
      atomic_dec(&finger2->grav.mhold);
902
903

    /* Unlock this cell. */
904
    if (lock_unlock(&c->grav.mlock) != 0) error("Failed to unlock cell.");
905
906
907
908
909
910
911

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

912
913
914
915
916
917
918
919
920
921
922
/**
 * @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. */
923
  if (c->stars.hold || lock_trylock(&c->stars.lock) != 0) {
924
925
926
927
928
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
929
  if (c->stars.hold) {
930
931

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

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

    /* Increment the hold. */
947
    atomic_inc(&finger->stars.hold);
948
949

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

  /* 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)
965
      atomic_dec(&finger2->stars.hold);
966
967

    /* Unlock this cell. */
968
    if (lock_unlock(&c->stars.lock) != 0) error("Failed to unlock cell.");
969
970
971
972
973
974
975

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

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

  TIMER_TIC

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

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

  TIMER_TOC(timer_locktree);
}

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

  TIMER_TIC

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

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

  TIMER_TOC(timer_locktree);
}

1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
/**
 * @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. */
1024
  if (lock_unlock(&c->grav.mlock) != 0) error("Failed to unlock cell.");
1025
1026
1027

  /* Climb up the tree and unhold the parents. */
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
1028
    atomic_dec(&finger->grav.mhold);
1029
1030
1031
1032

  TIMER_TOC(timer_locktree);
}

1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
/**
 * @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. */
1043
  if (lock_unlock(&c->stars.lock) != 0) error("Failed to unlock cell.");
1044
1045
1046

  /* Climb up the tree and unhold the parents. */
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
1047
    atomic_dec(&finger->stars.hold);
1048
1049
1050
1051

  TIMER_TOC(timer_locktree);
}

1052
1053
1054
1055
/**
 * @brief Sort the parts into eight bins along the given pivots.
 *
 * @param c The #cell array to be sorted.
1056
 * @param parts_offset Offset of the cell parts array relative to the
1057
 *        space's parts array, i.e. c->hydro.parts - s->parts.
1058
 * @param sparts_offset Offset of the cell sparts array relative to the
1059
1060
 *        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)
1061
 * entries, used for sorting indices.
1062
1063
1064
 * @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)
1065
 * entries, used for sorting indices for the gparts.
1066
 */
1067
1068
void cell_split(struct cell *c, ptrdiff_t parts_offset, ptrdiff_t sparts_offset,
                struct cell_buff *buff, struct cell_buff *sbuff,
1069
                struct cell_buff *gbuff) {
1070

1071
1072
  const int count = c->hydro.count, gcount = c->grav.count,
            scount = c->stars.count;
1073
1074
  struct part *parts = c->hydro.parts;
  struct xpart *xparts = c->hydro.xparts;
1075
1076
  struct gpart *gparts = c->grav.parts;
  struct spart *sparts = c->stars.parts;
1077
1078
1079
1080
1081
1082
  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];

1083
1084
1085
#ifdef SWIFT_DEBUG_CHECKS
  /* Check that the buffs are OK. */
  for (int k = 0; k < count; k++) {
1086
    if (buff[k].x[0] != parts[k].x[0] || buff[k].x[1] != parts[k].x[1] ||
1087
        buff[k].x[2] != parts[k].x[2])
1088
1089
      error("Inconsistent buff contents.");
  }
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
  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.");
  }
1100
#endif /* SWIFT_DEBUG_CHECKS */
1101
1102
1103

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

1110
1111
1112
1113
1114
  /* 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;
1115
1116
  }

1117
1118
1119
1120
  /* 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
1121
      int bid = buff[k].ind;
1122
1123
1124
      if (bid != bucket) {
        struct part part = parts[k];
        struct xpart xpart = xparts[k];
1125
        struct cell_buff temp_buff = buff[k];
1126
1127
        while (bid != bucket) {
          int j = bucket_offset[bid] + bucket_count[bid]++;
Matthieu Schaller's avatar
Matthieu Schaller committed
1128
          while (buff[j].ind == bid) {
1129
1130
1131
            j++;
            bucket_count[bid]++;
          }
Pedro Gonnet's avatar
Pedro Gonnet committed
1132
1133
          memswap(&parts[j], &part, sizeof(struct part));
          memswap(&xparts[j], &xpart, sizeof(struct xpart));
1134
          memswap(&buff[j], &temp_buff, sizeof(struct cell_buff));
1135
1136
          if (parts[j].gpart)
            parts[j].gpart->id_or_neg_offset = -(j + parts_offset);
1137
          bid = temp_buff.ind;
1138
1139
1140
        }
        parts[k] = part;
        xparts[k] = xpart;
1141
        buff[k] = temp_buff;
1142
1143
        if (parts[k].gpart)
          parts[k].gpart->id_or_neg_offset = -(k + parts_offset);
1144
      }
1145
      bucket_count[bid]++;
1146
1147
1148
1149
    }
  }

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

1157
#ifdef SWIFT_DEBUG_CHECKS
1158
1159
1160
1161
1162
1163
1164
1165
  /* 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);
  }

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