runner.c 60 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
 ******************************************************************************/
Pedro Gonnet's avatar
Pedro Gonnet committed
23

Pedro Gonnet's avatar
Pedro Gonnet committed
24
25
/* Config parameters. */
#include "../config.h"
Pedro Gonnet's avatar
Pedro Gonnet committed
26
27
28
29

/* Some standard headers. */
#include <float.h>
#include <limits.h>
30
#include <stdlib.h>
Pedro Gonnet's avatar
Pedro Gonnet committed
31

32
33
/* MPI headers. */
#ifdef WITH_MPI
34
#include <mpi.h>
35
36
#endif

37
38
39
/* This object's header. */
#include "runner.h"

Pedro Gonnet's avatar
Pedro Gonnet committed
40
/* Local headers. */
41
#include "active.h"
Matthieu Schaller's avatar
Matthieu Schaller committed
42
#include "approx_math.h"
43
#include "atomic.h"
44
#include "cell.h"
45
#include "const.h"
Stefan Arridge's avatar
Stefan Arridge committed
46
#include "cooling.h"
47
#include "debug.h"
Matthieu Schaller's avatar
Matthieu Schaller committed
48
#include "drift.h"
Pedro Gonnet's avatar
Pedro Gonnet committed
49
#include "engine.h"
50
#include "error.h"
51
52
#include "gravity.h"
#include "hydro.h"
Matthieu Schaller's avatar
Matthieu Schaller committed
53
#include "hydro_properties.h"
54
#include "kick.h"
55
#include "minmax.h"
56
#include "runner_doiact_fft.h"
James Willis's avatar
James Willis committed
57
#include "runner_doiact_vec.h"
58
#include "scheduler.h"
59
#include "sort_part.h"
60
#include "sourceterms.h"
61
#include "space.h"
62
#include "stars.h"
63
64
#include "task.h"
#include "timers.h"
65
#include "timestep.h"
Pedro Gonnet's avatar
Pedro Gonnet committed
66

67
68
69
70
#define TASK_LOOP_DENSITY 0
#define TASK_LOOP_GRADIENT 1
#define TASK_LOOP_FORCE 2
#define TASK_LOOP_LIMITER 3
71

72
/* Import the density loop functions. */
73
#define FUNCTION density
74
#define FUNCTION_TASK_LOOP TASK_LOOP_DENSITY
75
#include "runner_doiact.h"
76
77
#undef FUNCTION
#undef FUNCTION_TASK_LOOP
78

79
/* Import the gradient loop functions (if required). */
80
81
#ifdef EXTRA_HYDRO_LOOP
#define FUNCTION gradient
82
#define FUNCTION_TASK_LOOP TASK_LOOP_GRADIENT
83
#include "runner_doiact.h"
84
85
#undef FUNCTION
#undef FUNCTION_TASK_LOOP
86
87
#endif

88
/* Import the force loop functions. */
89
#define FUNCTION force
90
#define FUNCTION_TASK_LOOP TASK_LOOP_FORCE
91
#include "runner_doiact.h"
92
93
#undef FUNCTION
#undef FUNCTION_TASK_LOOP
94

95
/* Import the gravity loop functions. */
96
#include "runner_doiact_fft.h"
97
#include "runner_doiact_grav.h"
98

Tom Theuns's avatar
Tom Theuns committed
99
/**
Tom Theuns's avatar
Tom Theuns committed
100
 * @brief Perform source terms
Tom Theuns's avatar
Tom Theuns committed
101
102
103
104
105
106
107
 *
 * @param r runner task
 * @param c cell
 * @param timer 1 if the time is to be recorded.
 */
void runner_do_sourceterms(struct runner *r, struct cell *c, int timer) {
  const int count = c->count;
108
  const double cell_min[3] = {c->loc[0], c->loc[1], c->loc[2]};
Tom Theuns's avatar
Tom Theuns committed
109
  const double cell_width[3] = {c->width[0], c->width[1], c->width[2]};
Tom Theuns's avatar
Tom Theuns committed
110
  struct sourceterms *sourceterms = r->e->sourceterms;
111
  const int dimen = 3;
Tom Theuns's avatar
Tom Theuns committed
112
113
114
115
116
117
118

  TIMER_TIC;

  /* Recurse? */
  if (c->split) {
    for (int k = 0; k < 8; k++)
      if (c->progeny[k] != NULL) runner_do_sourceterms(r, c->progeny[k], 0);
119
  } else {
Tom Theuns's avatar
Tom Theuns committed
120

121
    if (count > 0) {
Tom Theuns's avatar
Tom Theuns committed
122

123
124
125
126
127
128
      /* do sourceterms in this cell? */
      const int incell =
          sourceterms_test_cell(cell_min, cell_width, sourceterms, dimen);
      if (incell == 1) {
        sourceterms_apply(r, sourceterms, c);
      }
Tom Theuns's avatar
Tom Theuns committed
129
130
    }
  }
Tom Theuns's avatar
Tom Theuns committed
131
132
133
134

  if (timer) TIMER_TOC(timer_dosource);
}

