cell.c 26.9 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 "atomic.h"
51
#include "error.h"
52
#include "gravity.h"
53
#include "hydro.h"
Matthieu Schaller's avatar
Matthieu Schaller committed
54
#include "hydro_properties.h"
55
#include "minmax.h"
56
#include "scheduler.h"
57
58
#include "space.h"
#include "timers.h"
59

60
61
62
/* Global variables. */
int cell_next_tag = 0;

63
64
65
66
67
/**
 * @brief Get the size of the cell subtree.
 *
 * @param c The #cell.
 */
68
int cell_getsize(struct cell *c) {
69

Pedro Gonnet's avatar
Pedro Gonnet committed
70
71
  /* Number of cells in this subtree. */
  int count = 1;
72

73
74
  /* Sum up the progeny if split. */
  if (c->split)
Pedro Gonnet's avatar
Pedro Gonnet committed
75
    for (int k = 0; k < 8; k++)
76
77
78
79
80
81
82
      if (c->progeny[k] != NULL) count += cell_getsize(c->progeny[k]);

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

/**
83
84
85
86
87
88
89
90
 * @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.
 *
 * @return The number of cells created.
 */
91
92
int cell_unpack(struct pcell *pc, struct cell *c, struct space *s) {

93
94
#ifdef WITH_MPI

95
96
  /* Unpack the current pcell. */
  c->h_max = pc->h_max;
97
98
  c->ti_end_min = pc->ti_end_min;
  c->ti_end_max = pc->ti_end_max;
99
  c->count = pc->count;
100
  c->gcount = pc->gcount;
101
  c->tag = pc->tag;
Matthieu Schaller's avatar
Matthieu Schaller committed
102

103
104
  /* Number of new cells created. */
  int count = 1;
105
106

  /* Fill the progeny recursively, depth-first. */
Pedro Gonnet's avatar
Pedro Gonnet committed
107
  for (int k = 0; k < 8; k++)
108
    if (pc->progeny[k] >= 0) {
Pedro Gonnet's avatar
Pedro Gonnet committed
109
      struct cell *temp = space_getcell(s);
110
      temp->count = 0;
111
      temp->gcount = 0;
112
113
114
      temp->loc[0] = c->loc[0];
      temp->loc[1] = c->loc[1];
      temp->loc[2] = c->loc[2];
115
116
117
      temp->width[0] = c->width[0] / 2;
      temp->width[1] = c->width[1] / 2;
      temp->width[2] = c->width[2] / 2;
118
      temp->dmin = c->dmin / 2;
119
120
121
      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];
122
123
      temp->depth = c->depth + 1;
      temp->split = 0;
124
      temp->dx_max = 0.f;
125
126
127
128
129
      temp->nodeID = c->nodeID;
      temp->parent = c;
      c->progeny[k] = temp;
      c->split = 1;
      count += cell_unpack(&pc[pc->progeny[k]], temp, s);
130
131
    }

132
  /* Return the total number of unpacked cells. */
133
  c->pcell_size = count;
134
  return count;
135
136
137
138
139

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

142
/**
143
 * @brief Link the cells recursively to the given #part array.
144
145
146
147
148
149
 *
 * @param c The #cell.
 * @param parts The #part array.
 *
 * @return The number of particles linked.
 */
150
int cell_link_parts(struct cell *c, struct part *parts) {
151

152
153
154
  c->parts = parts;

  /* Fill the progeny recursively, depth-first. */
Pedro Gonnet's avatar
Pedro Gonnet committed
155
156
157
158
  if (c->split) {
    int offset = 0;
    for (int k = 0; k < 8; k++) {
      if (c->progeny[k] != NULL)
159
        offset += cell_link_parts(c->progeny[k], &parts[offset]);
Pedro Gonnet's avatar
Pedro Gonnet committed
160
161
    }
  }
162

163
  /* Return the total number of linked particles. */
164
165
  return c->count;
}
166

167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/**
 * @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) {

  c->gparts = gparts;

  /* 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. */
  return c->gcount;
}

192
193
194
195
196
197
198
199
200
/**
 * @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.
 *
 * @return The number of packed cells.
 */
