runner.c 68.5 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"
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 "space_getsid.h"
63
#include "stars.h"
64
65
#include "task.h"
#include "timers.h"
66
#include "timestep.h"
Pedro Gonnet's avatar
Pedro Gonnet committed
67

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

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

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

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

96
/* Import the gravity loop functions. */
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
}

178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/**
 * @brief Calculate gravity accelerations from the periodic mesh
 *
 * @param r runner task
 * @param c cell
 * @param timer 1 if the time is to be recorded.
 */
void runner_do_grav_mesh(struct runner *r, struct cell *c, int timer) {

  struct gpart *restrict gparts = c->gparts;
  const int gcount = c->gcount;
  const struct engine *e = r->e;

#ifdef SWIFT_DEBUG_CHECKS
  if (!e->s->periodic) error("Calling mesh forces in non-periodic mode.");
#endif

  TIMER_TIC;

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

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

    /* Get the forces from the gravity mesh */
    pm_mesh_interpolate_forces(e->mesh, e, gparts, gcount);
  }

  if (timer) TIMER_TOC(timer_dograv_mesh);
}

Stefan Arridge's avatar
Stefan Arridge committed
213
/**
214
215
 * @brief Calculate change in thermal state of particles induced
 * by radiative cooling and heating.
Stefan Arridge's avatar
Stefan Arridge committed
216
217
218
219
220
221
222
 *
 * @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) {

223
  const struct engine *e = r->e;
224
225
  const struct cosmology *cosmo = e->cosmology;
  const int with_cosmology = (e->policy & engine_policy_cosmology);
226
227
  const struct cooling_function_data *cooling_func = e->cooling_func;
  const struct phys_const *constants = e->physical_constants;
228
  const struct unit_system *us = e->internal_units;
229
  const double time_base = e->time_base;
230
231
232
233
  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
234
235
236

  TIMER_TIC;

237
  /* Anything to do here? */
238
  if (!cell_is_active_hydro(c, e)) return;
239

Stefan Arridge's avatar
Stefan Arridge committed
240
241
242
243
  /* Recurse? */
  if (c->split) {
    for (int k = 0; k < 8; k++)
      if (c->progeny[k] != NULL) runner_do_cooling(r, c->progeny[k], 0);
244
  } else {
Stefan Arridge's avatar
Stefan Arridge committed
245

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

249
250
251
      /* 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
252

253
      if (part_is_active(p, e)) {
254

255
256
257
258
259
260
261
262
263
264
        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);
        }
265

266
        /* Let's cool ! */
267
        cooling_cool_part(constants, us, cosmo, cooling_func, p, xp, dt_cool);
268
      }
Stefan Arridge's avatar
Stefan Arridge committed
269
270
271
272
273
274
    }
  }

  if (timer) TIMER_TOC(timer_do_cooling);
}

Pedro Gonnet's avatar
Pedro Gonnet committed
275
276
277
278
279
280
/**
 * @brief Sort the entries in ascending order using QuickSort.
 *
 * @param sort The entries
 * @param N The number of entries.
 */
281
void runner_do_sort_ascending(struct entry *sort, int N) {
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335

  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
336
        }
337
338
339
340
341
342
343
344
345
346
347
348
      } 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
349
    }
350
351
352
  }
}

Matthieu Schaller's avatar
Matthieu Schaller committed
353
354
355
356
357
358
359
360
/**
 * @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.
 */
361
void runner_check_sorts(struct cell *c, int flags) {
Matthieu Schaller's avatar
Matthieu Schaller committed
362
363

#ifdef SWIFT_DEBUG_CHECKS
Pedro Gonnet's avatar
Pedro Gonnet committed
364
  if (flags & ~c->sorted) error("Inconsistent sort flags (downward)!");
365
366
  if (c->split)
    for (int k = 0; k < 8; k++)
367
      if (c->progeny[k] != NULL && c->progeny[k]->count > 0)
368
        runner_check_sorts(c->progeny[k], c->sorted);
Matthieu Schaller's avatar
Matthieu Schaller committed
369
370
371
#else
  error("Calling debugging code without debugging flag activated.");
#endif
372
373
}

Pedro Gonnet's avatar
Pedro Gonnet committed
374
375
376
377
378
/**
 * @brief Sort the particles in the given cell along all cardinal directions.
 *
 * @param r The #runner.
 * @param c The #cell.
379
 * @param flags Cell flag.
380
381
 * @param cleanup If true, re-build the sorts for the selected flags instead
 *        of just adding them.
382
383
 * @param clock Flag indicating whether to record the timing or not, needed
 *      for recursive calls.
Pedro Gonnet's avatar
Pedro Gonnet committed
384
 */
