runner.c 65.3 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 "chemistry.h"
46
#include "const.h"
Stefan Arridge's avatar
Stefan Arridge committed
47
#include "cooling.h"
48
#include "debug.h"
Matthieu Schaller's avatar
Matthieu Schaller committed
49
#include "drift.h"
Pedro Gonnet's avatar
Pedro Gonnet committed
50
#include "engine.h"
51
#include "error.h"
52
53
#include "gravity.h"
#include "hydro.h"
Matthieu Schaller's avatar
Matthieu Schaller committed
54
#include "hydro_properties.h"
55
#include "kick.h"
56
#include "minmax.h"
57
#include "runner_doiact_fft.h"
James Willis's avatar
James Willis committed
58
#include "runner_doiact_vec.h"
59
#include "scheduler.h"
60
#include "sort_part.h"
61
#include "sourceterms.h"
62
#include "space.h"
63
#include "space_getsid.h"
64
#include "stars.h"
65
66
#include "task.h"
#include "timers.h"
67
#include "timestep.h"
Pedro Gonnet's avatar
Pedro Gonnet committed
68

69
70
71
72
#define TASK_LOOP_DENSITY 0
#define TASK_LOOP_GRADIENT 1
#define TASK_LOOP_FORCE 2
#define TASK_LOOP_LIMITER 3
73

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

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

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

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

Tom Theuns's avatar
Tom Theuns committed
101
/**
Tom Theuns's avatar
Tom Theuns committed
102
 * @brief Perform source terms
Tom Theuns's avatar
Tom Theuns committed
103
104
105
106
107
108
109
 *
 * @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;
110
  const double cell_min[3] = {c->loc[0], c->loc[1], c->loc[2]};
Tom Theuns's avatar
Tom Theuns committed
111
  const double cell_width[3] = {c->width[0], c->width[1], c->width[2]};
Tom Theuns's avatar
Tom Theuns committed
112
  struct sourceterms *sourceterms = r->e->sourceterms;
113
  const int dimen = 3;
Tom Theuns's avatar
Tom Theuns committed
114
115
116
117
118
119
120

  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);
121
  } else {
Tom Theuns's avatar
Tom Theuns committed
122

123
    if (count > 0) {
Tom Theuns's avatar
Tom Theuns committed
124

125
126
127
128
129
130
      /* 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
131
132
    }
  }
Tom Theuns's avatar
Tom Theuns committed
133
134
135
136

  if (timer) TIMER_TOC(timer_dosource);
}

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

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

153
  TIMER_TIC;
Tom Theuns's avatar
Tom Theuns committed
154

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

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

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

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

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

177
  if (timer) TIMER_TOC(timer_dograv_external);
Tom Theuns's avatar
Tom Theuns committed
178
179
}

Stefan Arridge's avatar
Stefan Arridge committed
180
/**
181
182
 * @brief Calculate change in thermal state of particles induced
 * by radiative cooling and heating.
Stefan Arridge's avatar
Stefan Arridge committed
183
184
185
186
187
188
189
 *
 * @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) {

190
  const struct engine *e = r->e;
191
192
  const struct cosmology *cosmo = e->cosmology;
  const int with_cosmology = (e->policy & engine_policy_cosmology);
193
194
  const struct cooling_function_data *cooling_func = e->cooling_func;
  const struct phys_const *constants = e->physical_constants;
195
  const struct unit_system *us = e->internal_units;
196
  const double time_base = e->time_base;
197
198
199
200
  const integertime_t ti_current = e->ti_current;
  struct part *restrict parts = c->parts;
  struct xpart *restrict xparts = c->xparts;
  const int count = c->count;
Stefan Arridge's avatar
Stefan Arridge committed
201
202
203

  TIMER_TIC;

204
  /* Anything to do here? */
205
  if (!cell_is_active_hydro(c, e)) return;
206

