runner.c 80.8 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

Loic Hausammann's avatar
Loic Hausammann committed
99
100
/* Import the stars loop functions. */
#include "runner_doiact_stars.h"
101

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

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

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

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

  if (timer) TIMER_TOC(timer_dosource);
}

138
139
140
141
142
143
144
145
/**
 * @brief Intermediate task after the density to check that the smoothing
 * lengths are correct.
 *
 * @param r The runner thread.
 * @param c The cell.
 * @param timer Are we timing this ?
 */
Loic Hausammann's avatar
Loic Hausammann committed
146
void runner_do_stars_ghost(struct runner *r, struct cell *c, int timer) {
147

148
  struct spart *restrict sparts = c->stars.parts;
149
150
  const struct engine *e = r->e;
  const struct cosmology *cosmo = e->cosmology;
Loic Hausammann's avatar
Loic Hausammann committed
151
  const struct stars_props *stars_properties = e->stars_properties;
Loic Hausammann's avatar
Loic Hausammann committed
152
  const float stars_h_max = stars_properties->h_max;
153
  const float eps = stars_properties->h_tolerance;
154
  const float stars_eta_dim = pow_dimension(stars_properties->eta_neighbours);
155
156
  const int max_smoothing_iter = stars_properties->max_smoothing_iterations;
  int redo = 0, scount = 0;
157
158
159
160

  TIMER_TIC;

  /* Anything to do here? */
Loic Hausammann's avatar
Loic Hausammann committed
161
  if (!cell_is_active_stars(c, e)) return;
162
163
164
165

  /* Recurse? */
  if (c->split) {
    for (int k = 0; k < 8; k++)
Loic Hausammann's avatar
Loic Hausammann committed
166
      if (c->progeny[k] != NULL) runner_do_stars_ghost(r, c->progeny[k], 0);
167
168
169
170
  } else {

    /* Init the list of active particles that have to be updated. */
    int *sid = NULL;
171
    if ((sid = (int *)malloc(sizeof(int) * c->stars.count)) == NULL)
Loic Hausammann's avatar
Loic Hausammann committed
172
      error("Can't allocate memory for sid.");
173
    for (int k = 0; k < c->stars.count; k++)
174
      if (spart_is_active(&sparts[k], e)) {
175
176
        sid[scount] = k;
        ++scount;
177
178
179
      }

    /* While there are particles that need to be updated... */
180
    for (int num_reruns = 0; scount > 0 && num_reruns < max_smoothing_iter;
181
182
183
184
185
186
         num_reruns++) {

      /* Reset the redo-count. */
      redo = 0;

      /* Loop over the remaining active parts in this cell. */
187
      for (int i = 0; i < scount; i++) {
188
189
190
191
192
193

        /* Get a direct pointer on the part. */
        struct spart *sp = &sparts[sid[i]];

#ifdef SWIFT_DEBUG_CHECKS
        /* Is this part within the timestep? */
194
195
        if (!spart_is_active(sp, e))
          error("Ghost applied to inactive particle");
196
197
198
199
200
201
202
203
204
#endif

        /* Get some useful values */
        const float h_old = sp->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;
        int has_no_neighbours = 0;

205
        if (sp->density.wcount == 0.f) { /* No neighbours case */
206
207
208
209
210
211
212
213
214

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

          /* Double h and try again */
          h_new = 2.f * h_old;
        } else {

          /* Finish the density calculation */
Loic Hausammann's avatar
Loic Hausammann committed
215
          stars_end_density(sp, cosmo);
216
217

          /* Compute one step of the Newton-Raphson scheme */
218
          const float n_sum = sp->density.wcount * h_old_dim;
Loic Hausammann's avatar
Loic Hausammann committed
219
          const float n_target = stars_eta_dim;
220
221
          const float f = n_sum - n_target;
          const float f_prime =
222
223
              sp->density.wcount_dh * h_old_dim +
              hydro_dimension * sp->density.wcount * h_old_dim_minus_one;
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244

          /* Avoid floating point exception from f_prime = 0 */
          h_new = h_old - f / (f_prime + FLT_MIN);
#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) {

          /* Ok, correct then */
          sp->h = h_new;

          /* If below the absolute maximum, try again */
Loic Hausammann's avatar
Loic Hausammann committed
245
          if (sp->h < stars_h_max) {
246
247
248
249
250
251

            /* Flag for another round of fun */
            sid[redo] = sid[i];
            redo += 1;

            /* Re-initialise everything */
Loic Hausammann's avatar
Loic Hausammann committed
252
            stars_init_spart(sp);
253
254
255
256
257
258
259

            /* Off we go ! */
            continue;

          } else {

            /* Ok, this particle is a lost cause... */
Loic Hausammann's avatar
Loic Hausammann committed
260
            sp->h = stars_h_max;
261
262
263

            /* Do some damage control if no neighbours at all were found */
            if (has_no_neighbours) {
Loic Hausammann's avatar
Loic Hausammann committed
264
              stars_spart_has_no_neighbours(sp, cosmo);
265
266
267
268
            }
          }
        }

269
        /* We now have a particle whose smoothing length has converged */
270

Loic Hausammann's avatar
Loic Hausammann committed
271
        /* Compute the stellar evolution  */
272
        stars_evolve_spart(sp, stars_properties, cosmo);
273
274
275
276
277
278
      }

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

      /* Re-set the counter for the next loop (potentially). */
279
280
      scount = redo;
      if (scount > 0) {
281
282
283
284
285

        /* Climb up the cell hierarchy. */
        for (struct cell *finger = c; finger != NULL; finger = finger->parent) {

          /* Run through this cell's density interactions. */
286
          for (struct link *l = finger->hydro.density; l != NULL; l = l->next) {
287
288
289
290
291
292
293
294

#ifdef SWIFT_DEBUG_CHECKS
            if (l->t->ti_run < r->e->ti_current)
              error("Density task should have been run.");
#endif

            /* Self-interaction? */
            if (l->t->type == task_type_self)
295
296
              runner_doself_subset_branch_stars_density(r, finger, sparts, sid,
                                                        scount);
297
298
299
300
301
302

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

              /* Left or right? */
              if (l->t->ci == finger)
303
304
                runner_dopair_subset_branch_stars_density(
                    r, finger, sparts, sid, scount, l->t->cj);
305
              else
306
307
                runner_dopair_subset_branch_stars_density(
                    r, finger, sparts, sid, scount, l->t->ci);
308
309
310
311
            }

            /* Otherwise, sub-self interaction? */
            else if (l->t->type == task_type_sub_self)
312
313
              runner_dosub_subset_stars_density(r, finger, sparts, sid, scount,
                                                NULL, -1, 1);
314
315
316
317
318
319

            /* Otherwise, sub-pair interaction? */
            else if (l->t->type == task_type_sub_pair) {

              /* Left or right? */
              if (l->t->ci == finger)
320
321
                runner_dosub_subset_stars_density(r, finger, sparts, sid,
                                                  scount, l->t->cj, -1, 1);
322
              else
323
324
                runner_dosub_subset_stars_density(r, finger, sparts, sid,
                                                  scount, l->t->ci, -1, 1);
325
326
327
328
329
330
            }
          }
        }
      }
    }

331
332
    if (scount) {
      error("Smoothing length failed to converge on %i particles.", scount);
333
334
335
336
337
338
    }

    /* Be clean */
    free(sid);
  }