385
386
void runner_do_sort(struct runner *r, struct cell *c, int flags, int cleanup,
                    int clock) {
387
388

  struct entry *fingers[8];
389
  const int count = c->count;
390
391
  const struct part *parts = c->parts;
  struct xpart *xparts = c->xparts;
Matthieu Schaller's avatar
Matthieu Schaller committed
392
  float buff[8];
393

394
395
  TIMER_TIC;

396
397
  /* We need to do the local sorts plus whatever was requested further up. */
  flags |= c->do_sort;
398
399
400
401
402
  if (cleanup) {
    c->sorted = 0;
  } else {
    flags &= ~c->sorted;
  }
403
  if (flags == 0 && !c->do_sub_sort) return;
404
405

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

409
410
411
412
413
#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
414
415
416
  for (struct cell *finger = c->parent; finger != NULL;
       finger = finger->parent) {
    if (finger->sorted & ~c->sorted) error("Inconsistent sort flags (upward).");
417
  }
418

419
420
  /* Update the sort timer which represents the last time the sorts
     were re-set. */
421
  if (c->sorted == 0) c->ti_sort = r->e->ti_current;
422
#endif
423

424
425
426
427
428
429
430
  /* 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.");
    }
431
432
433
434
435
436
  }

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

    /* Fill in the gaps within the progeny. */
437
    float dx_max_sort = 0.0f;
438
    float dx_max_sort_old = 0.0f;
439
    for (int k = 0; k < 8; k++) {
440
      if (c->progeny[k] != NULL && c->progeny[k]->count > 0) {
441
442
443
444
445
        /* 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);
446
        dx_max_sort = max(dx_max_sort, c->progeny[k]->dx_max_sort);
447
        dx_max_sort_old = max(dx_max_sort_old, c->progeny[k]->dx_max_sort_old);
448
      }
449
    }
450
    c->dx_max_sort = dx_max_sort;
451
    c->dx_max_sort_old = dx_max_sort_old;
452
453

    /* Loop over the 13 different sort arrays. */
454
    for (int j = 0; j < 13; j++) {
455
456
457
458
459

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

      /* Init the particle index offsets. */
460
      int off[8];
461
462
      off[0] = 0;
      for (int k = 1; k < 8; k++)
463
464
465
466
467
468
        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. */
469
      int inds[8];
470
      for (int k = 0; k < 8; k++) {
471
472
        inds[k] = k;
        if (c->progeny[k] != NULL && c->progeny[k]->count > 0) {
473
          fingers[k] = c->progeny[k]->sort[j];
474
475
476
477
478
479
480
          buff[k] = fingers[k]->d;
          off[k] = off[k];
        } else
          buff[k] = FLT_MAX;
      }

      /* Sort the buffer. */
481
482
      for (int i = 0; i < 7; i++)
        for (int k = i + 1; k < 8; k++)
483
          if (buff[inds[k]] < buff[inds[i]]) {
484
            int temp_i = inds[i];
485
486
487
488
489
            inds[i] = inds[k];
            inds[k] = temp_i;
          }

      /* For each entry in the new sort list. */
490
      struct entry *finger = c->sort[j];
491
      for (int ind = 0; ind < count; ind++) {
492
493
494
495
496
497
498
499
500
501

        /* 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. */
502
        for (int k = 1; k < 8 && buff[inds[k]] < buff[inds[k - 1]]; k++) {
503
          int temp_i = inds[k - 1];
504
505
          inds[k - 1] = inds[k];
          inds[k] = temp_i;
Pedro Gonnet's avatar
Pedro Gonnet committed
506
        }
507

508
509
510
      } /* Merge. */

      /* Add a sentinel. */
511
512
      c->sort[j][count].d = FLT_MAX;
      c->sort[j][count].i = 0;
513
514

      /* Mark as sorted. */
515
      atomic_or(&c->sorted, 1 << j);
516
517
518
519
520
521
522
523

    } /* loop over sort arrays. */

  } /* progeny? */

  /* Otherwise, just sort. */
  else {

524
    /* Reset the sort distance */
525
    if (c->sorted == 0) {
526
527
#ifdef SWIFT_DEBUG_CHECKS
      if (xparts != NULL && c->nodeID != engine_rank)
528
        error("Have non-NULL xparts in foreign cell");
529
#endif
530
531
532
533
534
535
536
537

      /* 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;
        }
538
      }
539
540
      c->dx_max_sort_old = 0.f;
      c->dx_max_sort = 0.f;
541
542
    }

543
    /* Fill the sort array. */
544
    for (int k = 0; k < count; k++) {
545
      const double px[3] = {parts[k].x[0], parts[k].x[1], parts[k].x[2]};
546
      for (int j = 0; j < 13; j++)
547
        if (flags & (1 << j)) {
548
549
550
551
          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];
552
        }
553
    }
554
555

    /* Add the sentinel and sort. */
556
    for (int j = 0; j < 13; j++)
557
      if (flags & (1 << j)) {
558
559
560
        c->sort[j][count].d = FLT_MAX;
        c->sort[j][count].i = 0;
        runner_do_sort_ascending(c->sort[j], count);
561
        atomic_or(&c->sorted, 1 << j);
562
563
564
      }
  }

565
#ifdef SWIFT_DEBUG_CHECKS
Matthieu Schaller's avatar
Matthieu Schaller committed
566
  /* Verify the sorting. */
567
  for (int j = 0; j < 13; j++) {
568
    if (!(flags & (1 << j))) continue;
569
    struct entry *finger = c->sort[j];
570
    for (int k = 1; k < count; k++) {
571
572
573
574
575
      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
576

577
578
579
580
  /* 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
581
582
583
  for (struct cell *finger = c->parent; finger != NULL;
       finger = finger->parent) {
    if (finger->sorted & ~c->sorted) error("Inconsistent sort flags.");
584
  }
585
#endif
586

587
588
589
590
591
  /* Clear the cell's sort flags. */
  c->do_sort = 0;
  c->do_sub_sort = 0;
  c->requires_sorts = 0;

592
593
594
  if (clock) TIMER_TOC(timer_dosort);
}

595
/**
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 * @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? */
614
  if (!cell_is_active_gravity(c, e)) return;
615
616

  /* Reset the gravity acceleration tensors */
617
  gravity_field_tensors_init(&c->multipole->pot, e->ti_current);
618
619
620
621
622
623
624
625
626
627
628

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

629
/**
630
631
632
633
634
 * @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.
635
 * @param timer Are we timing this ?
636
 */
637
void runner_do_extra_ghost(struct runner *r, struct cell *c, int timer) {
638

639
#ifdef EXTRA_HYDRO_LOOP
640

641
  struct part *restrict parts = c->parts;
642
  struct xpart *restrict xparts = c->xparts;
643
  const int count = c->count;
644
  const struct engine *e = r->e;
645
  const struct cosmology *cosmo = e->cosmology;
646

647
648
  TIMER_TIC;

649
  /* Anything to do here? */
650
  if (!cell_is_active_hydro(c, e)) return;
651

652
653
654
  /* Recurse? */
  if (c->split) {
    for (int k = 0; k < 8; k++)
655
      if (c->progeny[k] != NULL) runner_do_extra_ghost(r, c->progeny[k], 0);
656
657
658
659
660
661
662
  } 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];
663
      struct xpart *restrict xp = &xparts[i];
664

665
      if (part_is_active(p, e)) {
666

667
        /* Finish the gradient calculation */
668
        hydro_end_gradient(p);
669
670
671
672
673
674
675
676
677
678
679

        /* 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);
680
681
682
      }
    }
  }
683

684
685
  if (timer) TIMER_TOC(timer_do_extra_ghost);

686
687
#else
  error("SWIFT was not compiled with the extra hydro loop activated.");
688
#endif
689
}
690

691
/**
692
693
 * @brief Intermediate task after the density to check that the smoothing
 * lengths are correct.
694
 *
Pedro Gonnet's avatar
Pedro Gonnet committed
695
 * @param r The runner thread.
696
 * @param c The cell.
697
 * @param timer Are we timing this ?
698
 */
699
void runner_do_ghost(struct runner *r, struct cell *c, int timer) {
700

Matthieu Schaller's avatar
Matthieu Schaller committed
701
702
  struct part *restrict parts = c->parts;
  struct xpart *restrict xparts = c->xparts;
703
  const struct engine *e = r->e;
704
  const struct space *s = e->s;
705
706
  const struct hydro_space *hs = &s->hs;
  const struct cosmology *cosmo = e->cosmology;
lhausamm's avatar
lhausamm committed
707
  const struct chemistry_global_data *chemistry = e->chemistry;
708
  const float hydro_h_max = e->hydro_properties->h_max;
709
710
711
  const float eps = e->hydro_properties->h_tolerance;
  const float hydro_eta_dim =
      pow_dimension(e->hydro_properties->eta_neighbours);
712
  const int max_smoothing_iter = e->hydro_properties->max_smoothing_iterations;
713
  int redo = 0, count = 0;
714

715
716
  TIMER_TIC;

717
  /* Anything to do here? */
718
  if (!cell_is_active_hydro(c, e)) return;
719

720
721
  /* Recurse? */
  if (c->split) {
Matthieu Schaller's avatar
Matthieu Schaller committed
722
    for (int k = 0; k < 8; k++)
723
724
      if (c->progeny[k] != NULL) runner_do_ghost(r, c->progeny[k], 0);
  } else {
725

726
    /* Init the list of active particles that have to be updated. */
727
    int *pid = NULL;
728
    if ((pid = (int *)malloc(sizeof(int) * c->count)) == NULL)
729
      error("Can't allocate memory for pid.");
730
731
732
733
734
    for (int k = 0; k < c->count; k++)
      if (part_is_active(&parts[k], e)) {
        pid[count] = k;
        ++count;
      }
735

736
737
738
    /* While there are particles that need to be updated... */
    for (int num_reruns = 0; count > 0 && num_reruns < max_smoothing_iter;
         num_reruns++) {
739

740
741
      /* Reset the redo-count. */
      redo = 0;
742

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

746
        /* Get a direct pointer on the part. */
747
748
        struct part *p = &parts[pid[i]];
        struct xpart *xp = &xparts[pid[i]];
749

750
#ifdef SWIFT_DEBUG_CHECKS
751
        /* Is this part within the timestep? */
752
753
754
        if (!part_is_active(p, e)) error("Ghost applied to inactive particle");
#endif

755
756
757
758
759
        /* 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;
760
        int has_no_neighbours = 0;
761

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

764
765
766
          /* Flag that there were no neighbours */
          has_no_neighbours = 1;

767
768
          /* Double h and try again */
          h_new = 2.f * h_old;
769

770
        } else {
Matthieu Schaller's avatar
Matthieu Schaller committed
771

772
          /* Finish the density calculation */
773
          hydro_end_density(p, cosmo);
774
          chemistry_end_density(p, chemistry, cosmo);
775

776
777
778
779
780
781
782
          /* 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;
783

784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
          /* Skip if h is already h_max and we don't have enough neighbours */
          if ((p->h >= hydro_h_max) && (f < 0.f)) {

          /* We have a particle whose smoothing length is already set (wants to
           * be larger but has already hit the maximum). So, just tidy up as if
           * the smoothing length had converged correctly  */

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

#endif /* EXTRA_HYDRO_LOOP */

            continue;
          }

          /* Normal case: Use Newton-Raphson to get a better value of h */

824
825
          /* Avoid floating point exception from f_prime = 0 */
          h_new = h_old - f / (f_prime + FLT_MIN);
826
827
828
829
830
831
832
833
834
835
836
837
838
839

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

841
          /* Ok, correct then */
842
          p->h = h_new;
843

844
845
          /* If below the absolute maximum, try again */
          if (p->h < hydro_h_max) {
846

847
848
849
            /* Flag for another round of fun */
            pid[redo] = pid[i];
            redo += 1;
850

851
            /* Re-initialise everything */
852
            hydro_init_part(p, hs);
853
            chemistry_init_part(p, chemistry);
854
855
856

            /* Off we go ! */
            continue;
857

858
859
860
861
          } else {

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

            /* Do some damage control if no neighbours at all were found */
864
            if (has_no_neighbours) {
865
              hydro_part_has_no_neighbours(p, xp, cosmo);
866
867
              chemistry_part_has_no_neighbours(p, xp, chemistry, cosmo);
            }
868
          }
869
        }
870

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

873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
#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
888
        /* As of here, particle force variables will be set. */
889

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

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

896
897
        /* Prepare the particle for the force loop over neighbours */
        hydro_reset_acceleration(p);
898
899

#endif /* EXTRA_HYDRO_LOOP */
900
901
      }

902
903
      /* We now need to treat the particles whose smoothing length had not
       * converged again */
904

905
906
907
      /* Re-set the counter for the next loop (potentially). */
      count = redo;
      if (count > 0) {
908

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

912
913
          /* 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
914

915
916
917
918
#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
919

920
921
            /* Self-interaction? */
            if (l->t->type == task_type_self)
922
              runner_doself_subset_branch_density(r, finger, parts, pid, count);
Matthieu Schaller's avatar
Matthieu Schaller committed
923

924
925
            /* Otherwise, pair interaction? */
            else if (l->t->type == task_type_pair) {
926

927
928
              /* Left or right? */
              if (l->t->ci == finger)
James Willis's avatar
James Willis committed
929
930
                runner_dopair_subset_branch_density(r, finger, parts, pid,
                                                    count, l->t->cj);
931
              else
James Willis's avatar
James Willis committed
932
933
                runner_dopair_subset_branch_density(r, finger, parts, pid,
                                                    count, l->t->ci);
934
            }
935

936
937
938
939
            /* 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);
940

941
942
943
944
945
946
947
948
949
950
951
            /* 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);
            }