Tom Theuns's avatar
Tom Theuns committed
135
136
137
/**
 * @brief Calculate gravity acceleration from external potential
 *
Matthieu Schaller's avatar
Matthieu Schaller committed
138
139
140
 * @param r runner task
 * @param c cell
 * @param timer 1 if the time is to be recorded.
Tom Theuns's avatar
Tom Theuns committed
141
 */
142
void runner_do_grav_external(struct runner *r, struct cell *c, int timer) {
Tom Theuns's avatar
Tom Theuns committed
143

Matthieu Schaller's avatar
Matthieu Schaller committed
144
145
  struct gpart *restrict gparts = c->gparts;
  const int gcount = c->gcount;
146
147
148
  const struct engine *e = r->e;
  const struct external_potential *potential = e->external_potential;
  const struct phys_const *constants = e->physical_constants;
149
  const double time = r->e->time;
Matthieu Schaller's avatar
Matthieu Schaller committed
150

151
  TIMER_TIC;
Tom Theuns's avatar
Tom Theuns committed
152

153
  /* Anything to do here? */
154
  if (!cell_is_active_gravity(c, e)) return;
155

Tom Theuns's avatar
Tom Theuns committed
156
157
  /* Recurse? */
  if (c->split) {
Matthieu Schaller's avatar
Matthieu Schaller committed
158
    for (int k = 0; k < 8; k++)
159
      if (c->progeny[k] != NULL) runner_do_grav_external(r, c->progeny[k], 0);
160
  } else {
161

162
163
    /* Loop over the gparts in this cell. */
    for (int i = 0; i < gcount; i++) {
164

165
166
      /* Get a direct pointer on the part. */
      struct gpart *restrict gp = &gparts[i];
Matthieu Schaller's avatar
Matthieu Schaller committed
167

168
      /* Is this part within the time step? */
169
      if (gpart_is_active(gp, e)) {
170
171
        external_gravity_acceleration(time, potential, constants, gp);
      }
172
    }
173
  }
Matthieu Schaller's avatar
Matthieu Schaller committed
174

175
  if (timer) TIMER_TOC(timer_dograv_external);
Tom Theuns's avatar
Tom Theuns committed
176
177
}

Stefan Arridge's avatar
Stefan Arridge committed
178
/**
179
180
 * @brief Calculate change in thermal state of particles induced
 * by radiative cooling and heating.
Stefan Arridge's avatar
Stefan Arridge committed
181
182
183
184
185
186
187
188
 *
 * @param r runner task
 * @param c cell
 * @param timer 1 if the time is to be recorded.
 */
void runner_do_cooling(struct runner *r, struct cell *c, int timer) {

  struct part *restrict parts = c->parts;
189
  struct xpart *restrict xparts = c->xparts;
Stefan Arridge's avatar
Stefan Arridge committed
190
  const int count = c->count;
191
192
193
  const struct engine *e = r->e;
  const struct cooling_function_data *cooling_func = e->cooling_func;
  const struct phys_const *constants = e->physical_constants;
194
  const struct unit_system *us = e->internal_units;
195
  const double timeBase = e->timeBase;
Stefan Arridge's avatar
Stefan Arridge committed
196
197
198

  TIMER_TIC;

199
  /* Anything to do here? */
200
  if (!cell_is_active_hydro(c, e)) return;
201

Stefan Arridge's avatar
Stefan Arridge committed
202
203
204
205
  /* Recurse? */
  if (c->split) {
    for (int k = 0; k < 8; k++)
      if (c->progeny[k] != NULL) runner_do_cooling(r, c->progeny[k], 0);
206
  } else {
Stefan Arridge's avatar
Stefan Arridge committed
207

208
209
    /* Loop over the parts in this cell. */
    for (int i = 0; i < count; i++) {
Stefan Arridge's avatar
Stefan Arridge committed
210

211
212
213
      /* Get a direct pointer on the part. */
      struct part *restrict p = &parts[i];
      struct xpart *restrict xp = &xparts[i];
Stefan Arridge's avatar
Stefan Arridge committed
214

215
      if (part_is_active(p, e)) {
216

217
218
        /* Let's cool ! */
        const double dt = get_timestep(p->time_bin, timeBase);
219
220
        cooling_cool_part(constants, us, cooling_func, p, xp, dt);
      }
Stefan Arridge's avatar
Stefan Arridge committed
221
222
223
224
225
226
    }
  }

  if (timer) TIMER_TOC(timer_do_cooling);
}