Loic Hausammann's avatar
Loic Hausammann committed
339
  if (timer) TIMER_TOC(timer_do_stars_ghost);
340
341
}

Tom Theuns's avatar
Tom Theuns committed
342
343
344
/**
 * @brief Calculate gravity acceleration from external potential
 *
Matthieu Schaller's avatar
Matthieu Schaller committed
345
346
347
 * @param r runner task
 * @param c cell
 * @param timer 1 if the time is to be recorded.
Tom Theuns's avatar
Tom Theuns committed
348
 */
349
void runner_do_grav_external(struct runner *r, struct cell *c, int timer) {
Tom Theuns's avatar
Tom Theuns committed
350

351
352
  struct gpart *restrict gparts = c->grav.parts;
  const int gcount = c->grav.count;
353
354
355
  const struct engine *e = r->e;
  const struct external_potential *potential = e->external_potential;
  const struct phys_const *constants = e->physical_constants;
356
  const double time = r->e->time;
Matthieu Schaller's avatar
Matthieu Schaller committed
357

358
  TIMER_TIC;
Tom Theuns's avatar
Tom Theuns committed
359

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

Tom Theuns's avatar
Tom Theuns committed
363
364
  /* Recurse? */
  if (c->split) {
Matthieu Schaller's avatar
Matthieu Schaller committed
365
    for (int k = 0; k < 8; k++)
366
      if (c->progeny[k] != NULL) runner_do_grav_external(r, c->progeny[k], 0);
367
  } else {
368

369
370
    /* Loop over the gparts in this cell. */
    for (int i = 0; i < gcount; i++) {
371

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

375
      /* Is this part within the time step? */
376
      if (gpart_is_active(gp, e)) {
377
378
        external_gravity_acceleration(time, potential, constants, gp);
      }
379
    }
380
  }
Matthieu Schaller's avatar
Matthieu Schaller committed
381

382
  if (timer) TIMER_TOC(timer_dograv_external);
Tom Theuns's avatar
Tom Theuns committed
383
384
}