Stefan Arridge's avatar
Stefan Arridge committed
207
208
209
210
  /* Recurse? */
  if (c->split) {
    for (int k = 0; k < 8; k++)
      if (c->progeny[k] != NULL) runner_do_cooling(r, c->progeny[k], 0);
211
  } else {
Stefan Arridge's avatar
Stefan Arridge committed
212

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

216
217
218
      /* 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
219

220
      if (part_is_active(p, e)) {
221

222
223
224
225
226
227
228
229
230
231
        double dt_cool;
        if (with_cosmology) {
          const integertime_t ti_step = get_integer_timestep(p->time_bin);
          const integertime_t ti_begin =
              get_integer_time_begin(ti_current + 1, p->time_bin);
          dt_cool =
              cosmology_get_delta_time(cosmo, ti_begin, ti_begin + ti_step);
        } else {
          dt_cool = get_timestep(p->time_bin, time_base);
        }
232

233
        /* Let's cool ! */
234
        cooling_cool_part(constants, us, cosmo, cooling_func, p, xp, dt_cool);
235
      }
Stefan Arridge's avatar
Stefan Arridge committed
236
237
238
239
240
241
    }
  }

  if (timer) TIMER_TOC(timer_do_cooling);
}

Pedro Gonnet's avatar
Pedro Gonnet committed
242
243
244
245
246
247
/**
 * @brief Sort the entries in ascending order using QuickSort.
 *
 * @param sort The entries
 * @param N The number of entries.
 */
248
void runner_do_sort_ascending(struct entry *sort, int N) {
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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302

  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
303
        }
304
305
306
307
308
309
310
311
312
313
314
315
      } 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
316
    }
317
318
319
  }
}

Matthieu Schaller's avatar
Matthieu Schaller committed
320
321
322
323
324
325
326
327
/**
 * @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.
 */
328
void runner_check_sorts(struct cell *c, int flags) {
Matthieu Schaller's avatar
Matthieu Schaller committed
329
330

#ifdef SWIFT_DEBUG_CHECKS
Pedro Gonnet's avatar
Pedro Gonnet committed
331
  if (flags & ~c->sorted) error("Inconsistent sort flags (downward)!");
332
333
  if (c->split)
    for (int k = 0; k < 8; k++)
334
      if (c->progeny[k] != NULL && c->progeny[k]->count > 0)
335
        runner_check_sorts(c->progeny[k], c->sorted);
Matthieu Schaller's avatar
Matthieu Schaller committed
336
337
338
#else
  error("Calling debugging code without debugging flag activated.");
#endif
339
340
}

Pedro Gonnet's avatar
Pedro Gonnet committed
341
342
343
344
345
/**
 * @brief Sort the particles in the given cell along all cardinal directions.
 *
 * @param r The #runner.
 * @param c The #cell.
346
 * @param flags Cell flag.
347
348
 * @param cleanup If true, re-build the sorts for the selected flags instead
 *        of just adding them.
349
350
 * @param clock Flag indicating whether to record the timing or not, needed
 *      for recursive calls.
Pedro Gonnet's avatar
Pedro Gonnet committed
351
 */
