runner.c 85.4 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"
Loikki's avatar
Loikki committed
56
#include "logger.h"
57
#include "minmax.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_grav.h"
99

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

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

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

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

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

  if (timer) TIMER_TOC(timer_dosource);
}

139
140
141
142
143
144
145
146
/**
 * @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
147
void runner_do_stars_ghost(struct runner *r, struct cell *c, int timer) {
148

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

  TIMER_TIC;

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

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

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

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

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

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

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

#ifdef SWIFT_DEBUG_CHECKS
        /* Is this part within the timestep? */
195
196
        if (!spart_is_active(sp, e))
          error("Ghost applied to inactive particle");
197
198
199
200
201
202
203
204
205
#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;

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

          /* 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
216
          stars_end_density(sp, cosmo);
217
218

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

          /* 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
246
          if (sp->h < stars_h_max) {
247
248
249
250
251
252

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

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

            /* Off we go ! */
            continue;

          } else {

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

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

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

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

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

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

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

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

#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)
296
297
              runner_doself_subset_branch_stars_density(r, finger, sparts, sid,
                                                        scount);
298
299
300
301
302
303

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

431
  const struct engine *e = r->e;
432
433
  const struct cosmology *cosmo = e->cosmology;
  const int with_cosmology = (e->policy & engine_policy_cosmology);
434
435
  const struct cooling_function_data *cooling_func = e->cooling_func;
  const struct phys_const *constants = e->physical_constants;
436
  const struct unit_system *us = e->internal_units;
437
  const struct hydro_props *hydro_props = e->hydro_properties;
438
  const double time_base = e->time_base;
439
  const integertime_t ti_current = e->ti_current;
440
441
442
  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
443
444
445

  TIMER_TIC;

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

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

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

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

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

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

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

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

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

  if (timer) TIMER_TOC(timer_do_cooling);
}

Matthieu Schaller's avatar
Matthieu Schaller committed
490
491
492
493
494
495
/**
 *
 */
void runner_do_star_formation(struct runner *r, struct cell *c, int timer) {

  const struct engine *e = r->e;
496
  const struct cosmology *cosmo = e->cosmology;
497
498
499
  const int count = c->hydro.count;
  struct part *restrict parts = c->hydro.parts;
  struct xpart *restrict xparts = c->hydro.xparts;
Matthieu Schaller's avatar
Matthieu Schaller committed
500
501
502
503
504
505
506
507
508
509
510

  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 {
511
512
513
514
515
516
517
518
519
520

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

      /* Get a handle on the part. */
      struct part *restrict p = &parts[k];
      struct xpart *restrict xp = &xparts[k];

      if (part_is_active(p, e)) {

521
522
        const float rho = hydro_get_physical_density(p, cosmo);

523
        // MATTHIEU: Temporary star-formation law
524
        // Do not use this at home.
525
        if (rho > 1.7e7 && e->step > 2) {
Matthieu Schaller's avatar
Matthieu Schaller committed
526
527
          message("c->cellID=%d Removing particle id=%lld rho=%e", c->cellID,
                  p->id, rho);
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

          /* Destroy the gas particle and get it's gpart friend */
          struct gpart *gp = cell_convert_part_to_gpart(e, c, p, xp);

          /* Create a fresh (empty) spart */
          struct spart *sp = cell_add_spart(e, c);

          /* Assign the ID back */
          sp->id = gp->id_or_neg_offset;
          gp->type = swift_type_stars;

          /* Re-link things */
          sp->gpart = gp;
          gp->id_or_neg_offset = -(sp - e->s->sparts);

          /* Synchronize clocks */
          gp->time_bin = sp->time_bin;

          /* Synchronize masses, positions and velocities */
          sp->mass = gp->mass;
          sp->x[0] = gp->x[0];
          sp->x[1] = gp->x[1];
          sp->x[2] = gp->x[2];
          sp->v[0] = gp->v_full[0];
          sp->v[1] = gp->v_full[1];
          sp->v[2] = gp->v_full[2];

#ifdef SWIFT_DEBUG_CHECKS
          sp->ti_kick = gp->ti_kick;
#endif

          /* Set a smoothing length */
          sp->h = max(c->stars.h_max, c->hydro.h_max);

          /* Set everything to a valid state */
          stars_init_spart(sp);
564
565
566
        }
      }
    }
Matthieu Schaller's avatar
Matthieu Schaller committed
567
568
  }