385
386
387
388
389
390
391
392
393
/**
 * @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) {

394
395
  struct gpart *restrict gparts = c->grav.parts;
  const int gcount = c->grav.count;
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
  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
420
/**
421
422
 * @brief Calculate change in thermal state of particles induced
 * by radiative cooling and heating.
Stefan Arridge's avatar
Stefan Arridge committed
423
424
425
426
427
428
429
 *
 * @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) {

430
  const struct engine *e = r->e;
431
432
  const struct cosmology *cosmo = e->cosmology;
  const int with_cosmology = (e->policy & engine_policy_cosmology);
433
434
  const struct cooling_function_data *cooling_func = e->cooling_func;
  const struct phys_const *constants = e->physical_constants;
435
  const struct unit_system *us = e->internal_units;
436
  const struct hydro_props *hydro_props = e->hydro_properties;
437
  const double time_base = e->time_base;
438
  const integertime_t ti_current = e->ti_current;
439
440
441
  struct part *restrict parts = c->hydro.parts;
  struct xpart *restrict xparts = c->hydro.xparts;
  const int count = c->hydro.count;
Stefan Arridge's avatar
Stefan Arridge committed
442
443
444

  TIMER_TIC;

445
  /* Anything to do here? */
446
  if (!cell_is_active_hydro(c, e)) return;
447

Stefan Arridge's avatar
Stefan Arridge committed
448
449
450
451
  /* Recurse? */
  if (c->split) {
    for (int k = 0; k < 8; k++)
      if (c->progeny[k] != NULL) runner_do_cooling(r, c->progeny[k], 0);
452
  } else {
Stefan Arridge's avatar
Stefan Arridge committed
453

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

457
458
459
      /* 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
460

461
      if (part_is_active(p, e)) {
462

463
        double dt_cool, dt_therm;
464
465
466
        if (with_cosmology) {
          const integertime_t ti_step = get_integer_timestep(p->time_bin);
          const integertime_t ti_begin =
467
468
              get_integer_time_begin(ti_current - 1, p->time_bin);

469
470
          dt_cool =
              cosmology_get_delta_time(cosmo, ti_begin, ti_begin + ti_step);
471
472
473
          dt_therm = cosmology_get_therm_kick_factor(e->cosmology, ti_begin,
                                                     ti_begin + ti_step);

474
475
        } else {
          dt_cool = get_timestep(p->time_bin, time_base);
476
          dt_therm = get_timestep(p->time_bin, time_base);
477
        }
478

479
        /* Let's cool ! */
480
481
        cooling_cool_part(constants, us, cosmo, hydro_props, cooling_func, p,
                          xp, dt_cool, dt_therm);
482
      }
Stefan Arridge's avatar
Stefan Arridge committed
483
484
485
486
487
488
    }
  }

  if (timer) TIMER_TOC(timer_do_cooling);
}

Matthieu Schaller's avatar
Matthieu Schaller committed
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
/**
 *
 */
void runner_do_star_formation(struct runner *r, struct cell *c, int timer) {

  const struct engine *e = r->e;

  TIMER_TIC;

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

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

  if (timer) TIMER_TOC(timer_do_star_formation);
}

Pedro Gonnet's avatar
Pedro Gonnet committed
511
512
513
514
515
516
/**
 * @brief Sort the entries in ascending order using QuickSort.
 *
 * @param sort The entries
 * @param N The number of entries.
 */
517
void runner_do_sort_ascending(struct entry *sort, int N) {
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571

  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
572
        }
573
574
575
576
577
578
579
580
581
582
583
584
      } 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
585
    }
586
587
588
  }
}