352
353
void runner_do_sort(struct runner *r, struct cell *c, int flags, int cleanup,
                    int clock) {
354
355

  struct entry *fingers[8];
356
  const int count = c->count;
357
358
  const struct part *parts = c->parts;
  struct xpart *xparts = c->xparts;
Matthieu Schaller's avatar
Matthieu Schaller committed
359
  float buff[8];
360

361
362
  TIMER_TIC;

363
364
  /* We need to do the local sorts plus whatever was requested further up. */
  flags |= c->do_sort;
365
366
367
368
369
  if (cleanup) {
    c->sorted = 0;
  } else {
    flags &= ~c->sorted;
  }
370
  if (flags == 0 && !c->do_sub_sort) return;
371
372

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

376
377
378
379
380
#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
381
382
383
  for (struct cell *finger = c->parent; finger != NULL;
       finger = finger->parent) {
    if (finger->sorted & ~c->sorted) error("Inconsistent sort flags (upward).");
384
  }
385

386
387
  /* Update the sort timer which represents the last time the sorts
     were re-set. */
388
  if (c->sorted == 0) c->ti_sort = r->e->ti_current;
389
#endif
390

391
392
393
394
395
396
397
  /* 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.");
    }
398
399
400
401
402
403
  }

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

    /* Fill in the gaps within the progeny. */
404
    float dx_max_sort = 0.0f;
405
    float dx_max_sort_old = 0.0f;
406
    for (int k = 0; k < 8; k++) {
407
      if (c->progeny[k] != NULL && c->progeny[k]->count > 0) {
408
409
410
411
412
        /* 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);
413
        dx_max_sort = max(dx_max_sort, c->progeny[k]->dx_max_sort);
414
        dx_max_sort_old = max(dx_max_sort_old, c->progeny[k]->dx_max_sort_old);
415
      }
416
    }
417
    c->dx_max_sort = dx_max_sort;
418
    c->dx_max_sort_old = dx_max_sort_old;
419
420

    /* Loop over the 13 different sort arrays. */
421
    for (int j = 0; j < 13; j++) {
422
423
424
425
426

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

      /* Init the particle index offsets. */
427
      int off[8];
428
429
      off[0] = 0;
      for (int k = 1; k < 8; k++)
430
431
432
433
434
435
        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. */
436
      int inds[8];
437
      for (int k = 0; k < 8; k++) {
438
439
        inds[k] = k;
        if (c->progeny[k] != NULL && c->progeny[k]->count > 0) {
440
          fingers[k] = c->progeny[k]->sort[j];
441
442
443
444
445
446
447
          buff[k] = fingers[k]->d;
          off[k] = off[k];
        } else
          buff[k] = FLT_MAX;
      }

      /* Sort the buffer. */
448
449
      for (int i = 0; i < 7; i++)
        for (int k = i + 1; k < 8; k++)
450
          if (buff[inds[k]] < buff[inds[i]]) {
451
            int temp_i = inds[i];
452
453
454
455
456
            inds[i] = inds[k];
            inds[k] = temp_i;
          }

      /* For each entry in the new sort list. */
457
      struct entry *finger = c->sort[j];
458
      for (int ind = 0; ind < count; ind++) {
459
460
461
462
463
464
465
466
467
468

        /* 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. */
469
        for (int k = 1; k < 8 && buff[inds[k]] < buff[inds[k - 1]]; k++) {
470
          int temp_i = inds[k - 1];
471
472
          inds[k - 1] = inds[k];
          inds[k] = temp_i;
Pedro Gonnet's avatar
Pedro Gonnet committed
473
        }
474

475
476
477
      } /* Merge. */

      /* Add a sentinel. */
478
479
      c->sort[j][count].d = FLT_MAX;
      c->sort[j][count].i = 0;
480
481

      /* Mark as sorted. */
482
      atomic_or(&c->sorted, 1 << j);
483
484
485
486
487
488
489
490

    } /* loop over sort arrays. */

  } /* progeny? */

  /* Otherwise, just sort. */
  else {

491
    /* Reset the sort distance */
492
    if (c->sorted == 0) {
493
494
#ifdef SWIFT_DEBUG_CHECKS
      if (xparts != NULL && c->nodeID != engine_rank)
495
        error("Have non-NULL xparts in foreign cell");
496
#endif
497
498
499
500
501
502
503
504

      /* 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;
        }
505
      }
506
507
      c->dx_max_sort_old = 0.f;
      c->dx_max_sort = 0.f;
508
509
    }

510
    /* Fill the sort array. */
511
    for (int k = 0; k < count; k++) {
512
      const double px[3] = {parts[k].x[0], parts[k].x[1], parts[k].x[2]};
513
      for (int j = 0; j < 13; j++)
514
        if (flags & (1 << j)) {
515
516
517
518
          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];
519
        }
520
    }
521
522

    /* Add the sentinel and sort. */
523
    for (int j = 0; j < 13; j++)
524
      if (flags & (1 << j)) {
525
526
527
        c->sort[j][count].d = FLT_MAX;
        c->sort[j][count].i = 0;
        runner_do_sort_ascending(c->sort[j], count);
528
        atomic_or(&c->sorted, 1 << j);
529
530
531
      }
  }

532
#ifdef SWIFT_DEBUG_CHECKS
Matthieu Schaller's avatar
Matthieu Schaller committed
533
  /* Verify the sorting. */
534
  for (int j = 0; j < 13; j++) {
535
    if (!(flags & (1 << j))) continue;
536
    struct entry *finger = c->sort[j];
537
    for (int k = 1; k < count; k++) {
538
539
540
541
542
      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
543

544
545
546
547
  /* 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
548
549
550
  for (struct cell *finger = c->parent; finger != NULL;
       finger = finger->parent) {
    if (finger->sorted & ~c->sorted) error("Inconsistent sort flags.");
551
  }
552
#endif
553

554
555
556
557
558
  /* Clear the cell's sort flags. */
  c->do_sort = 0;
  c->do_sub_sort = 0;
  c->requires_sorts = 0;

559
560
561
  if (clock) TIMER_TOC(timer_dosort);
}

562
/**
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 * @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? */
581
  if (!cell_is_active_gravity(c, e)) return;
582
583

  /* Reset the gravity acceleration tensors */
584
  gravity_field_tensors_init(&c->multipole->pot, e->ti_current);
585
586
587
588
589
590
591
592
593
594
595

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

596
/**
597
598
599
600
601
 * @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.
602
 * @param timer Are we timing this ?
603
 */
604
void runner_do_extra_ghost(struct runner *r, struct cell *c, int timer) {
605

606
#ifdef EXTRA_HYDRO_LOOP
607

608
  struct part *restrict parts = c->parts;
609
  struct xpart *restrict xparts = c->xparts;
610
  const int count = c->count;
611
  const struct engine *e = r->e;
612
  const struct cosmology *cosmo = e->cosmology;
613

614
615
  TIMER_TIC;

616
  /* Anything to do here? */
617
  if (!cell_is_active_hydro(c, e)) return;
618

619
620
621
  /* Recurse? */
  if (c->split) {
    for (int k = 0; k < 8; k++)
622
      if (c->progeny[k] != NULL) runner_do_extra_ghost(r, c->progeny[k], 0);
623
624
625
626
627
628
629
  } 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];
630
      struct xpart *restrict xp = &xparts[i];
631

632
      if (part_is_active(p, e)) {
633

634
        /* Finish the gradient calculation */
635
        hydro_end_gradient(p);
636
637
638
639
640
641
642
643
644
645
646

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

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

        /* The particle force values are now set.  Do _NOT_
           try to read any particle density variables! */

        /* Prepare the particle for the force loop over neighbours */
        hydro_reset_acceleration(p);
647
648
649
      }
    }
  }
650

651
652
  if (timer) TIMER_TOC(timer_do_extra_ghost);

653
654
#else
  error("SWIFT was not compiled with the extra hydro loop activated.");
655
#endif
656
}
657