569
570
571
572
573
574
575
  if (c->super == c) {
#ifdef SWIFT_DEBUG_CHECKS
    /* Check that everything went OK */
    cell_check_spart_pos(c, e->s->sparts);
#endif
  }

Matthieu Schaller's avatar
Matthieu Schaller committed
576
577
578
  if (timer) TIMER_TOC(timer_do_star_formation);
}

Pedro Gonnet's avatar
Pedro Gonnet committed
579
580
581
582
583
584
/**
 * @brief Sort the entries in ascending order using QuickSort.
 *
 * @param sort The entries
 * @param N The number of entries.
 */
585
void runner_do_sort_ascending(struct entry *sort, int N) {
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639

  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
640
        }
641
642
643
644
645
646
647
648
649
650
651
652
      } 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
653
    }
654
655
656
  }
}

Matthieu Schaller's avatar
Matthieu Schaller committed
657
658
659
660
661
662
663
664
/**
 * @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.
 */
665
void runner_check_sorts(struct cell *c, int flags) {
Matthieu Schaller's avatar
Matthieu Schaller committed
666
667

#ifdef SWIFT_DEBUG_CHECKS
668
  if (flags & ~c->hydro.sorted) error("Inconsistent sort flags (downward)!");
669
670
  if (c->split)
    for (int k = 0; k < 8; k++)
671
672
      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
673
674
675
#else
  error("Calling debugging code without debugging flag activated.");
#endif
676
677
}

Pedro Gonnet's avatar
Pedro Gonnet committed
678
679
680
681
682
/**
 * @brief Sort the particles in the given cell along all cardinal directions.
 *
 * @param r The #runner.
 * @param c The #cell.
683
 * @param flags Cell flag.
684
685
 * @param cleanup If true, re-build the sorts for the selected flags instead
 *        of just adding them.
686
687
 * @param clock Flag indicating whether to record the timing or not, needed
 *      for recursive calls.
Pedro Gonnet's avatar
Pedro Gonnet committed
688
 */
689
690
void runner_do_sort(struct runner *r, struct cell *c, int flags, int cleanup,
                    int clock) {
691
692

  struct entry *fingers[8];
693
694
695
  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
696
  float buff[8];
697

698
699
  TIMER_TIC;

700
  /* We need to do the local sorts plus whatever was requested further up. */
701
  flags |= c->hydro.do_sort;
702
  if (cleanup) {
703
    c->hydro.sorted = 0;
704
  } else {
705
    flags &= ~c->hydro.sorted;
706
  }
707
  if (flags == 0 && !c->hydro.do_sub_sort) return;
708
709

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

713
714
#ifdef SWIFT_DEBUG_CHECKS
  /* Make sure the sort flags are consistent (downward). */
715
  runner_check_sorts(c, c->hydro.sorted);
716
717

  /* Make sure the sort flags are consistent (upard). */
Pedro Gonnet's avatar
Pedro Gonnet committed
718
719
  for (struct cell *finger = c->parent; finger != NULL;
       finger = finger->parent) {
720
721
    if (finger->hydro.sorted & ~c->hydro.sorted)
      error("Inconsistent sort flags (upward).");
722
  }
723

724
725
  /* Update the sort timer which represents the last time the sorts
     were re-set. */
726
  if (c->hydro.sorted == 0) c->hydro.ti_sort = r->e->ti_current;
727
#endif
728

729
730
  /* start by allocating the entry arrays in the requested dimensions. */
  for (int j = 0; j < 13; j++) {
731
732
733
    if ((flags & (1 << j)) && c->hydro.sort[j] == NULL) {
      if ((c->hydro.sort[j] = (struct entry *)malloc(sizeof(struct entry) *
                                                     (count + 1))) == NULL)
734
735
        error("Failed to allocate sort memory.");
    }
736
737
738
739
740
741
  }

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

    /* Fill in the gaps within the progeny. */
742
    float dx_max_sort = 0.0f;
743
    float dx_max_sort_old = 0.0f;
744
    for (int k = 0; k < 8; k++) {
745
      if (c->progeny[k] != NULL && c->progeny[k]->hydro.count > 0) {
746
747
        /* Only propagate cleanup if the progeny is stale. */
        runner_do_sort(r, c->progeny[k], flags,
748
                       cleanup && (c->progeny[k]->hydro.dx_max_sort >
749
750
                                   space_maxreldx * c->progeny[k]->dmin),
                       0);
751
752
753
        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);
754
      }
755
    }