Pedro Gonnet's avatar
Pedro Gonnet committed
227
228
229
230
231
232
/**
 * @brief Sort the entries in ascending order using QuickSort.
 *
 * @param sort The entries
 * @param N The number of entries.
 */
233
void runner_do_sort_ascending(struct entry *sort, int N) {
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287

  struct {
    short int lo, hi;
  } qstack[10];
  int qpos, i, j, lo, hi, imin;
  struct entry temp;
  float pivot;

  /* Sort parts in cell_i in decreasing order with quicksort */
  qstack[0].lo = 0;
  qstack[0].hi = N - 1;
  qpos = 0;
  while (qpos >= 0) {
    lo = qstack[qpos].lo;
    hi = qstack[qpos].hi;
    qpos -= 1;
    if (hi - lo < 15) {
      for (i = lo; i < hi; i++) {
        imin = i;
        for (j = i + 1; j <= hi; j++)
          if (sort[j].d < sort[imin].d) imin = j;
        if (imin != i) {
          temp = sort[imin];
          sort[imin] = sort[i];
          sort[i] = temp;
        }
      }
    } else {
      pivot = sort[(lo + hi) / 2].d;
      i = lo;
      j = hi;
      while (i <= j) {
        while (sort[i].d < pivot) i++;
        while (sort[j].d > pivot) j--;
        if (i <= j) {
          if (i < j) {
            temp = sort[i];
            sort[i] = sort[j];
            sort[j] = temp;
          }
          i += 1;
          j -= 1;
        }
      }
      if (j > (lo + hi) / 2) {
        if (lo < j) {
          qpos += 1;
          qstack[qpos].lo = lo;
          qstack[qpos].hi = j;
        }
        if (i < hi) {
          qpos += 1;
          qstack[qpos].lo = i;
          qstack[qpos].hi = hi;
Pedro Gonnet's avatar
Pedro Gonnet committed
288
        }
289
290
291
292
293
294
295
296
297
298
299
300
      } else {
        if (i < hi) {
          qpos += 1;
          qstack[qpos].lo = i;
          qstack[qpos].hi = hi;
        }
        if (lo < j) {
          qpos += 1;
          qstack[qpos].lo = lo;
          qstack[qpos].hi = j;
        }
      }
Pedro Gonnet's avatar
Pedro Gonnet committed
301
    }
302
303
304
  }
}

Matthieu Schaller's avatar
Matthieu Schaller committed
305
306
307
308
309
310
311
312
/**
 * @brief Recursively checks that the flags are consistent in a cell hierarchy.
 *
 * Debugging function.
 *
 * @param c The #cell to check.
 * @param flags The sorting flags to check.
 */
313
void runner_check_sorts(struct cell *c, int flags) {
Matthieu Schaller's avatar
Matthieu Schaller committed
314
315

#ifdef SWIFT_DEBUG_CHECKS
Pedro Gonnet's avatar
Pedro Gonnet committed
316
  if (flags & ~c->sorted) error("Inconsistent sort flags (downward)!");
317
318
  if (c->split)
    for (int k = 0; k < 8; k++)
319
      if (c->progeny[k] != NULL && c->progeny[k]->count > 0)
320
        runner_check_sorts(c->progeny[k], c->sorted);
Matthieu Schaller's avatar
Matthieu Schaller committed
321
322
323
#else
  error("Calling debugging code without debugging flag activated.");
#endif
324
325
}

Pedro Gonnet's avatar
Pedro Gonnet committed
326
327
328
329
330
/**
 * @brief Sort the particles in the given cell along all cardinal directions.
 *
 * @param r The #runner.
 * @param c The #cell.
331
 * @param flags Cell flag.
332
333
 * @param cleanup If true, re-build the sorts for the selected flags instead
 *        of just adding them.
334
335
 * @param clock Flag indicating whether to record the timing or not, needed
 *      for recursive calls.
Pedro Gonnet's avatar
Pedro Gonnet committed
336
 */