Matthieu Schaller's avatar
Matthieu Schaller committed
589
590
591
592
593
594
595
596
/**
 * @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.
 */
597
void runner_check_sorts(struct cell *c, int flags) {
Matthieu Schaller's avatar
Matthieu Schaller committed
598
599

#ifdef SWIFT_DEBUG_CHECKS
600
  if (flags & ~c->hydro.sorted) error("Inconsistent sort flags (downward)!");
601
602
  if (c->split)
    for (int k = 0; k < 8; k++)
603
604
      if (c->progeny[k] != NULL && c->progeny[k]->hydro.count > 0)
        runner_check_sorts(c->progeny[k], c->hydro.sorted);
Matthieu Schaller's avatar
Matthieu Schaller committed
605
606
607
#else
  error("Calling debugging code without debugging flag activated.");
#endif
608
609
}

Pedro Gonnet's avatar
Pedro Gonnet committed
610
611
612
613
614
/**
 * @brief Sort the particles in the given cell along all cardinal directions.
 *
 * @param r The #runner.
 * @param c The #cell.
615
 * @param flags Cell flag.
616
617
 * @param cleanup If true, re-build the sorts for the selected flags instead
 *        of just adding them.
618
619
 * @param clock Flag indicating whether to record the timing or not, needed
 *      for recursive calls.
Pedro Gonnet's avatar
Pedro Gonnet committed
620
 */