658
/**
659
660
 * @brief Intermediate task after the density to check that the smoothing
 * lengths are correct.
661
 *
Pedro Gonnet's avatar
Pedro Gonnet committed
662
 * @param r The runner thread.
663
 * @param c The cell.
664
 * @param timer Are we timing this ?
665
 */
666
void runner_do_ghost(struct runner *r, struct cell *c, int timer) {
667

Matthieu Schaller's avatar
Matthieu Schaller committed
668
669
  struct part *restrict parts = c->parts;
  struct xpart *restrict xparts = c->xparts;
670
  const struct engine *e = r->e;
671
  const struct space *s = e->s;
672
673
  const struct hydro_space *hs = &s->hs;
  const struct cosmology *cosmo = e->cosmology;
lhausamm's avatar
lhausamm committed
674
  const struct chemistry_global_data *chemistry = e->chemistry;
675
  const float hydro_h_max = e->hydro_properties->h_max;
676
677
678
  const float eps = e->hydro_properties->h_tolerance;
  const float hydro_eta_dim =
      pow_dimension(e->hydro_properties->eta_neighbours);
679
  const int max_smoothing_iter = e->hydro_properties->max_smoothing_iterations;
680
  int redo = 0, count = 0;
681

682
683
  TIMER_TIC;

684
  /* Anything to do here? */
685
  if (!cell_is_active_hydro(c, e)) return;
686

687
688
  /* Recurse? */
  if (c->split) {
Matthieu Schaller's avatar
Matthieu Schaller committed
689
    for (int k = 0; k < 8; k++)
690
691
      if (c->progeny[k] != NULL) runner_do_ghost(r, c->progeny[k], 0);
  } else {
692

693
    /* Init the list of active particles that have to be updated. */
694
    int *pid = NULL;
695
    if ((pid = (int *)malloc(sizeof(int) * c->count)) == NULL)
696
      error("Can't allocate memory for pid.");
697
698
699
700
701
    for (int k = 0; k < c->count; k++)
      if (part_is_active(&parts[k], e)) {
        pid[count] = k;
        ++count;
      }
702

703
704
705
    /* While there are particles that need to be updated... */
    for (int num_reruns = 0; count > 0 && num_reruns < max_smoothing_iter;
         num_reruns++) {
706

707
708
      /* Reset the redo-count. */
      redo = 0;
709

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

713
        /* Get a direct pointer on the part. */
714
715
        struct part *p = &parts[pid[i]];
        struct xpart *xp = &xparts[pid[i]];
716

717
#ifdef SWIFT_DEBUG_CHECKS
718
        /* Is this part within the timestep? */
719
720
721
        if (!part_is_active(p, e)) error("Ghost applied to inactive particle");
#endif

722
723
724
725
726
        /* 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;
727
        int has_no_neighbours = 0;
728

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

731
732
733
          /* Flag that there were no neighbours */
          has_no_neighbours = 1;

734
735
736
          /* Double h and try again */
          h_new = 2.f * h_old;
        } else {
Matthieu Schaller's avatar
Matthieu Schaller committed
737

738
          /* Finish the density calculation */
739
          hydro_end_density(p, cosmo);
740
          chemistry_end_density(p, chemistry, cosmo);
741

742
743
744
745
746
747
748
          /* 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;
749

750
751
          /* Avoid floating point exception from f_prime = 0 */
          h_new = h_old - f / (f_prime + FLT_MIN);
752
753
754
755
756
757
758
759
760
761
762
763
764
765

#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) {
766

767
          /* Ok, correct then */
768
          p->h = h_new;
769

770
771
          /* If below the absolute maximum, try again */
          if (p->h < hydro_h_max) {
772

773
774
775
            /* Flag for another round of fun */
            pid[redo] = pid[i];
            redo += 1;
776

777
            /* Re-initialise everything */
778
            hydro_init_part(p, hs);
779
            chemistry_init_part(p, chemistry);
780
781
782

            /* Off we go ! */
            continue;
783

784
785
786
787
          } else {

            /* Ok, this particle is a lost cause... */
            p->h = hydro_h_max;
788
789

            /* Do some damage control if no neighbours at all were found */
790
            if (has_no_neighbours) {
791
              hydro_part_has_no_neighbours(p, xp, cosmo);
792
793
              chemistry_part_has_no_neighbours(p, xp, chemistry, cosmo);
            }
794
          }
795
        }
796

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

799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
#ifdef EXTRA_HYDRO_LOOP

        /* As of here, particle gradient variables will be set. */
        /* The force variables are set in the extra ghost. */

        /* Compute variables required for the gradient loop */
        hydro_prepare_gradient(p, xp, cosmo);

        /* The particle gradient values are now set.  Do _NOT_
           try to read any particle density variables! */

        /* Prepare the particle for the gradient loop over neighbours */
        hydro_reset_gradient(p);

#else
814
        /* As of here, particle force variables will be set. */
815

816
        /* Compute variables required for the force loop */
817
        hydro_prepare_force(p, xp, cosmo);
818

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

822
823
        /* Prepare the particle for the force loop over neighbours */
        hydro_reset_acceleration(p);
824
825

#endif /* EXTRA_HYDRO_LOOP */
826
827
      }

828
829
      /* We now need to treat the particles whose smoothing length had not
       * converged again */
830

831
832
833
      /* Re-set the counter for the next loop (potentially). */
      count = redo;
      if (count > 0) {
834

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

838
839
          /* 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
840

841
842
843
844
#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
845

846
847
            /* Self-interaction? */
            if (l->t->type == task_type_self)
848
              runner_doself_subset_branch_density(r, finger, parts, pid, count);
Matthieu Schaller's avatar
Matthieu Schaller committed
849

850
851
            /* Otherwise, pair interaction? */
            else if (l->t->type == task_type_pair) {
852

853
854
              /* Left or right? */
              if (l->t->ci == finger)
James Willis's avatar
James Willis committed
855
856
                runner_dopair_subset_branch_density(r, finger, parts, pid,
                                                    count, l->t->cj);
857
              else
James Willis's avatar
James Willis committed
858
859
                runner_dopair_subset_branch_density(r, finger, parts, pid,
                                                    count, l->t->ci);
860
            }
861

862
863
864
865
            /* 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);
866

867
868
869
870
871
872
873
874
875
876
877
            /* 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);
            }
878
879
880
          }
        }
      }
881
    }
882

883
884
#ifdef SWIFT_DEBUG_CHECKS
    if (count) {
885
      error("Smoothing length failed to converge on %i particles.", count);
886
887
    }
#else
888
    if (count) {
889
      error("Smoothing length failed to converge on %i particles.", count);
890
    }
891
#endif
892

893
894
895
    /* Be clean */
    free(pid);
  }
896