337
338
void runner_do_sort(struct runner *r, struct cell *c, int flags, int cleanup,
                    int clock) {
339
340

  struct entry *fingers[8];
341
  const int count = c->count;
342
343
  const struct part *parts = c->parts;
  struct xpart *xparts = c->xparts;
Matthieu Schaller's avatar
Matthieu Schaller committed
344
  float buff[8];
345

346
347
  TIMER_TIC;

348
349
  /* We need to do the local sorts plus whatever was requested further up. */
  flags |= c->do_sort;
350
351
352
353
354
  if (cleanup) {
    c->sorted = 0;
  } else {
    flags &= ~c->sorted;
  }
355
  if (flags == 0 && !c->do_sub_sort) return;
356
357

  /* Check that the particles have been moved to the current time */
Pedro Gonnet's avatar
Pedro Gonnet committed
358
  if (flags && !cell_are_part_drifted(c, r->e))
359
    error("Sorting un-drifted cell c->nodeID=%d", c->nodeID);
Pedro Gonnet's avatar
Pedro Gonnet committed
360

361
362
363
364
365
#ifdef SWIFT_DEBUG_CHECKS
  /* Make sure the sort flags are consistent (downward). */
  runner_check_sorts(c, c->sorted);

  /* Make sure the sort flags are consistent (upard). */
Pedro Gonnet's avatar
Pedro Gonnet committed
366
367
368
  for (struct cell *finger = c->parent; finger != NULL;
       finger = finger->parent) {
    if (finger->sorted & ~c->sorted) error("Inconsistent sort flags (upward).");
369
  }
370

371
372
  /* Update the sort timer which represents the last time the sorts
     were re-set. */
373
  if (c->sorted == 0) c->ti_sort = r->e->ti_current;
374
#endif
375

376
377
378
379
380
381
382
  /* start by allocating the entry arrays in the requested dimensions. */
  for (int j = 0; j < 13; j++) {
    if ((flags & (1 << j)) && c->sort[j] == NULL) {
      if ((c->sort[j] = (struct entry *)malloc(sizeof(struct entry) *
                                               (count + 1))) == NULL)
        error("Failed to allocate sort memory.");
    }
383
384
385
386
387
388
  }

  /* Does this cell have any progeny? */
  if (c->split) {

    /* Fill in the gaps within the progeny. */
389
    float dx_max_sort = 0.0f;
390
    float dx_max_sort_old = 0.0f;
391
    for (int k = 0; k < 8; k++) {
392
      if (c->progeny[k] != NULL && c->progeny[k]->count > 0) {
393
394
395
396
397
        /* Only propagate cleanup if the progeny is stale. */
        runner_do_sort(r, c->progeny[k], flags,
                       cleanup && (c->progeny[k]->dx_max_sort >
                                   space_maxreldx * c->progeny[k]->dmin),
                       0);
398
        dx_max_sort = max(dx_max_sort, c->progeny[k]->dx_max_sort);
399
        dx_max_sort_old = max(dx_max_sort_old, c->progeny[k]->dx_max_sort_old);
400
      }
401
    }
402
    c->dx_max_sort = dx_max_sort;
403
    c->dx_max_sort_old = dx_max_sort_old;
404
405

    /* Loop over the 13 different sort arrays. */
406
    for (int j = 0; j < 13; j++) {
407
408
409
410
411

      /* Has this sort array been flagged? */
      if (!(flags & (1 << j))) continue;

      /* Init the particle index offsets. */
412
      int off[8];
413
414
      off[0] = 0;
      for (int k = 1; k < 8; k++)
415
416
417
418
419
420
        if (c->progeny[k - 1] != NULL)
          off[k] = off[k - 1] + c->progeny[k - 1]->count;
        else
          off[k] = off[k - 1];

      /* Init the entries and indices. */
421
      int inds[8];
422
      for (int k = 0; k < 8; k++) {
423
424
        inds[k] = k;
        if (c->progeny[k] != NULL && c->progeny[k]->count > 0) {
425
          fingers[k] = c->progeny[k]->sort[j];
426
427
428
429
430
431
432
          buff[k] = fingers[k]->d;
          off[k] = off[k];
        } else
          buff[k] = FLT_MAX;
      }

      /* Sort the buffer. */
433
434
      for (int i = 0; i < 7; i++)
        for (int k = i + 1; k < 8; k++)
435
          if (buff[inds[k]] < buff[inds[i]]) {
436
            int temp_i = inds[i];
437
438
439
440
441
            inds[i] = inds[k];
            inds[k] = temp_i;
          }

      /* For each entry in the new sort list. */
442
      struct entry *finger = c->sort[j];
443
      for (int ind = 0; ind < count; ind++) {
444
445
446
447
448
449
450
451
452
453

        /* Copy the minimum into the new sort array. */
        finger[ind].d = buff[inds[0]];
        finger[ind].i = fingers[inds[0]]->i + off[inds[0]];

        /* Update the buffer. */
        fingers[inds[0]] += 1;
        buff[inds[0]] = fingers[inds[0]]->d;

        /* Find the smallest entry. */
454
        for (int k = 1; k < 8 && buff[inds[k]] < buff[inds[k - 1]]; k++) {
455
          int temp_i = inds[k - 1];
456
457
          inds[k - 1] = inds[k];
          inds[k] = temp_i;
Pedro Gonnet's avatar
Pedro Gonnet committed
458
        }
459

460
461
462
      } /* Merge. */

      /* Add a sentinel. */
463
464
      c->sort[j][count].d = FLT_MAX;
      c->sort[j][count].i = 0;
465
466

      /* Mark as sorted. */
467
      atomic_or(&c->sorted, 1 << j);
468
469
470
471
472
473
474
475

    } /* loop over sort arrays. */

  } /* progeny? */

  /* Otherwise, just sort. */
  else {

476
    /* Reset the sort distance */
477
    if (c->sorted == 0) {
478
479
#ifdef SWIFT_DEBUG_CHECKS
      if (xparts != NULL && c->nodeID != engine_rank)
480
        error("Have non-NULL xparts in foreign cell");
481
#endif
482
483
484
485
486
487
488
489

      /* And the individual sort distances if we are a local cell */
      if (xparts != NULL) {
        for (int k = 0; k < count; k++) {
          xparts[k].x_diff_sort[0] = 0.0f;
          xparts[k].x_diff_sort[1] = 0.0f;
          xparts[k].x_diff_sort[2] = 0.0f;
        }
490
      }
491
492
      c->dx_max_sort_old = 0.f;
      c->dx_max_sort = 0.f;
493
494
    }

495
    /* Fill the sort array. */
496
    for (int k = 0; k < count; k++) {
497
      const double px[3] = {parts[k].x[0], parts[k].x[1], parts[k].x[2]};
498
      for (int j = 0; j < 13; j++)
499
        if (flags & (1 << j)) {
500
501
502
503
          c->sort[j][k].i = k;
          c->sort[j][k].d = px[0] * runner_shift[j][0] +
                            px[1] * runner_shift[j][1] +
                            px[2] * runner_shift[j][2];
504
        }
505
    }
506
507

    /* Add the sentinel and sort. */
508
    for (int j = 0; j < 13; j++)
509
      if (flags & (1 << j)) {
510
511
512
        c->sort[j][count].d = FLT_MAX;
        c->sort[j][count].i = 0;
        runner_do_sort_ascending(c->sort[j], count);
513
        atomic_or(&c->sorted, 1 << j);
514
515
516
      }
  }

517
#ifdef SWIFT_DEBUG_CHECKS
Matthieu Schaller's avatar
Matthieu Schaller committed
518
  /* Verify the sorting. */
519
  for (int j = 0; j < 13; j++) {
520
    if (!(flags & (1 << j))) continue;
521
    struct entry *finger = c->sort[j];
522
    for (int k = 1; k < count; k++) {
523
524
525
526
527
      if (finger[k].d < finger[k - 1].d)
        error("Sorting failed, ascending array.");
      if (finger[k].i >= count) error("Sorting failed, indices borked.");
    }
  }
Pedro Gonnet's avatar
Pedro Gonnet committed
528

529
530
531
532
  /* Make sure the sort flags are consistent (downward). */
  runner_check_sorts(c, flags);

  /* Make sure the sort flags are consistent (upward). */
Pedro Gonnet's avatar
Pedro Gonnet committed
533
534
535
  for (struct cell *finger = c->parent; finger != NULL;
       finger = finger->parent) {
    if (finger->sorted & ~c->sorted) error("Inconsistent sort flags.");
536
  }
537
#endif
538

539
540
541
542
543
  /* Clear the cell's sort flags. */
  c->do_sort = 0;
  c->do_sub_sort = 0;
  c->requires_sorts = 0;

544
545
546
  if (clock) TIMER_TOC(timer_dosort);
}