621
622
void runner_do_sort(struct runner *r, struct cell *c, int flags, int cleanup,
                    int clock) {
623
624

  struct entry *fingers[8];
625
626
627
  const int count = c->hydro.count;
  const struct part *parts = c->hydro.parts;
  struct xpart *xparts = c->hydro.xparts;
Matthieu Schaller's avatar
Matthieu Schaller committed
628
  float buff[8];
629

630
631
  TIMER_TIC;

632
  /* We need to do the local sorts plus whatever was requested further up. */
633
  flags |= c->hydro.do_sort;
634
  if (cleanup) {
635
    c->hydro.sorted = 0;
636
  } else {
637
    flags &= ~c->hydro.sorted;
638
  }
639
  if (flags == 0 && !c->hydro.do_sub_sort) return;
640
641

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

645
646
#ifdef SWIFT_DEBUG_CHECKS
  /* Make sure the sort flags are consistent (downward). */
647
  runner_check_sorts(c, c->hydro.sorted);
648
649

  /* Make sure the sort flags are consistent (upard). */
Pedro Gonnet's avatar
Pedro Gonnet committed
650
651
  for (struct cell *finger = c->parent; finger != NULL;
       finger = finger->parent) {
652
653
    if (finger->hydro.sorted & ~c->hydro.sorted)
      error("Inconsistent sort flags (upward).");
654
  }
655

656
657
  /* Update the sort timer which represents the last time the sorts
     were re-set. */
658
  if (c->hydro.sorted == 0) c->hydro.ti_sort = r->e->ti_current;
659
#endif
660

661
662
  /* start by allocating the entry arrays in the requested dimensions. */
  for (int j = 0; j < 13; j++) {
663
664
665
    if ((flags & (1 << j)) && c->hydro.sort[j] == NULL) {
      if ((c->hydro.sort[j] = (struct entry *)malloc(sizeof(struct entry) *
                                                     (count + 1))) == NULL)
666
667
        error("Failed to allocate sort memory.");
    }
668
669
670
671
672
673
  }

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

    /* Fill in the gaps within the progeny. */
674
    float dx_max_sort = 0.0f;
675
    float dx_max_sort_old = 0.0f;
676
    for (int k = 0; k < 8; k++) {
677
      if (c->progeny[k] != NULL && c->progeny[k]->hydro.count > 0) {
678
679
        /* Only propagate cleanup if the progeny is stale. */
        runner_do_sort(r, c->progeny[k], flags,
680
                       cleanup && (c->progeny[k]->hydro.dx_max_sort >
681
682
                                   space_maxreldx * c->progeny[k]->dmin),
                       0);
683
684
685
        dx_max_sort = max(dx_max_sort, c->progeny[k]->hydro.dx_max_sort);
        dx_max_sort_old =
            max(dx_max_sort_old, c->progeny[k]->hydro.dx_max_sort_old);
686
      }
687
    }
688
689
    c->hydro.dx_max_sort = dx_max_sort;
    c->hydro.dx_max_sort_old = dx_max_sort_old;
690
691

    /* Loop over the 13 different sort arrays. */
692
    for (int j = 0; j < 13; j++) {
693
694
695
696
697

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

      /* Init the particle index offsets. */
698
      int off[8];
699
700
      off[0] = 0;
      for (int k = 1; k < 8; k++)
701
        if (c->progeny[k - 1] != NULL)
702
          off[k] = off[k - 1] + c->progeny[k - 1]->hydro.count;
703
704
705
706
        else
          off[k] = off[k - 1];

      /* Init the entries and indices. */
707
      int inds[8];
708
      for (int k = 0; k < 8; k++) {
709
        inds[k] = k;
710
711
        if (c->progeny[k] != NULL && c->progeny[k]->hydro.count > 0) {
          fingers[k] = c->progeny[k]->hydro.sort[j];
712
713
714
715
716
717
718
          buff[k] = fingers[k]->d;
          off[k] = off[k];
        } else
          buff[k] = FLT_MAX;
      }

      /* Sort the buffer. */
719
720
      for (int i = 0; i < 7; i++)
        for (int k = i + 1; k < 8; k++)
721
          if (buff[inds[k]] < buff[inds[i]]) {
722
            int temp_i = inds[i];
723
724
725
726
727
            inds[i] = inds[k];
            inds[k] = temp_i;
          }

      /* For each entry in the new sort list. */
728
      struct entry *finger = c->hydro.sort[j];
729
      for (int ind = 0; ind < count; ind++) {
730
731
732
733
734
735
736
737
738
739

        /* 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. */
740
        for (int k = 1; k < 8 && buff[inds[k]] < buff[inds[k - 1]]; k++) {
741
          int temp_i = inds[k - 1];
742
743
          inds[k - 1] = inds[k];
          inds[k] = temp_i;
Pedro Gonnet's avatar
Pedro Gonnet committed
744
        }
745

746
747
748
      } /* Merge. */

      /* Add a sentinel. */
749
750
      c->hydro.sort[j][count].d = FLT_MAX;
      c->hydro.sort[j][count].i = 0;
751
752

      /* Mark as sorted. */
753
      atomic_or(&c->hydro.sorted, 1 << j);
754
755
756
757
758
759
760
761

    } /* loop over sort arrays. */

  } /* progeny? */

  /* Otherwise, just sort. */
  else {

762
    /* Reset the sort distance */
763
    if (c->hydro.sorted == 0) {
764
765
#ifdef SWIFT_DEBUG_CHECKS
      if (xparts != NULL && c->nodeID != engine_rank)
766
        error("Have non-NULL xparts in foreign cell");
767
#endif
768
769
770
771
772
773
774
775

      /* 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;
        }
776
      }
777
778
      c->hydro.dx_max_sort_old = 0.f;
      c->hydro.dx_max_sort = 0.f;
779
780
    }

781
    /* Fill the sort array. */
782
    for (int k = 0; k < count; k++) {
783
      const double px[3] = {parts[k].x[0], parts[k].x[1], parts[k].x[2]};
784
      for (int j = 0; j < 13; j++)
785
        if (flags & (1 << j)) {
786
787
788
789
          c->hydro.sort[j][k].i = k;
          c->hydro.sort[j][k].d = px[0] * runner_shift[j][0] +
                                  px[1] * runner_shift[j][1] +
                                  px[2] * runner_shift[j][2];
790
        }
791
    }
792
793

    /* Add the sentinel and sort. */
794
    for (int j = 0; j < 13; j++)
795
      if (flags & (1 << j)) {
796
797
798
799
        c->hydro.sort[j][count].d = FLT_MAX;
        c->hydro.sort[j][count].i = 0;
        runner_do_sort_ascending(c->hydro.sort[j], count);
        atomic_or(&c->hydro.sorted, 1 << j);
800
801
802
      }
  }

803
#ifdef SWIFT_DEBUG_CHECKS
Matthieu Schaller's avatar
Matthieu Schaller committed
804
  /* Verify the sorting. */
805
  for (int j = 0; j < 13; j++) {
806
    if (!(flags & (1 << j))) continue;
807
    struct entry *finger = c->hydro.sort[j];
808
    for (int k = 1; k < count; k++) {
809
810
811
812
813
      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
814

815
816
817
818
  /* 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
819
820
  for (struct cell *finger = c->parent; finger != NULL;
       finger = finger->parent) {
821
822
    if (finger->hydro.sorted & ~c->hydro.sorted)
      error("Inconsistent sort flags.");
823
  }
824
#endif
825

826
  /* Clear the cell's sort flags. */
827
828
829
  c->hydro.do_sort = 0;
  c->hydro.do_sub_sort = 0;
  c->hydro.requires_sorts = 0;
830

831
832
833
  if (clock) TIMER_TOC(timer_dosort);
}

834
/**
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
 * @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? */
853
  if (!cell_is_active_gravity(c, e)) return;
854
855

  /* Reset the gravity acceleration tensors */
856
  gravity_field_tensors_init(&c->grav.multipole->pot, e->ti_current);
857
858
859
860
861
862
863
864
865
866
867

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

868
/**
869
870
871
872
873
 * @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.
874
 * @param timer Are we timing this ?
875
 */
876
void runner_do_extra_ghost(struct runner *r, struct cell *c, int timer) {
877

878
#ifdef EXTRA_HYDRO_LOOP
879

880
881
882
  struct part *restrict parts = c->hydro.parts;
  struct xpart *restrict xparts = c->hydro.xparts;
  const int count = c->hydro.count;
883
  const struct engine *e = r->e;
884
  const integertime_t ti_end = e->ti_current;
Josh Borrow's avatar
Josh Borrow committed
885
  const int with_cosmology = (e->policy & engine_policy_cosmology);
886
  const double time_base = e->time_base;
887
  const struct cosmology *cosmo = e->cosmology;
888

889
890
  TIMER_TIC;

891
  /* Anything to do here? */
892
  if (!cell_is_active_hydro(c, e)) return;
893

894
895
896
  /* Recurse? */
  if (c->split) {
    for (int k = 0; k < 8; k++)
897
      if (c->progeny[k] != NULL) runner_do_extra_ghost(r, c->progeny[k], 0);
898
899
900
901
902
903
904
  } 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];
905
      struct xpart *restrict xp = &xparts[i];
906

907
      if (part_is_active(p, e)) {
908

909
        /* Finish the gradient calculation */
910
        hydro_end_gradient(p);
911
912
913

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

Josh Borrow's avatar
Josh Borrow committed
914
915
916
        /* Calculate the time-step for passing to hydro_prepare_force.
         * This is the physical time between the start and end of the time-step
         * without any scale-factor powers. */
917
918
919
920
921
922
923
        double dt_alpha;
        if (with_cosmology) {
          const integertime_t ti_step = get_integer_timestep(p->time_bin);
          dt_alpha = cosmology_get_delta_time(cosmo, ti_end - ti_step, ti_end);
        } else {
          dt_alpha = get_timestep(p->time_bin, time_base);
        }
924

925
        /* Compute variables required for the force loop */
926
        hydro_prepare_force(p, xp, cosmo, dt_alpha);
927
928
929
930
931
932

        /* 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);
933
934
935
      }
    }
  }
936

937
938
  if (timer) TIMER_TOC(timer_do_extra_ghost);

939
940
#else
  error("SWIFT was not compiled with the extra hydro loop activated.");
941
#endif
942
}
943

944
/**
945
946
 * @brief Intermediate task after the density to check that the smoothing
 * lengths are correct.
947
 *
Pedro Gonnet's avatar
Pedro Gonnet committed
948
 * @param r The runner thread.
949
 * @param c The cell.
950
 * @param timer Are we timing this ?
951
 */
952
void runner_do_ghost(struct runner *r, struct cell *c, int timer) {
953

954
955
  struct part *restrict parts = c->hydro.parts;
  struct xpart *restrict xparts = c->hydro.xparts;
956
  const struct engine *e = r->e;
957
  const struct space *s = e->s;
958
959
  const struct hydro_space *hs = &s->hs;
  const struct cosmology *cosmo = e->cosmology;
lhausamm's avatar
lhausamm committed
960
  const struct chemistry_global_data *chemistry = e->chemistry;
961
  const float hydro_h_max = e->hydro_properties->h_max;
962
963
964
  const float eps = e->hydro_properties->h_tolerance;
  const float hydro_eta_dim =
      pow_dimension(e->hydro_properties->eta_neighbours);
965
  const int max_smoothing_iter = e->hydro_properties->max_smoothing_iterations;
966
  int redo = 0, count = 0;