201
202
int cell_pack(struct cell *c, struct pcell *pc) {

203
204
#ifdef WITH_MPI

205
206
  /* Start by packing the data of the current cell. */
  pc->h_max = c->h_max;
207
208
  pc->ti_end_min = c->ti_end_min;
  pc->ti_end_max = c->ti_end_max;
209
  pc->count = c->count;
210
  pc->gcount = c->gcount;
211
212
213
  c->tag = pc->tag = atomic_inc(&cell_next_tag) % cell_max_tag;

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

  /* Return the number of packed cells used. */
223
224
  c->pcell_size = count;
  return count;
225
226
227
228
229

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

232
233
234
235
236
237
238
239
/**
 * @brief Pack the time information of the given cell and all it's sub-cells.
 *
 * @param c The #cell.
 * @param ti_ends (output) The time information we pack into
 *
 * @return The number of packed cells.
 */
240
241
int cell_pack_ti_ends(struct cell *c, int *ti_ends) {

242
243
#ifdef WITH_MPI

244
245
  /* Pack this cell's data. */
  ti_ends[0] = c->ti_end_min;
246

247
248
249
250
251
252
253
254
255
  /* 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_ti_ends(c->progeny[k], &ti_ends[count]);
    }

  /* Return the number of packed values. */
  return count;
256
257
258
259
260

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

263
264
265
266
/**
 * @brief Unpack the time information of a given cell and its sub-cells.
 *
 * @param c The #cell
267
 * @param ti_ends The time information to unpack
268
269
270
 *
 * @return The number of cells created.
 */
271
272
int cell_unpack_ti_ends(struct cell *c, int *ti_ends) {

273
274
#ifdef WITH_MPI

275
276
  /* Unpack this cell's data. */
  c->ti_end_min = ti_ends[0];
277

278
279
280
281
282
283
284
285
  /* 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_ti_ends(c->progeny[k], &ti_ends[count]);
    }

  /* Return the number of packed values. */
286
  return count;
287
288
289
290
291

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

294
/**
295
 * @brief Lock a cell for access to its array of #part and hold its parents.
296
297
 *
 * @param c The #cell.
298
 * @return 0 on success, 1 on failure
299
 */
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
int cell_locktree(struct cell *c) {

  TIMER_TIC

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

  /* Did somebody hold this cell in the meantime? */
  if (c->hold) {

    /* Unlock this cell. */
    if (lock_unlock(&c->lock) != 0) error("Failed to unlock cell.");

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

  /* Climb up the tree and lock/hold/unlock. */
Pedro Gonnet's avatar
Pedro Gonnet committed
322
  struct cell *finger;
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
  for (finger = c->parent; finger != NULL; finger = finger->parent) {

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

    /* Increment the hold. */
    atomic_inc(&finger->hold);

    /* Unlock the cell. */
    if (lock_unlock(&finger->lock) != 0) error("Failed to unlock cell.");
  }

  /* 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
345
346
    for (struct cell *finger2 = c->parent; finger2 != finger;
         finger2 = finger2->parent)
347
      atomic_dec(&finger2->hold);
348
349
350
351
352
353
354
355
356
357

    /* Unlock this cell. */
    if (lock_unlock(&c->lock) != 0) error("Failed to unlock cell.");

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

358
359
360
361
362
363
/**
 * @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
 */
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
int cell_glocktree(struct cell *c) {

  TIMER_TIC

  /* First of all, try to lock this cell. */
  if (c->ghold || lock_trylock(&c->glock) != 0) {
    TIMER_TOC(timer_locktree);
    return 1;
  }

  /* Did somebody hold this cell in the meantime? */
  if (c->ghold) {

    /* Unlock this cell. */
    if (lock_unlock(&c->glock) != 0) error("Failed to unlock cell.");

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

  /* Climb up the tree and lock/hold/unlock. */
Pedro Gonnet's avatar
Pedro Gonnet committed
386
  struct cell *finger;
387
388
389
390
391
392
  for (finger = c->parent; finger != NULL; finger = finger->parent) {

    /* Lock this cell. */
    if (lock_trylock(&finger->glock) != 0) break;

    /* Increment the hold. */
393
    atomic_inc(&finger->ghold);
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408

    /* Unlock the cell. */
    if (lock_unlock(&finger->glock) != 0) error("Failed to unlock cell.");
  }

  /* 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
409
410
    for (struct cell *finger2 = c->parent; finger2 != finger;
         finger2 = finger2->parent)
411
      atomic_dec(&finger2->ghold);
412
413
414
415
416
417
418
419
420

    /* Unlock this cell. */
    if (lock_unlock(&c->glock) != 0) error("Failed to unlock cell.");

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

422
/**
423
 * @brief Unlock a cell's parents for access to #part array.
424
425
426
 *
 * @param c The #cell.
 */
427
428
429
430
431
432
433
434
void cell_unlocktree(struct cell *c) {

  TIMER_TIC

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

  /* Climb up the tree and unhold the parents. */
Pedro Gonnet's avatar
Pedro Gonnet committed
435
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
436
    atomic_dec(&finger->hold);
437
438
439
440

  TIMER_TOC(timer_locktree);
}

441
442
443
444
445
/**
 * @brief Unlock a cell's parents for access to #gpart array.
 *
 * @param c The #cell.
 */
446
447
448
449
450
451
452
453
void cell_gunlocktree(struct cell *c) {

  TIMER_TIC

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

  /* Climb up the tree and unhold the parents. */
Pedro Gonnet's avatar
Pedro Gonnet committed
454
  for (struct cell *finger = c->parent; finger != NULL; finger = finger->parent)
455
    atomic_dec(&finger->ghold);
456
457
458
459

  TIMER_TOC(timer_locktree);
}

460
461
462
463
/**
 * @brief Sort the parts into eight bins along the given pivots.
 *
 * @param c The #cell array to be sorted.
464
465
 * @param parts_offset Offset of the cell parts array relative to the
 *        space's parts array, i.e. c->parts - s->parts.
466
467
 * @param buff A buffer with at least max(c->count, c->gcount) entries,
 *        used for sorting indices.
468
 */
469
void cell_split(struct cell *c, ptrdiff_t parts_offset, int *buff) {
470

Pedro Gonnet's avatar
Pedro Gonnet committed
471
  const int count = c->count, gcount = c->gcount;
472
473
474
  struct part *parts = c->parts;
  struct xpart *xparts = c->xparts;
  struct gpart *gparts = c->gparts;
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
  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];

  /* If the buff is NULL, allocate it, and remember to free it. */
  const int allocate_buffer = (buff == NULL);
  if (allocate_buffer &&
      (buff = (int *)malloc(sizeof(int) * max(count, gcount))) == NULL)
    error("Failed to allocate temporary indices.");

  /* Fill the buffer with the indices. */
  for (int k = 0; k < count; k++) {
    const int bid = (parts[k].x[0] > pivot[0]) * 4 +
                    (parts[k].x[1] > pivot[1]) * 2 + (parts[k].x[2] > pivot[2]);
    bucket_count[bid]++;
    buff[k] = bid;
493
  }
494

495
496
497
498
499
  /* 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;
500
501
  }

502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
  /* 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 = buff[k];
      if (bid != bucket) {
        struct part part = parts[k];
        struct xpart xpart = xparts[k];
        while (bid != bucket) {
          int j = bucket_offset[bid] + bucket_count[bid]++;
          while (buff[j] == bid) {
            j++;
            bucket_count[bid]++;
          }
          struct part temp_part = parts[j];
          struct xpart temp_xpart = xparts[j];
          int temp_buff = buff[j];
          parts[j] = part;
          xparts[j] = xpart;
          buff[j] = bid;
          part = temp_part;
          xpart = temp_xpart;
          bid = temp_buff;
        }
        parts[k] = part;
        xparts[k] = xpart;
        buff[k] = bid;
529
      }
530
      bucket_count[bid]++;
531
532
533
534
    }
  }

  /* Store the counts and offsets. */
Pedro Gonnet's avatar
Pedro Gonnet committed
535
  for (int k = 0; k < 8; k++) {
536
537
538
    c->progeny[k]->count = bucket_count[k];
    c->progeny[k]->parts = &c->parts[bucket_offset[k]];
    c->progeny[k]->xparts = &c->xparts[bucket_offset[k]];
539
540
541
  }

  /* Re-link the gparts. */
542
  if (count > 0 && gcount > 0) part_relink_gparts(parts, count, parts_offset);
543

544
#ifdef SWIFT_DEBUG_CHECKS
545
  /* Verify that _all_ the parts have been assigned to a cell. */
546
547
548
549
550
551
552
553
  for (int k = 1; k < 8; k++)
    if (&c->progeny[k - 1]->parts[c->progeny[k - 1]->count] !=
        c->progeny[k]->parts)
      error("Particle sorting failed (internal consistency).");
  if (c->progeny[0]->parts != c->parts)
    error("Particle sorting failed (left edge).");
  if (&c->progeny[7]->parts[c->progeny[7]->count] != &c->parts[count])
    error("Particle sorting failed (right edge).");
554
555

  /* Verify a few sub-cells. */
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
  for (int k = 0; k < c->progeny[0]->count; k++)
    if (c->progeny[0]->parts[k].x[0] > pivot[0] ||
        c->progeny[0]->parts[k].x[1] > pivot[1] ||
        c->progeny[0]->parts[k].x[2] > pivot[2])
      error("Sorting failed (progeny=0).");
  for (int k = 0; k < c->progeny[1]->count; k++)
    if (c->progeny[1]->parts[k].x[0] > pivot[0] ||
        c->progeny[1]->parts[k].x[1] > pivot[1] ||
        c->progeny[1]->parts[k].x[2] <= pivot[2])
      error("Sorting failed (progeny=1).");
  for (int k = 0; k < c->progeny[2]->count; k++)
    if (c->progeny[2]->parts[k].x[0] > pivot[0] ||
        c->progeny[2]->parts[k].x[1] <= pivot[1] ||
        c->progeny[2]->parts[k].x[2] > pivot[2])
      error("Sorting failed (progeny=2).");
#endif
572
573

  /* Now do the same song and dance for the gparts. */
574
575
576
577
578
579
580
581
582
  for (int k = 0; k < 8; k++) bucket_count[k] = 0;

  /* Fill the buffer with the indices. */
  for (int k = 0; k < gcount; k++) {
    const int bid = (gparts[k].x[0] > pivot[0]) * 4 +
                    (gparts[k].x[1] > pivot[1]) * 2 +
                    (gparts[k].x[2] > pivot[2]);
    bucket_count[bid]++;
    buff[k] = bid;
583
  }
584
585
586
587
588
589

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

592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
  /* 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 = buff[k];
      if (bid != bucket) {
        struct gpart gpart = gparts[k];
        while (bid != bucket) {
          int j = bucket_offset[bid] + bucket_count[bid]++;
          while (buff[j] == bid) {
            j++;
            bucket_count[bid]++;
          }
          struct gpart temp_gpart = gparts[j];
          int temp_buff = buff[j];
          gparts[j] = gpart;
          buff[j] = bid;
          gpart = temp_gpart;
          bid = temp_buff;
        }
        gparts[k] = gpart;
        buff[k] = bid;
614
      }
615
      bucket_count[bid]++;
616
617
618
619
    }
  }

  /* Store the counts and offsets. */
Pedro Gonnet's avatar
Pedro Gonnet committed
620
  for (int k = 0; k < 8; k++) {
621
622
    c->progeny[k]->gcount = bucket_count[k];
    c->progeny[k]->gparts = &c->gparts[bucket_offset[k]];
623
624
625
  }

  /* Re-link the parts. */
626
627
  if (count > 0 && gcount > 0)
    part_relink_parts(gparts, gcount, parts - parts_offset);
628
}
629

630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
/**
 * @brief Sanitizes the smoothing length values of cells by setting large
 * outliers to more sensible values.
 *
 * We compute the mean and standard deviation of the smoothing lengths in
 * logarithmic space and limit values to mean + 4 sigma.
 *
 * @param c The cell.
 */
void cell_sanitize(struct cell *c) {

  const int count = c->count;
  struct part *parts = c->parts;

  /* First collect some statistics */
  float h_mean = 0.f, h_mean2 = 0.f;
  float h_min = FLT_MAX, h_max = 0.f;
  for (int i = 0; i < count; ++i) {

649
    const float h = logf(parts[i].h);
650
651
652
653
654
655
656
657
    h_mean += h;
    h_mean2 += h * h;
    h_max = max(h_max, h);
    h_min = min(h_min, h);
  }
  h_mean /= count;
  h_mean2 /= count;
  const float h_var = h_mean2 - h_mean * h_mean;
658
  const float h_std = (h_var > 0.f) ? sqrtf(h_var) : 0.1f * h_mean;
659
660

  /* Choose a cut */
661
  const float h_limit = expf(h_mean + 4.f * h_std);
662
663

  /* Be verbose this is not innocuous */
664
665
  message("Cell properties: h_min= %f h_max= %f geometric mean= %f.",
          expf(h_min), expf(h_max), expf(h_mean));
666
667
668

  if (c->h_max > h_limit) {

669
    message("Smoothing lengths will be limited to (mean + 4sigma)= %f.",
670
671
672
673
674
675
            h_limit);

    /* Apply the cut */
    for (int i = 0; i < count; ++i) parts->h = min(parts[i].h, h_limit);

    c->h_max = h_limit;
676
677
678
679

  } else {

    message("Smoothing lengths will not be limited.");
680
681
682
  }
}

683
/**
684
 * @brief Converts hydro quantities to a valid state after the initial density
685
 * calculation
686
687
688
689
690
691
692
 *
 * @param c Cell to act upon
 * @param data Unused parameter
 */
void cell_convert_hydro(struct cell *c, void *data) {

  struct part *p = c->parts;
693
694

  for (int i = 0; i < c->count; ++i) {
695
696
697
698
    hydro_convert_quantities(&p[i]);
  }
}

Matthieu Schaller's avatar
Matthieu Schaller committed
699
700
701
702
703
704
/**
 * @brief Cleans the links in a given cell.
 *
 * @param c Cell to act upon
 * @param data Unused parameter
 */
705
void cell_clean_links(struct cell *c, void *data) {
Matthieu Schaller's avatar
Matthieu Schaller committed
706
  c->density = NULL;
707
  c->gradient = NULL;
Matthieu Schaller's avatar
Matthieu Schaller committed
708
  c->force = NULL;
709
  c->grav = NULL;
Matthieu Schaller's avatar
Matthieu Schaller committed
710
}
711

712
713
714
715
716
717
718
719
720
721
722
723
/**
 * @brief Checks whether the cells are direct neighbours ot not. Both cells have
 * to be of the same size
 *
 * @param ci First #cell.
 * @param cj Second #cell.
 *
 * @todo Deal with periodicity.
 */
int cell_are_neighbours(const struct cell *restrict ci,
                        const struct cell *restrict cj) {

Matthieu Schaller's avatar
Matthieu Schaller committed
724
#ifdef SWIFT_DEBUG_CHECKS
Matthieu Schaller's avatar
Matthieu Schaller committed
725
  if (ci->width[0] != cj->width[0]) error("Cells of different size !");
726
727
728
#endif

  /* Maximum allowed distance */
729
730
  const double min_dist =
      1.2 * ci->width[0]; /* 1.2 accounts for rounding errors */
731
732
733
734
735

  /* (Manhattan) Distance between the cells */
  for (int k = 0; k < 3; k++) {
    const double center_i = ci->loc[k];
    const double center_j = cj->loc[k];
736
    if (fabs(center_i - center_j) > min_dist) return 0;
737
738
739
740
741
  }

  return 1;
}

742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
/**
 * @brief Computes the multi-pole brutally and compare to the
 * recursively computed one.
 *
 * @param c Cell to act upon
 * @param data Unused parameter
 */
void cell_check_multipole(struct cell *c, void *data) {

  struct multipole ma;

  if (c->gcount > 0) {

    /* Brute-force calculation */
    multipole_init(&ma, c->gparts, c->gcount);

    /* Compare with recursive one */
    struct multipole mb = c->multipole;

    if (fabsf(ma.mass - mb.mass) / fabsf(ma.mass + mb.mass) > 1e-5)
      error("Multipole masses are different (%12.15e vs. %12.15e)", ma.mass,
            mb.mass);

    for (int k = 0; k < 3; ++k)
766
      if (fabs(ma.CoM[k] - mb.CoM[k]) / fabs(ma.CoM[k] + mb.CoM[k]) > 1e-5)
767
768
769
        error("Multipole CoM are different (%12.15e vs. %12.15e", ma.CoM[k],
              mb.CoM[k]);

770
#if const_gravity_multipole_order >= 2
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
    if (fabsf(ma.I_xx - mb.I_xx) / fabsf(ma.I_xx + mb.I_xx) > 1e-5 &&
        ma.I_xx > 1e-9)
      error("Multipole I_xx are different (%12.15e vs. %12.15e)", ma.I_xx,
            mb.I_xx);
    if (fabsf(ma.I_yy - mb.I_yy) / fabsf(ma.I_yy + mb.I_yy) > 1e-5 &&
        ma.I_yy > 1e-9)
      error("Multipole I_yy are different (%12.15e vs. %12.15e)", ma.I_yy,
            mb.I_yy);
    if (fabsf(ma.I_zz - mb.I_zz) / fabsf(ma.I_zz + mb.I_zz) > 1e-5 &&
        ma.I_zz > 1e-9)
      error("Multipole I_zz are different (%12.15e vs. %12.15e)", ma.I_zz,
            mb.I_zz);
    if (fabsf(ma.I_xy - mb.I_xy) / fabsf(ma.I_xy + mb.I_xy) > 1e-5 &&
        ma.I_xy > 1e-9)
      error("Multipole I_xy are different (%12.15e vs. %12.15e)", ma.I_xy,
            mb.I_xy);
    if (fabsf(ma.I_xz - mb.I_xz) / fabsf(ma.I_xz + mb.I_xz) > 1e-5 &&
        ma.I_xz > 1e-9)
      error("Multipole I_xz are different (%12.15e vs. %12.15e)", ma.I_xz,
            mb.I_xz);
    if (fabsf(ma.I_yz - mb.I_yz) / fabsf(ma.I_yz + mb.I_yz) > 1e-5 &&
        ma.I_yz > 1e-9)
      error("Multipole I_yz are different (%12.15e vs. %12.15e)", ma.I_yz,
            mb.I_yz);
795
#endif
796
  }
797
798
}

799
/**
800
 * @brief Frees up the memory allocated for this #cell.
801
 *
802
 * @param c The #cell.
803
 */
804
805
806
807
808
809
810
void cell_clean(struct cell *c) {

  free(c->sort);

  /* Recurse */
  for (int k = 0; k < 8; k++)
    if (c->progeny[k]) cell_clean(c->progeny[k]);
811
}
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831

/**
 * @brief Checks whether a given cell needs drifting or not.
 *
 * @param c the #cell.
 * @param ti_current The current time on the integer time-line.
 *
 * @return 1 If the cell needs drifting, 0 otherwise.
 */
int cell_is_drift_needed(struct cell *c, int ti_current) {

  /* Do we have at least one active particle in the cell ?*/
  if (c->ti_end_min == ti_current) return 1;

  /* Loop over the pair tasks that involve this cell */
  for (struct link *l = c->density; l != NULL; l = l->next) {

    if (l->t->type != task_type_pair && l->t->type != task_type_sub_pair)
      continue;

832
    /* Does the other cell in the pair have an active particle ? */
Matthieu Schaller's avatar
Matthieu Schaller committed
833
834
    if ((l->t->ci == c && l->t->cj->ti_end_min == ti_current) ||
        (l->t->cj == c && l->t->ci->ti_end_min == ti_current))
835
      return 1;
836
837
838
839
840
  }

  /* No neighbouring cell has active particles. Drift not necessary */
  return 0;
}
841
842
843
844
845
846

/**
 * @brief Un-skips all the tasks associated with a given cell and checks
 * if the space needs to be rebuilt.
 *
 * @param c the #cell.
Peter W. Draper's avatar
Peter W. Draper committed
847
 * @param s the #scheduler.
848
849
850
 *
 * @return 1 If the space needs rebuilding. 0 otherwise.
 */
851
int cell_unskip_tasks(struct cell *c, struct scheduler *s) {
852
853
854
855
856
857

  /* Un-skip the density tasks involved with this cell. */
  for (struct link *l = c->density; l != NULL; l = l->next) {
    struct task *t = l->t;
    const struct cell *ci = t->ci;
    const struct cell *cj = t->cj;
858
    scheduler_activate(s, t);
859
860
861
862
863

    /* Set the correct sorting flags */
    if (t->type == task_type_pair) {
      if (!(ci->sorted & (1 << t->flags))) {
        atomic_or(&ci->sorts->flags, (1 << t->flags));
864
        scheduler_activate(s, ci->sorts);
865
866
867
      }
      if (!(cj->sorted & (1 << t->flags))) {
        atomic_or(&cj->sorts->flags, (1 << t->flags));
868
        scheduler_activate(s, cj->sorts);
869
870
871
872
873
874
875
876
877
878
879
880
      }
    }

    /* Check whether there was too much particle motion */
    if (t->type == task_type_pair || t->type == task_type_sub_pair) {
      if (t->tight &&
          (max(ci->h_max, cj->h_max) + ci->dx_max + cj->dx_max > cj->dmin ||
           ci->dx_max > space_maxreldx * ci->h_max ||
           cj->dx_max > space_maxreldx * cj->h_max))
        return 1;

#ifdef WITH_MPI
881
      /* Activate the send/recv flags. */
882
      if (ci->nodeID != engine_rank) {
883
884

        /* Activate the tasks to recv foreign cell ci's data. */
885
886
887
        scheduler_activate(s, ci->recv_xv);
        scheduler_activate(s, ci->recv_rho);
        scheduler_activate(s, ci->recv_ti);
888
889
890
891

        /* Look for the local cell cj's send tasks. */
        struct link *l = NULL;
        for (l = cj->send_xv; l != NULL && l->t->cj->nodeID != ci->nodeID;
892
893
             l = l->next)
          ;
894
        if (l == NULL) error("Missing link to send_xv task.");
895
        scheduler_activate(s, l->t);
896
897

        for (l = cj->send_rho; l != NULL && l->t->cj->nodeID != ci->nodeID;
898
899
             l = l->next)
          ;
900
        if (l == NULL) error("Missing link to send_rho task.");
901
        scheduler_activate(s, l->t);
902
903

        for (l = cj->send_ti; l != NULL && l->t->cj->nodeID != ci->nodeID;
904
905
             l = l->next)
          ;
906
        if (l == NULL) error("Missing link to send_ti task.");
907
        scheduler_activate(s, l->t);
908

909
      } else if (cj->nodeID != engine_rank) {
910
911

        /* Activate the tasks to recv foreign cell cj's data. */
912
913
914
        scheduler_activate(s, cj->recv_xv);
        scheduler_activate(s, cj->recv_rho);
        scheduler_activate(s, cj->recv_ti);
915
916
917
        /* Look for the local cell ci's send tasks. */
        struct link *l = NULL;
        for (l = ci->send_xv; l != NULL && l->t->cj->nodeID != cj->nodeID;
918
919
             l = l->next)
          ;
920
        if (l == NULL) error("Missing link to send_xv task.");
921
        scheduler_activate(s, l->t);
922
923

        for (l = ci->send_rho; l != NULL && l->t->cj->nodeID != cj->nodeID;
924
925
             l = l->next)
          ;
926
        if (l == NULL) error("Missing link to send_rho task.");
927
        scheduler_activate(s, l->t);
928
929

        for (l = ci->send_ti; l != NULL && l->t->cj->nodeID != cj->nodeID;
930
931
             l = l->next)
          ;
932
        if (l == NULL) error("Missing link to send_ti task.");
933
        scheduler_activate(s, l->t);
934
935
936
937
938
939
      }
#endif
    }
  }

  /* Unskip all the other task types. */
940
  for (struct link *l = c->gradient; l != NULL; l = l->next)
941
    scheduler_activate(s, l->t);
942
  for (struct link *l = c->force; l != NULL; l = l->next)
943
    scheduler_activate(s, l->t);
944
  for (struct link *l = c->grav; l != NULL; l = l->next)
945
946
947
948
949
950
951
    scheduler_activate(s, l->t);
  if (c->extra_ghost != NULL) scheduler_activate(s, c->extra_ghost);
  if (c->ghost != NULL) scheduler_activate(s, c->ghost);
  if (c->init != NULL) scheduler_activate(s, c->init);
  if (c->kick != NULL) scheduler_activate(s, c->kick);
  if (c->cooling != NULL) scheduler_activate(s, c->cooling);
  if (c->sourceterms != NULL) scheduler_activate(s, c->sourceterms);
952
953
954

  return 0;
}
955

956
957
958
959
960
961
962
963
964
/**
 * @brief Set the super-cell pointers for all cells in a hierarchy.
 *
 * @param c The top-level #cell to play with.
 * @param super Pointer to the deepest cell with tasks in this part of the tree.
 */
void cell_set_super(struct cell *c, struct cell *super) {

  /* Are we in a cell with some kind of self/pair task ? */
965
  if (super == NULL && c->nr_tasks > 0) super = c;
966
967
968
969

  /* Set the super-cell */
  c->super = super;

970
971
  /* Recurse */
  if (c->split)
972
973
974
    for (int k = 0; k < 8; k++)
      if (c->progeny[k] != NULL) cell_set_super(c->progeny[k], super);
}