756
757
    c->hydro.dx_max_sort = dx_max_sort;
    c->hydro.dx_max_sort_old = dx_max_sort_old;
758
759

    /* Loop over the 13 different sort arrays. */
760
    for (int j = 0; j < 13; j++) {
761
762
763
764
765

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

      /* Init the particle index offsets. */
766
      int off[8];
767
768
      off[0] = 0;
      for (int k = 1; k < 8; k++)
769
        if (c->progeny[k - 1] != NULL)
770
          off[k] = off[k - 1] + c->progeny[k - 1]->hydro.count;
771
772
773
774
        else
          off[k] = off[k - 1];

      /* Init the entries and indices. */
775
      int inds[8];
776
      for (int k = 0; k < 8; k++) {
777
        inds[k] = k;
778
779
        if (c->progeny[k] != NULL && c->progeny[k]->hydro.count > 0) {
          fingers[k] = c->progeny[k]->hydro.sort[j];
780
781
782
783
784
785
786
          buff[k] = fingers[k]->d;
          off[k] = off[k];
        } else
          buff[k] = FLT_MAX;
      }

      /* Sort the buffer. */
787
788
      for (int i = 0; i < 7; i++)
        for (int k = i + 1; k < 8; k++)
789
          if (buff[inds[k]] < buff[inds[i]]) {
790
            int temp_i = inds[i];
791
792
793
794
795
            inds[i] = inds[k];
            inds[k] = temp_i;
          }

      /* For each entry in the new sort list. */
796
      struct entry *finger = c->hydro.sort[j];
797
      for (int ind = 0; ind < count; ind++) {
798
799
800
801
802
803
804
805
806
807

        /* 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. */
808
        for (int k = 1; k < 8 && buff[inds[k]] < buff[inds[k - 1]]; k++) {
809
          int temp_i = inds[k - 1];
810
811
          inds[k - 1] = inds[k];
          inds[k] = temp_i;
Pedro Gonnet's avatar
Pedro Gonnet committed
812
        }
813

814
815
816
      } /* Merge. */

      /* Add a sentinel. */
817
818
      c->hydro.sort[j][count].d = FLT_MAX;
      c->hydro.sort[j][count].i = 0;
819
820

      /* Mark as sorted. */
821
      atomic_or(&c->hydro.sorted, 1 << j);
822
823
824
825
826
827
828
829

    } /* loop over sort arrays. */

  } /* progeny? */

  /* Otherwise, just sort. */
  else {

830
    /* Reset the sort distance */
831
    if (c->hydro.sorted == 0) {
832
833
#ifdef SWIFT_DEBUG_CHECKS
      if (xparts != NULL && c->nodeID != engine_rank)
834
        error("Have non-NULL xparts in foreign cell");
835
#endif
836
837
838
839
840
841
842
843

      /* 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;
        }
844
      }
845
846
      c->hydro.dx_max_sort_old = 0.f;
      c->hydro.dx_max_sort = 0.f;
847
848
    }

849
    /* Fill the sort array. */
850
    for (int k = 0; k < count; k++) {
851
      const double px[3] = {parts[k].x[0], parts[k].x[1], parts[k].x[2]};
852
      for (int j = 0; j < 13; j++)
853
        if (flags & (1 << j)) {
854
855
856
857
          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];
858
        }
859
    }
860
861

    /* Add the sentinel and sort. */
862
    for (int j = 0; j < 13; j++)
863
      if (flags & (1 << j)) {
864
865
866
867
        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);
868
869
870
      }
  }