547
/**
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 * @brief Initialize the multipoles before the gravity calculation.
 *
 * @param r The runner thread.
 * @param c The cell.
 * @param timer 1 if the time is to be recorded.
 */
void runner_do_init_grav(struct runner *r, struct cell *c, int timer) {

  const struct engine *e = r->e;

  TIMER_TIC;

#ifdef SWIFT_DEBUG_CHECKS
  if (!(e->policy & engine_policy_self_gravity))
    error("Grav-init task called outside of self-gravity calculation");
#endif

  /* Anything to do here? */
566
  if (!cell_is_active_gravity(c, e)) return;
567
568

  /* Reset the gravity acceleration tensors */
569
  gravity_field_tensors_init(&c->multipole->pot, e->ti_current);
570
571
572
573
574
575
576
577
578
579
580

  /* Recurse? */
  if (c->split) {
    for (int k = 0; k < 8; k++) {
      if (c->progeny[k] != NULL) runner_do_init_grav(r, c->progeny[k], 0);
    }
  }

  if (timer) TIMER_TOC(timer_init_grav);
}

581
/**
582
583
584
585
586
 * @brief Intermediate task after the gradient loop that does final operations
 * on the gradient quantities and optionally slope limits the gradients
 *
 * @param r The runner thread.
 * @param c The cell.
587
 * @param timer Are we timing this ?
588
 */
589
void runner_do_extra_ghost(struct runner *r, struct cell *c, int timer) {
590

591
#ifdef EXTRA_HYDRO_LOOP
592

593
594
  struct part *restrict parts = c->parts;
  const int count = c->count;
595
  const struct engine *e = r->e;
596

597
598
  TIMER_TIC;

599
  /* Anything to do here? */
600
  if (!cell_is_active_hydro(c, e)) return;
601

602
603
604
  /* Recurse? */
  if (c->split) {
    for (int k = 0; k < 8; k++)
605
      if (c->progeny[k] != NULL) runner_do_extra_ghost(r, c->progeny[k], 0);
606
607
608
609
610
611
612
613
  } else {

    /* Loop over the parts in this cell. */
    for (int i = 0; i < count; i++) {

      /* Get a direct pointer on the part. */
      struct part *restrict p = &parts[i];

614
      if (part_is_active(p, e)) {
615
616
617
618
619
620

        /* Get ready for a force calculation */
        hydro_end_gradient(p);
      }
    }
  }
621

622
623
  if (timer) TIMER_TOC(timer_do_extra_ghost);

624
625
#else
  error("SWIFT was not compiled with the extra hydro loop activated.");
626
#endif
627
}
628

629
/**
630
631
 * @brief Intermediate task after the density to check that the smoothing
 * lengths are correct.
632
 *
Pedro Gonnet's avatar
Pedro Gonnet committed
633
 * @param r The runner thread.
634
 * @param c The cell.
635
 * @param timer Are we timing this ?
636
 */