871
#ifdef SWIFT_DEBUG_CHECKS
Matthieu Schaller's avatar
Matthieu Schaller committed
872
  /* Verify the sorting. */
873
  for (int j = 0; j < 13; j++) {
874
    if (!(flags & (1 << j))) continue;
875
    struct entry *finger = c->hydro.sort[j];
876
    for (int k = 1; k < count; k++) {
877
878
879
880
881
      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
882

883
884
885
886
  /* 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
887
888
  for (struct cell *finger = c->parent; finger != NULL;
       finger = finger->parent) {
889
890
    if (finger->hydro.sorted & ~c->hydro.sorted)
      error("Inconsistent sort flags.");
891
  }
892
#endif
893

894
  /* Clear the cell's sort flags. */
895
896
897
  c->hydro.do_sort = 0;
  c->hydro.do_sub_sort = 0;
  c->hydro.requires_sorts = 0;
898

899
900
901
  if (clock) TIMER_TOC(timer_dosort);
}

902
/**
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 * @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? */
921
  if (!cell_is_active_gravity(c, e)) return;
922
923

  /* Reset the gravity acceleration tensors */
924
  gravity_field_tensors_init(&c->grav.multipole->pot, e->ti_current);
925
926
927
928
929
930
931
932
933
934
935

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

936
/**
937
938
939
940
941
 * @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.
942
 * @param timer Are we timing this ?
943
 */
944
void runner_do_extra_ghost(struct runner *r, struct cell *c, int timer) {
Loic Hausammann's avatar
Format    
Loic Hausammann committed
945

946
#ifdef EXTRA_HYDRO_LOOP
947

948
949
950
  struct part *restrict parts = c->hydro.parts;
  struct xpart *restrict xparts = c->hydro.xparts;
  const int count = c->hydro.count;
951
  const struct engine *e = r->e;
952
  const integertime_t ti_end = e->ti_current;
Josh Borrow's avatar
Josh Borrow committed
953
  const int with_cosmology = (e->policy & engine_policy_cosmology);
954
  const double time_base = e->time_base;
955
  const struct cosmology *cosmo = e->cosmology;
Josh Borrow's avatar
Josh Borrow committed
956
  const struct hydro_props *hydro_props = e->hydro_properties;
957

958
959
  TIMER_TIC;

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

963
964
965
  /* Recurse? */
  if (c->split) {
    for (int k = 0; k < 8; k++)
966
      if (c->progeny[k] != NULL) runner_do_extra_ghost(r, c->progeny[k], 0);
967
968
969
970
971
972
973
  } 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];
974
      struct xpart *restrict xp = &xparts[i];
975

976
      if (part_is_active(p, e)) {
977

978
        /* Finish the gradient calculation */
979
        hydro_end_gradient(p);
980
981
982

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

Josh Borrow's avatar
Josh Borrow committed
983
984
985
        /* 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. */
986
987
988
989
990
991
992
        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);
        }
993

994
        /* Compute variables required for the force loop */
Josh Borrow's avatar
Josh Borrow committed
995
        hydro_prepare_force(p, xp, cosmo, hydro_props, dt_alpha);
996
997
998
999
1000

        /* 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 */