637
void runner_do_ghost(struct runner *r, struct cell *c, int timer) {
638

Matthieu Schaller's avatar
Matthieu Schaller committed
639
640
  struct part *restrict parts = c->parts;
  struct xpart *restrict xparts = c->xparts;
641
  const struct engine *e = r->e;
642
  const struct space *s = e->s;
643
  const float hydro_h_max = e->hydro_properties->h_max;
644
645
646
  const float eps = e->hydro_properties->h_tolerance;
  const float hydro_eta_dim =
      pow_dimension(e->hydro_properties->eta_neighbours);
647
  const int max_smoothing_iter = e->hydro_properties->max_smoothing_iterations;
648
  int redo = 0, count = 0;
649

650
651
  TIMER_TIC;

652
  /* Anything to do here? */
653
  if (!cell_is_active_hydro(c, e)) return;
654

655
656
  /* Recurse? */
  if (c->split) {
Matthieu Schaller's avatar
Matthieu Schaller committed
657
    for (int k = 0; k < 8; k++)
658
659
      if (c->progeny[k] != NULL) runner_do_ghost(r, c->progeny[k], 0);
  } else {
660

661
    /* Init the list of active particles that have to be updated. */
662
    int *pid = NULL;
663
    if ((pid = malloc(sizeof(int) * c->count)) == NULL)
664
      error("Can't allocate memory for pid.");
665
666
667
668
669
    for (int k = 0; k < c->count; k++)
      if (part_is_active(&parts[k], e)) {
        pid[count] = k;
        ++count;
      }
670

671
672
673
    /* While there are particles that need to be updated... */
    for (int num_reruns = 0; count > 0 && num_reruns < max_smoothing_iter;
         num_reruns++) {
674

675
676
      /* Reset the redo-count. */
      redo = 0;
677

678
      /* Loop over the remaining active parts in this cell. */
679
      for (int i = 0; i < count; i++) {
680

681
        /* Get a direct pointer on the part. */
682
683
        struct part *p = &parts[pid[i]];
        struct xpart *xp = &xparts[pid[i]];
684

685
#ifdef SWIFT_DEBUG_CHECKS
686
        /* Is this part within the timestep? */
687
688
689
        if (!part_is_active(p, e)) error("Ghost applied to inactive particle");
#endif

690
691
692
693
694
        /* Get some useful values */
        const float h_old = p->h;
        const float h_old_dim = pow_dimension(h_old);
        const float h_old_dim_minus_one = pow_dimension_minus_one(h_old);
        float h_new;
695

696
        if (p->density.wcount == 0.f) { /* No neighbours case */
697

698
699
700
          /* Double h and try again */
          h_new = 2.f * h_old;
        } else {
Matthieu Schaller's avatar
Matthieu Schaller committed
701

702
703
          /* Finish the density calculation */
          hydro_end_density(p);
lhausamm's avatar
lhausamm committed
704
          chemistry_end_density(p, e->chemistry);
705

706
707
708
709
710
711
712
          /* Compute one step of the Newton-Raphson scheme */
          const float n_sum = p->density.wcount * h_old_dim;
          const float n_target = hydro_eta_dim;
          const float f = n_sum - n_target;
          const float f_prime =
              p->density.wcount_dh * h_old_dim +
              hydro_dimension * p->density.wcount * h_old_dim_minus_one;
713

714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
          h_new = h_old - f / f_prime;

#ifdef SWIFT_DEBUG_CHECKS
          if ((f > 0.f && h_new > h_old) || (f < 0.f && h_new < h_old))
            error(
                "Smoothing length correction not going in the right direction");
#endif

          /* Safety check: truncate to the range [ h_old/2 , 2h_old ]. */
          h_new = min(h_new, 2.f * h_old);
          h_new = max(h_new, 0.5f * h_old);
        }

        /* Check whether the particle has an inappropriate smoothing length */
        if (fabsf(h_new - h_old) > eps * h_old) {
729

730
          /* Ok, correct then */
731
          p->h = h_new;
732

733
734
          /* If below the absolute maximum, try again */
          if (p->h < hydro_h_max) {
735

736
737
738
            /* Flag for another round of fun */
            pid[redo] = pid[i];
            redo += 1;
739

740
            /* Re-initialise everything */
741
            hydro_init_part(p, &s->hs);
lhausamm's avatar
lhausamm committed
742
            chemistry_init_part(p, e->chemistry);
743
744
745
746
747
748
749

            /* Off we go ! */
            continue;
          } else {

            /* Ok, this particle is a lost cause... */
            p->h = hydro_h_max;
750
751
752
753

            /* Do some damage control if no neighbours at all were found */
            if (p->density.wcount == kernel_root * kernel_norm)
              hydro_part_has_no_neighbours(p, xp);
754
          }
755
        }
756

757
        /* We now have a particle whose smoothing length has converged */
Matthieu Schaller's avatar
Matthieu Schaller committed
758

759
        /* As of here, particle force variables will be set. */
760

761
762
        /* Compute variables required for the force loop */
        hydro_prepare_force(p, xp);
763

764
765
        /* The particle force values are now set.  Do _NOT_
           try to read any particle density variables! */
Matthieu Schaller's avatar
Matthieu Schaller committed
766

767
768
        /* Prepare the particle for the force loop over neighbours */
        hydro_reset_acceleration(p);
769
770
      }

771
772
      /* We now need to treat the particles whose smoothing length had not
       * converged again */
773

774
775
776
      /* Re-set the counter for the next loop (potentially). */
      count = redo;
      if (count > 0) {
777

778
779
        /* Climb up the cell hierarchy. */
        for (struct cell *finger = c; finger != NULL; finger = finger->parent) {
Matthieu Schaller's avatar
Matthieu Schaller committed
780

781
782
          /* Run through this cell's density interactions. */
          for (struct link *l = finger->density; l != NULL; l = l->next) {
Matthieu Schaller's avatar
Matthieu Schaller committed
783

784
785
786
787
#ifdef SWIFT_DEBUG_CHECKS
            if (l->t->ti_run < r->e->ti_current)
              error("Density task should have been run.");
#endif
Matthieu Schaller's avatar
Matthieu Schaller committed
788

789
790
            /* Self-interaction? */
            if (l->t->type == task_type_self)
791
              runner_doself_subset_branch_density(r, finger, parts, pid, count);
Matthieu Schaller's avatar
Matthieu Schaller committed
792

793
794
            /* Otherwise, pair interaction? */
            else if (l->t->type == task_type_pair) {
795

796
797
              /* Left or right? */
              if (l->t->ci == finger)
James Willis's avatar
James Willis committed
798
799
                runner_dopair_subset_branch_density(r, finger, parts, pid,
                                                    count, l->t->cj);
800
              else
James Willis's avatar
James Willis committed
801
802
                runner_dopair_subset_branch_density(r, finger, parts, pid,
                                                    count, l->t->ci);
803
            }
804

805
806
807
808
            /* Otherwise, sub-self interaction? */
            else if (l->t->type == task_type_sub_self)
              runner_dosub_subset_density(r, finger, parts, pid, count, NULL,
                                          -1, 1);
809

810
811
812
813
814
815
816
817
818
819
820
            /* Otherwise, sub-pair interaction? */
            else if (l->t->type == task_type_sub_pair) {

              /* Left or right? */
              if (l->t->ci == finger)
                runner_dosub_subset_density(r, finger, parts, pid, count,
                                            l->t->cj, -1, 1);
              else
                runner_dosub_subset_density(r, finger, parts, pid, count,
                                            l->t->ci, -1, 1);
            }
821
822
823
          }
        }
      }
824
    }
825

826
827
#ifdef SWIFT_DEBUG_CHECKS
    if (count) {
828
      error("Smoothing length failed to converge on %i particles.", count);
829
830
    }
#else
831
    if (count)
832
      error("Smoothing length failed to converge on %i particles.", count);
833
#endif
834

835
836
837
    /* Be clean */
    free(pid);
  }
838

839
  if (timer) TIMER_TOC(timer_do_ghost);
840
841
}

842
/**
843
 * @brief Unskip any hydro tasks associated with active cells.
844
845
 *
 * @param c The cell.
846
 * @param e The engine.
847
 */
848
static void runner_do_unskip_hydro(struct cell *c, struct engine *e) {
849

850
  /* Ignore empty cells. */
851
  if (c->count == 0) return;
852

853
  /* Skip inactive cells. */
854
  if (!cell_is_active_hydro(c, e)) return;
855

856
  /* Recurse */
857
858
  if (c->split) {
    for (int k = 0; k < 8; k++) {
Matthieu Schaller's avatar
Matthieu Schaller committed
859
      if (c->progeny[k] != NULL) {
Matthieu Schaller's avatar
Matthieu Schaller committed
860
        struct cell *cp = c->progeny[k];
861
        runner_do_unskip_hydro(cp, e);
862
863
864
      }
    }
  }
865
866

  /* Unskip any active tasks. */
867
  const int forcerebuild = cell_unskip_hydro_tasks(c, &e->sched);
868
  if (forcerebuild) atomic_inc(&e->forcerebuild);
869
}
870

871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
/**
 * @brief Unskip any gravity tasks associated with active cells.
 *
 * @param c The cell.
 * @param e The engine.
 */
static void runner_do_unskip_gravity(struct cell *c, struct engine *e) {

  /* Ignore empty cells. */
  if (c->gcount == 0) return;

  /* Skip inactive cells. */
  if (!cell_is_active_gravity(c, e)) return;

  /* Recurse */
  if (c->split) {
    for (int k = 0; k < 8; k++) {
      if (c->progeny[k] != NULL) {
        struct cell *cp = c->progeny[k];
        runner_do_unskip_gravity(cp, e);
      }
    }
  }

  /* Unskip any active tasks. */
  cell_unskip_gravity_tasks(c, &e->sched);
}

899
/**
900
 * @brief Mapper function to unskip active tasks.
901
902
903
904
905
 *
 * @param map_data An array of #cell%s.