cell.h 29.1 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
 ******************************************************************************/
23
24
#ifndef SWIFT_CELL_H
#define SWIFT_CELL_H
25

26
27
28
/* Config parameters. */
#include "../config.h"

29
/* Includes. */
30
31
32
#include <stddef.h>

/* Local includes. */
33
#include "align.h"
34
#include "kernel_hydro.h"
Pedro Gonnet's avatar
Pedro Gonnet committed
35
#include "lock.h"
36
#include "multipole.h"
37
#include "part.h"
38
#include "space.h"
39
#include "task.h"
40
#include "timeline.h"
41

42
/* Avoid cyclic inclusions */
43
struct engine;
44
struct scheduler;
45

46
47
48
/* Max tag size set to 2^29 to take into account some MPI implementations
 * that use 2^31 as the upper bound on MPI tags and the fact that
 * cell_next_tag is multiplied by 2 when passed to an MPI function.
49
50
 * The maximum was lowered by a further factor of 2 to be on the safe side.*/
#define cell_max_tag (1 << 29)
51

52
#define cell_align 128
53

54
55
56
/* Global variables. */
extern int cell_next_tag;

57
58
59
60
/* Struct to temporarily buffer the particle locations and bin id. */
struct cell_buff {
  double x[3];
  int ind;
61
} SWIFT_STRUCT_ALIGN;
62

63
64
65
66
67
68
69
70
71
72
/* Mini struct to link cells to tasks. Used as a linked list. */
struct link {

  /* The task pointer. */
  struct task *t;

  /* The next pointer. */
  struct link *next;
};

73
74
75
76
77
/**
 * @brief Packed cell for information correct at rebuild time.
 *
 * Contains all the information for a tree walk in a non-local cell.
 */
78
79
struct pcell {

80
81
  /*! Hydro variables */
  struct {
Matthieu Schaller's avatar
Matthieu Schaller committed
82

83
84
    /*! Maximal smoothing length. */
    double h_max;
85

86
87
    /*! Minimal integer end-of-timestep in this cell for hydro tasks */
    integertime_t ti_end_min;
88

89
90
    /*! Maximal integer end-of-timestep in this cell for hydro tasks */
    integertime_t ti_end_max;
91

92
93
    /*! Maximal integer beginning-of-timestep in this cell for hydro tasks */
    integertime_t ti_beg_max;
94

95
    /*! Integer time of the last drift of the #part in this cell */
96
    integertime_t ti_old_part;
97

98
99
    /*! Number of #part in this cell. */
    int count;
100

101
  } hydro;
102

103
104
  /*! Gravity variables */
  struct {
105

106
107
    /*! This cell's gravity-related tensors */
    struct multipole m_pole;
108

109
110
    /*! Centre of mass. */
    double CoM[3];
111

112
113
    /*! Centre of mass at rebuild time. */
    double CoM_rebuild[3];
114

115
116
    /*! Upper limit of the CoM<->gpart distance. */
    double r_max;
117

118
119
    /*! Upper limit of the CoM<->gpart distance at last rebuild. */
    double r_max_rebuild;
120

121
122
    /*! Minimal integer end-of-timestep in this cell for gravity tasks */
    integertime_t ti_end_min;
Pedro Gonnet's avatar
Pedro Gonnet committed
123

124
125
    /*! Maximal integer end-of-timestep in this cell for gravity tasks */
    integertime_t ti_end_max;
126

127
128
    /*! Maximal integer beginning-of-timestep in this cell for gravity tasks */
    integertime_t ti_beg_max;
129

130
    /*! Integer time of the last drift of the #gpart in this cell */
131
    integertime_t ti_old_part;
132

133
134
    /*! Integer time of the last drift of the #multipole in this cell */
    integertime_t ti_old_multipole;
135

136
    /*! Number of #gpart in this cell. */
137
    int count;
138
139
140

  } grav;

141
142
143
144
145
146
  /*! Stars variables */
  struct {

    /*! Number of #spart in this cell. */
    int count;

Loic Hausammann's avatar
Loic Hausammann committed
147
148
149
    /*! Maximal smoothing length. */
    double h_max;

150
151
152
    /*! Minimal integer end-of-timestep in this cell for stars tasks */
    integertime_t ti_end_min;

153
154
  } stars;

155
156
157
  /*! Maximal depth in that part of the tree */
  int maxdepth;

158
159
  /*! Relative indices of the cell's progeny. */
  int progeny[8];
160

161
162
163
164
165
#ifdef SWIFT_DEBUG_CHECKS
  /* Cell ID (for debugging) */
  int cellID;
#endif

166
} SWIFT_STRUCT_ALIGN;
167

168
169
170
171
172
/**
 * @brief Cell information at the end of a time-step.
 */
struct pcell_step {

173
174
175
176
177
  /*! Hydro variables */
  struct {

    /*! Minimal integer end-of-timestep in this cell (hydro) */
    integertime_t ti_end_min;
178

179
180
    /*! Minimal integer end-of-timestep in this cell (hydro) */
    integertime_t ti_end_max;
181

182
    /*! Maximal distance any #part has travelled since last rebuild */
183
    float dx_max_part;
184

185
  } hydro;
186

187
188
189
190
191
192
193
194
  /*! Grav variables */
  struct {

    /*! Minimal integer end-of-timestep in this cell (gravity) */
    integertime_t ti_end_min;

    /*! Minimal integer end-of-timestep in this cell (gravity) */
    integertime_t ti_end_max;
195

196
  } grav;
197
198
199

  /*! Stars variables */
  struct {
Loic Hausammann's avatar
Loic Hausammann committed
200
201
202
203

    /*! Maximal distance any #part has travelled since last rebuild */
    float dx_max_part;

204
205
206
    /*! Minimal integer end-of-timestep in this cell (stars) */
    integertime_t ti_end_min;

207
  } stars;
208
209
};

210
211
212
213
214
/**
 * @brief Cell within the tree structure.
 *
 * Contains particles, links to tasks, a multipole object and counters.
 */
215
216
struct cell {

217
  /*! The cell location on the grid. */
218
219
  double loc[3];

220
  /*! The cell dimensions. */
221
  double width[3];
222

223
224
  /*! Linking pointer for "memory management". */
  struct cell *next;
225

226
  /*! Pointers to the next level of cells. */
227
228
  struct cell *progeny[8];

229
  /*! Parent cell. */
230
231
  struct cell *parent;

232
  /*! Super cell, i.e. the highest-level parent cell with *any* task */
233
  struct cell *super;
234

235
236
  /*! Hydro variables */
  struct {
237

238
239
    /*! Pointer to the #part data. */
    struct part *parts;
240

241
242
    /*! Pointer to the #xpart data. */
    struct xpart *xparts;
243

244
245
    /*! Pointer for the sorted indices. */
    struct entry *sort[13];
246

247
248
    /*! Super cell, i.e. the highest-level parent cell that has a hydro
     * pair/self tasks */
249
    struct cell *super;
250

251
    /*! Last (integer) time the cell's part were drifted forward in time. */
252
    integertime_t ti_old_part;
253

254
    /*! Maximum part movement in this cell since last construction. */
255
    float dx_max_part;
256

257
258
    /*! Maximum particle movement in this cell since the last sort. */
    float dx_max_sort;
259

260
261
    /*! Max smoothing length in this cell. */
    double h_max;
262

263
264
    /*! Minimum end of (integer) time step in this cell for hydro tasks. */
    integertime_t ti_end_min;
265

266
267
    /*! Maximum end of (integer) time step in this cell for hydro tasks. */
    integertime_t ti_end_max;
268

269
270
    /*! Maximum beginning of (integer) time step in this cell for hydro tasks.
     */
271
    integertime_t ti_beg_max;
272

273
274
    /*! Nr of #part in this cell. */
    int count;
275

276
277
    /*! Spin lock for various uses (#part case). */
    swift_lock_type lock;
278

279
280
    /*! Number of #part updated in this cell. */
    int updated;
281

282
283
284
    /*! Number of #part inhibited in this cell. */
    int inhibited;

285
286
    /*! Is the #part data of this cell being used in a sub-cell? */
    int hold;
287

288
289
    /*! Values of h_max before the drifts, used for sub-cell tasks. */
    float h_max_old;
290

291
292
293
    /*! Values of dx_max before the drifts, used for sub-cell tasks. */
    float dx_max_part_old;

294
295
    /*! Values of dx_max_sort before the drifts, used for sub-cell tasks. */
    float dx_max_sort_old;
296

297
298
    /*! Bit mask of sort directions that will be needed in the next timestep. */
    unsigned int requires_sorts;
299

300
301
    /*! Bit mask of sorts that need to be computed for this cell. */
    unsigned int do_sort;
302

303
304
    /*! Does this cell need to be drifted (hydro)? */
    char do_drift;
305

306
307
    /*! Do any of this cell's sub-cells need to be drifted (hydro)? */
    char do_sub_drift;
Tom Theuns's avatar
Tom Theuns committed
308

309
310
    /*! Do any of this cell's sub-cells need to be sorted? */
    char do_sub_sort;
311

312
313
    /*! Bit-mask indicating the sorted directions */
    unsigned int sorted;
314

315
316
    /*! The task computing this cell's sorts. */
    struct task *sorts;
317

318
319
    /*! The drift task for parts */
    struct task *drift;
320

321
322
    /*! Linked list of the tasks computing this cell's hydro density. */
    struct link *density;
Loic Hausammann's avatar
Loic Hausammann committed
323

324
325
    /* Linked list of the tasks computing this cell's hydro gradients. */
    struct link *gradient;
Loic Hausammann's avatar
Loic Hausammann committed
326

327
328
    /*! Linked list of the tasks computing this cell's hydro forces. */
    struct link *force;
Loic Hausammann's avatar
Loic Hausammann committed
329

330
331
    /*! Dependency implicit task for the ghost  (in->ghost->out)*/
    struct task *ghost_in;
332

333
334
    /*! Dependency implicit task for the ghost  (in->ghost->out)*/
    struct task *ghost_out;
335

336
337
338
339
340
341
342
343
    /*! The ghost task itself */
    struct task *ghost;

    /*! The extra ghost task for complex hydro schemes */
    struct task *extra_ghost;

    /*! Task for cooling */
    struct task *cooling;
344

Matthieu Schaller's avatar
Matthieu Schaller committed
345
346
347
    /*! Task for star formation */
    struct task *star_formation;

348
#ifdef SWIFT_DEBUG_CHECKS
349

350
351
    /*! Last (integer) time the cell's sort arrays were updated. */
    integertime_t ti_sort;
352

353
#endif
354

355
  } hydro;
356

357
358
  /*! Grav variables */
  struct {
359

360
    /*! Pointer to the #gpart data. */
361
    struct gpart *parts;
362

363
364
    /*! This cell's multipole. */
    struct gravity_tensors *multipole;
365

366
367
368
    /*! Super cell, i.e. the highest-level parent cell that has a grav pair/self
     * tasks */
    struct cell *super;
369

370
371
    /*! Minimum end of (integer) time step in this cell for gravity tasks. */
    integertime_t ti_end_min;
372

373
374
    /*! Maximum end of (integer) time step in this cell for gravity tasks. */
    integertime_t ti_end_max;
375

376
377
378
    /*! Maximum beginning of (integer) time step in this cell for gravity tasks.
     */
    integertime_t ti_beg_max;
379

380
    /*! Last (integer) time the cell's gpart were drifted forward in time. */
381
    integertime_t ti_old_part;
382

383
384
    /*! Last (integer) time the cell's multipole was drifted forward in time. */
    integertime_t ti_old_multipole;
385

386
    /*! Nr of #gpart in this cell. */
387
    int count;
388

389
    /*! Spin lock for various uses (#gpart case). */
390
    swift_lock_type plock;
391

392
393
    /*! Spin lock for various uses (#multipole case). */
    swift_lock_type mlock;
394

395
    /*! Number of #gpart updated in this cell. */
396
    int updated;
397

398
399
400
    /*! Number of #gpart inhibited in this cell. */
    int inhibited;

401
    /*! Is the #gpart data of this cell being used in a sub-cell? */
402
    int phold;
403

404
405
    /*! Is the #multipole data of this cell being used in a sub-cell? */
    int mhold;
406

407
408
    /*! Does this cell need to be drifted (gravity)? */
    char do_drift;
409

410
411
    /*! Do any of this cell's sub-cells need to be drifted (gravity)? */
    char do_sub_drift;
Matthieu Schaller's avatar
Matthieu Schaller committed
412

413
    /*! The drift task for gparts */
414
    struct task *drift;
415

416
417
418
    /*! Implicit task (going up- and down the tree) for the #gpart drifts */
    struct task *drift_out;

419
420
    /*! Linked list of the tasks computing this cell's gravity forces. */
    struct link *grav;
421

422
423
    /*! Linked list of the tasks computing this cell's gravity M-M forces. */
    struct link *mm;
424

425
426
    /*! The multipole initialistation task */
    struct task *init;
427

428
429
    /*! Implicit task for the gravity initialisation */
    struct task *init_out;
430

431
432
    /*! Task computing long range non-periodic gravity interactions */
    struct task *long_range;
433

434
435
    /*! Implicit task for the down propagation */
    struct task *down_in;
436

437
438
    /*! Task propagating the mesh forces to the particles */
    struct task *mesh;
439

440
441
    /*! Task propagating the multipole to the particles */
    struct task *down;
442

443
444
    /*! Number of M-M tasks that are associated with this cell. */
    short int nr_mm_tasks;
445

446
  } grav;
447

448
449
  /*! Stars variables */
  struct {
450

451
452
    /*! Pointer to the #spart data. */
    struct spart *parts;
453

454
455
    /*! Nr of #spart in this cell. */
    int count;
456

Loic Hausammann's avatar
Loic Hausammann committed
457
458
459
460
461
462
463
464
465
466
467
468
    /*! Max smoothing length in this cell. */
    double h_max;

    /*! Values of h_max before the drifts, used for sub-cell tasks. */
    float h_max_old;

    /*! Maximum part movement in this cell since last construction. */
    float dx_max_part;

    /*! Values of dx_max before the drifts, used for sub-cell tasks. */
    float dx_max_part_old;

Loic Hausammann's avatar
Loic Hausammann committed
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
    /*! Maximum particle movement in this cell since the last sort. */
    float dx_max_sort;

    /*! Values of dx_max_sort before the drifts, used for sub-cell tasks. */
    float dx_max_sort_old;

    /*! Bit mask of sort directions that will be needed in the next timestep. */
    unsigned int requires_sorts;

    /*! Pointer for the sorted indices. */
    struct entry *sort[13];

    /*! Bit-mask indicating the sorted directions */
    unsigned int sorted;

    /*! Bit mask of sorts that need to be computed for this cell. */
    unsigned int do_sort;

    /*! Do any of this cell's sub-cells need to be sorted? */
    char do_sub_sort;

    /*! Maximum end of (integer) time step in this cell for gravity tasks. */
    integertime_t ti_end_min;

493
494
    /*! Dependency implicit task for the star ghost  (in->ghost->out)*/
    struct task *ghost_in;
495

496
497
    /*! Dependency implicit task for the star ghost  (in->ghost->out)*/
    struct task *ghost_out;
498

499
500
    /*! The star ghost task itself */
    struct task *ghost;
501

Loic Hausammann's avatar
Loic Hausammann committed
502
503
504
    /*! The task computing this cell's sorts. */
    struct task *sorts;

505
506
    /*! Linked list of the tasks computing this cell's star density. */
    struct link *density;
Alexei Borissov's avatar
Alexei Borissov committed
507
508
509
    
    // ALEXEI: DOES THIS NEED TO BE HERE?
    struct link *feedback;
510

511
512
    /*! Number of #spart updated in this cell. */
    int updated;
513

514
515
516
    /*! Number of #spart inhibited in this cell. */
    int inhibited;

517
518
    /*! Is the #spart data of this cell being used in a sub-cell? */
    int hold;
519

520
521
    /*! Spin lock for various uses (#spart case). */
    swift_lock_type lock;
522

Loic Hausammann's avatar
Loic Hausammann committed
523
524
525
526
527
#ifdef SWIFT_DEBUG_CHECKS
    /*! Last (integer) time the cell's sort arrays were updated. */
    integertime_t ti_sort;
#endif

528
  } stars;
529

530
531
532
#ifdef WITH_MPI
  /*! MPI variables */
  struct {
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

    struct {
      /* Task receiving hydro data (positions). */
      struct task *recv_xv;

      /* Task receiving hydro data (density). */
      struct task *recv_rho;

      /* Task receiving hydro data (gradient). */
      struct task *recv_gradient;

      /* Linked list for sending hydro data (positions). */
      struct link *send_xv;

      /* Linked list for sending hydro data (density). */
      struct link *send_rho;

      /* Linked list for sending hydro data (gradient). */
      struct link *send_gradient;

    } hydro;

    struct {

      /* Task receiving gpart data. */
      struct task *recv;

      /* Linked list for sending gpart data. */
      struct link *send;
    } grav;

564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
    /* Task receiving data (time-step). */
    struct task *recv_ti;

    /* Linked list for sending data (time-step). */
    struct link *send_ti;

    /*! Bit mask of the proxies this cell is registered with. */
    unsigned long long int sendto;

    /*! Pointer to this cell's packed representation. */
    struct pcell *pcell;

    /*! Size of the packed representation */
    int pcell_size;

    /*! MPI tag associated with this cell */
    int tag;
581

582
583
  } mpi;
#endif
584

585
586
587
  /*! The task to end the force calculation */
  struct task *end_force;

588
589
  /*! The first kick task */
  struct task *kick1;
590

591
592
  /*! The second kick task */
  struct task *kick2;
593

594
595
596
597
598
599
  /*! The task to compute time-steps */
  struct task *timestep;

  /*! Task for source terms */
  struct task *sourceterms;

Loic Hausammann's avatar
Format    
Loic Hausammann committed
600
601
602
  /*! The logger task */
  struct task *logger;

603
604
  /*! Minimum dimension, i.e. smallest edge of this cell (min(width)). */
  float dmin;
605

606
607
608
609
610
611
  /*! ID of the previous owner, e.g. runner. */
  int owner;

  /*! ID of the node this cell lives on. */
  int nodeID;

612
613
614
615
616
617
618
619
620
621
622
623
  /*! Number of tasks that are associated with this cell. */
  short int nr_tasks;

  /*! The depth of this cell in the tree. */
  char depth;

  /*! Is this cell split ? */
  char split;

  /*! The maximal depth of this cell and its progenies */
  char maxdepth;

624
#ifdef SWIFT_DEBUG_CHECKS
625
626
627
  /* Cell ID (for debugging) */
  int cellID;

628
629
630
631
632
633
634
  /*! The list of tasks that have been executed on this cell */
  char tasks_executed[64];

  /*! The list of sub-tasks that have been executed on this cell */
  char subtasks_executed[64];
#endif

635
} SWIFT_STRUCT_ALIGN;
636

637
638
639
640
/* Convert cell location to ID. */
#define cell_getid(cdim, i, j, k) \
  ((int)(k) + (cdim)[2] * ((int)(j) + (cdim)[1] * (int)(i)))

641
/* Function prototypes. */
642
643
void cell_split(struct cell *c, ptrdiff_t parts_offset, ptrdiff_t sparts_offset,
                struct cell_buff *buff, struct cell_buff *sbuff,
644
                struct cell_buff *gbuff);
645
void cell_sanitize(struct cell *c, int treated);
646
647
648
649
int cell_locktree(struct cell *c);
void cell_unlocktree(struct cell *c);
int cell_glocktree(struct cell *c);
void cell_gunlocktree(struct cell *c);
650
651
int cell_mlocktree(struct cell *c);
void cell_munlocktree(struct cell *c);
652
653
int cell_slocktree(struct cell *c);
void cell_sunlocktree(struct cell *c);
654
int cell_pack(struct cell *c, struct pcell *pc, const int with_gravity);
Matthieu Schaller's avatar
Matthieu Schaller committed
655
656
int cell_unpack(struct pcell *pc, struct cell *c, struct space *s,
                const int with_gravity);
657
658
int cell_pack_tags(const struct cell *c, int *tags);
int cell_unpack_tags(const int *tags, struct cell *c);
659
660
int cell_pack_end_step(struct cell *c, struct pcell_step *pcell);
int cell_unpack_end_step(struct cell *c, struct pcell_step *pcell);
661
662
int cell_pack_multipoles(struct cell *c, struct gravity_tensors *m);
int cell_unpack_multipoles(struct cell *c, struct gravity_tensors *m);
663
int cell_getsize(struct cell *c);
664
665
int cell_link_parts(struct cell *c, struct part *parts);
int cell_link_gparts(struct cell *c, struct gpart *gparts);
666
int cell_link_sparts(struct cell *c, struct spart *sparts);
667
void cell_clean_links(struct cell *c, void *data);
668
void cell_make_multipoles(struct cell *c, integertime_t ti_current);
669
670
void cell_check_multipole(struct cell *c);
void cell_check_foreign_multipole(const struct cell *c);
671
void cell_clean(struct cell *c);
672
673
void cell_check_part_drift_point(struct cell *c, void *data);
void cell_check_gpart_drift_point(struct cell *c, void *data);
674
void cell_check_multipole_drift_point(struct cell *c, void *data);
675
void cell_reset_task_counters(struct cell *c);
676
int cell_unskip_hydro_tasks(struct cell *c, struct scheduler *s);
677
int cell_unskip_stars_tasks(struct cell *c, struct scheduler *s);
678
int cell_unskip_gravity_tasks(struct cell *c, struct scheduler *s);
679
void cell_set_super(struct cell *c, struct cell *super);
680
void cell_drift_part(struct cell *c, const struct engine *e, int force);
681
void cell_drift_gpart(struct cell *c, const struct engine *e, int force);
682
void cell_drift_multipole(struct cell *c, const struct engine *e);
683
void cell_drift_all_multipoles(struct cell *c, const struct engine *e);
684
void cell_check_timesteps(struct cell *c);
685
void cell_store_pre_drift_values(struct cell *c);
686
687
void cell_activate_subcell_hydro_tasks(struct cell *ci, struct cell *cj,
                                       struct scheduler *s);
688
689
void cell_activate_subcell_grav_tasks(struct cell *ci, struct cell *cj,
                                      struct scheduler *s);
690
691
void cell_activate_subcell_stars_tasks(struct cell *ci, struct cell *cj,
                                       struct scheduler *s);
692
693
void cell_activate_subcell_external_grav_tasks(struct cell *ci,
                                               struct scheduler *s);
694
void cell_activate_drift_part(struct cell *c, struct scheduler *s);
695
void cell_activate_drift_gpart(struct cell *c, struct scheduler *s);
Loic Hausammann's avatar
Loic Hausammann committed
696
void cell_activate_drift_spart(struct cell *c, struct scheduler *s);
697
void cell_activate_hydro_sorts(struct cell *c, int sid, struct scheduler *s);
Loic Hausammann's avatar
Loic Hausammann committed
698
void cell_activate_stars_sorts(struct cell *c, int sid, struct scheduler *s);
699
void cell_clear_drift_flags(struct cell *c, void *data);
Pedro Gonnet's avatar
Pedro Gonnet committed
700
void cell_set_super_mapper(void *map_data, int num_elements, void *extra_data);
701
int cell_has_tasks(struct cell *c);
702
703
void cell_remove_part(const struct engine *e, struct cell *c, struct part *p,
                      struct xpart *xp);
704
705
706
707
void cell_remove_gpart(const struct engine *e, struct cell *c,
                       struct gpart *gp);
void cell_remove_spart(const struct engine *e, struct cell *c,
                       struct spart *sp);
708
709
710
void cell_convert_part_to_gpart(const struct engine *e, struct cell *c,
                                struct part *p, struct xpart *xp);
void cell_convert_spart_to_gpart(const struct engine *e, struct cell *c,
711
                                 struct spart *sp);
712
713
int cell_can_use_pair_mm(const struct cell *ci, const struct cell *cj,
                         const struct engine *e, const struct space *s);
714
int cell_can_use_pair_mm_rebuild(const struct cell *ci, const struct cell *cj,
Matthieu Schaller's avatar
Matthieu Schaller committed
715
                                 const struct engine *e, const struct space *s);
716

717
/**
Peter W. Draper's avatar
Peter W. Draper committed
718
 * @brief Compute the square of the minimal distance between any two points in
Matthieu Schaller's avatar
Matthieu Schaller committed
719
 * two cells of the same size
720
721
722
723
724
725
 *
 * @param ci The first #cell.
 * @param cj The second #cell.
 * @param periodic Are we using periodic BCs?
 * @param dim The dimensions of the simulation volume
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
726
727
728
__attribute__((always_inline)) INLINE static double cell_min_dist2_same_size(
    const struct cell *restrict ci, const struct cell *restrict cj,
    const int periodic, const double dim[3]) {
729
730

#ifdef SWIFT_DEBUG_CHECKS
Matthieu Schaller's avatar
Matthieu Schaller committed
731
732
733
  if (ci->width[0] != cj->width[0]) error("Cells of different size!");
  if (ci->width[1] != cj->width[1]) error("Cells of different size!");
  if (ci->width[2] != cj->width[2]) error("Cells of different size!");
734
735
#endif

Matthieu Schaller's avatar
Matthieu Schaller committed
736
737
738
739
740
741
742
743
744
745
746
747
  const double cix_min = ci->loc[0];
  const double ciy_min = ci->loc[1];
  const double ciz_min = ci->loc[2];
  const double cjx_min = cj->loc[0];
  const double cjy_min = cj->loc[1];
  const double cjz_min = cj->loc[2];

  const double cix_max = ci->loc[0] + ci->width[0];
  const double ciy_max = ci->loc[1] + ci->width[1];
  const double ciz_max = ci->loc[2] + ci->width[2];
  const double cjx_max = cj->loc[0] + cj->width[0];
  const double cjy_max = cj->loc[1] + cj->width[1];
748
749
750
751
752
  const double cjz_max = cj->loc[2] + cj->width[2];

  if (periodic) {

    const double dx = min4(fabs(nearest(cix_min - cjx_min, dim[0])),
Matthieu Schaller's avatar
Matthieu Schaller committed
753
754
755
756
                           fabs(nearest(cix_min - cjx_max, dim[0])),
                           fabs(nearest(cix_max - cjx_min, dim[0])),
                           fabs(nearest(cix_max - cjx_max, dim[0])));

757
    const double dy = min4(fabs(nearest(ciy_min - cjy_min, dim[1])),
Matthieu Schaller's avatar
Matthieu Schaller committed
758
759
760
761
                           fabs(nearest(ciy_min - cjy_max, dim[1])),
                           fabs(nearest(ciy_max - cjy_min, dim[1])),
                           fabs(nearest(ciy_max - cjy_max, dim[1])));

762
    const double dz = min4(fabs(nearest(ciz_min - cjz_min, dim[2])),
Matthieu Schaller's avatar
Matthieu Schaller committed
763
764
765
766
                           fabs(nearest(ciz_min - cjz_max, dim[2])),
                           fabs(nearest(ciz_max - cjz_min, dim[2])),
                           fabs(nearest(ciz_max - cjz_max, dim[2])));

767
768
769
770
    return dx * dx + dy * dy + dz * dz;

  } else {

Matthieu Schaller's avatar
Matthieu Schaller committed
771
772
773
    const double dx = min(fabs(cix_max - cjx_min), fabs(cix_min - cjx_max));
    const double dy = min(fabs(ciy_max - cjy_min), fabs(ciy_min - cjy_max));
    const double dz = min(fabs(ciz_max - cjz_min), fabs(ciz_min - cjz_max));
774
775
776
777
778

    return dx * dx + dy * dy + dz * dz;
  }
}

779
780
781
782
783
784
785
786
/* Inlined functions (for speed). */

/**
 * @brief Can a sub-pair hydro task recurse to a lower level based
 * on the status of the particles in the cell.
 *
 * @param c The #cell.
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
787
788
__attribute__((always_inline)) INLINE static int
cell_can_recurse_in_pair_hydro_task(const struct cell *c) {
789
790
791
792
793

  /* Is the cell split ? */
  /* If so, is the cut-off radius plus the max distance the parts have moved */
  /* smaller than the sub-cell sizes ? */
  /* Note: We use the _old values as these might have been updated by a drift */
794
  return c->split && ((kernel_gamma * c->hydro.h_max_old +
795
                       c->hydro.dx_max_part_old) < 0.5f * c->dmin);
796
797
798
799
800
801
802
803
}

/**
 * @brief Can a sub-self hydro task recurse to a lower level based
 * on the status of the particles in the cell.
 *
 * @param c The #cell.
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
804
805
__attribute__((always_inline)) INLINE static int
cell_can_recurse_in_self_hydro_task(const struct cell *c) {
806

807
  /* Is the cell split and not smaller than the smoothing length? */
808
  return c->split && (kernel_gamma * c->hydro.h_max_old < 0.5f * c->dmin);
809
810
}

811
812
813
814
815
816
817
818
819
/**
 * @brief Can a sub-pair star task recurse to a lower level based
 * on the status of the particles in the cell.
 *
 * @param c The #cell.
 */
__attribute__((always_inline)) INLINE static int
cell_can_recurse_in_pair_stars_task(const struct cell *c) {

Loic Hausammann's avatar
Loic Hausammann committed
820
821
822
823
824
825
  /* Is the cell split ? */
  /* If so, is the cut-off radius plus the max distance the parts have moved */
  /* smaller than the sub-cell sizes ? */
  /* Note: We use the _old values as these might have been updated by a drift */
  return c->split && ((kernel_gamma * c->stars.h_max_old +
                       c->stars.dx_max_part_old) < 0.5f * c->dmin);
826
827
828
829
830
831
832
833
834
835
836
}

/**
 * @brief Can a sub-self stars task recurse to a lower level based
 * on the status of the particles in the cell.
 *
 * @param c The #cell.
 */
__attribute__((always_inline)) INLINE static int
cell_can_recurse_in_self_stars_task(const struct cell *c) {

Loic Hausammann's avatar
Loic Hausammann committed
837
838
  /* Is the cell split and not smaller than the smoothing length? */
  return c->split && (kernel_gamma * c->stars.h_max_old < 0.5f * c->dmin);
839
840
}

841
/**
842
 * @brief Can a pair hydro task associated with a cell be split into smaller
843
844
845
846
 * sub-tasks.
 *
 * @param c The #cell.
 */
847
__attribute__((always_inline)) INLINE static int cell_can_split_pair_hydro_task(
848
849
850
851
852
853
854
    const struct cell *c) {

  /* Is the cell split ? */
  /* If so, is the cut-off radius with some leeway smaller than */
  /* the sub-cell sizes ? */
  /* Note that since tasks are create after a rebuild no need to take */
  /* into account any part motion (i.e. dx_max == 0 here) */
855
856
  return c->split &&
         (space_stretch * kernel_gamma * c->hydro.h_max < 0.5f * c->dmin);
857
858
859
}

/**
860
 * @brief Can a self hydro task associated with a cell be split into smaller
861
862
863
864
 * sub-tasks.
 *
 * @param c The #cell.
 */
865
__attribute__((always_inline)) INLINE static int cell_can_split_self_hydro_task(
866
867
868
    const struct cell *c) {

  /* Is the cell split ? */
869
870
  /* If so, is the cut-off radius with some leeway smaller than */
  /* the sub-cell sizes ? */
871
872
  /* Note: No need for more checks here as all the sub-pairs and sub-self */
  /* tasks will be created. So no need to check for h_max */
873
874
  return c->split &&
         (space_stretch * kernel_gamma * c->hydro.h_max < 0.5f * c->dmin);
875
876
}

877
878
879
880
881
882
883
884
885
/**
 * @brief Can a pair stars task associated with a cell be split into smaller
 * sub-tasks.
 *
 * @param c The #cell.
 */
__attribute__((always_inline)) INLINE static int cell_can_split_pair_stars_task(
    const struct cell *c) {

Loic Hausammann's avatar
Loic Hausammann committed
886
887
888
889
890
891
892
  /* Is the cell split ? */
  /* If so, is the cut-off radius with some leeway smaller than */
  /* the sub-cell sizes ? */
  /* Note that since tasks are create after a rebuild no need to take */
  /* into account any part motion (i.e. dx_max == 0 here) */
  return c->split &&
         (space_stretch * kernel_gamma * c->stars.h_max < 0.5f * c->dmin);
893
894
895
896
897
898
899
900
901
902
903
}

/**
 * @brief Can a self stars task associated with a cell be split into smaller
 * sub-tasks.
 *
 * @param c The #cell.
 */
__attribute__((always_inline)) INLINE static int cell_can_split_self_stars_task(
    const struct cell *c) {

Loic Hausammann's avatar
Loic Hausammann committed
904
905
906
907
908
909
910
  /* Is the cell split ? */
  /* If so, is the cut-off radius with some leeway smaller than */
  /* the sub-cell sizes ? */
  /* Note: No need for more checks here as all the sub-pairs and sub-self */
  /* tasks will be created. So no need to check for h_max */
  return c->split &&
         (space_stretch * kernel_gamma * c->stars.h_max < 0.5f * c->dmin);
911
912
}

913
914
915
916
917
918
/**
 * @brief Can a pair gravity task associated with a cell be split into smaller
 * sub-tasks.
 *
 * @param c The #cell.
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
919
920
__attribute__((always_inline)) INLINE static int
cell_can_split_pair_gravity_task(const struct cell *c) {
921

922
923
  /* Is the cell split and still far from the leaves ? */
  return c->split && ((c->maxdepth - c->depth) > space_subdepth_diff_grav);
924
925
926
927
928
929
930
931
}

/**
 * @brief Can a self gravity task associated with a cell be split into smaller
 * sub-tasks.
 *
 * @param c The #cell.
 */
Matthieu Schaller's avatar
Matthieu Schaller committed
932
933
__attribute__((always_inline)) INLINE static int
cell_can_split_self_gravity_task(const struct cell *c) {
934

935
936
  /* Is the cell split and still far from the leaves ? */
  return c->split && ((c->maxdepth - c->depth) > space_subdepth_diff_grav);
937
938
}

939
940
941
942
943
944
945
946
947
948
949
950
951
/**
 * @brief Have particles in a pair of cells moved too much and require a rebuild
 * ?
 *
 * @param ci The first #cell.
 * @param cj The second #cell.
 */
__attribute__((always_inline)) INLINE static int cell_need_rebuild_for_pair(
    const struct cell *ci, const struct cell *cj) {

  /* Is the cut-off radius plus the max distance the parts in both cells have */
  /* moved larger than the cell size ? */
  /* Note ci->dmin == cj->dmin */
952
  return (kernel_gamma * max(ci->hydro.h_max, cj->hydro.h_max) +
953
              ci->hydro.dx_max_part + cj->hydro.dx_max_part >
954
955
          cj->dmin);
}
956

957
/**
958
959
960
 * @brief Add a unique tag to a cell, mostly for MPI communications.
 *
 * This function locks the cell so that tags can be added concurrently.
961
962
 *
 * @param c The #cell to tag.
963
 */
Pedro Gonnet's avatar
Pedro Gonnet committed
964
965
__attribute__((always_inline)) INLINE static void cell_ensure_tagged(
    struct cell *c) {
966
#ifdef WITH_MPI
967

968
  lock_lock(&c->hydro.lock);
969
970
  if (c->mpi.tag < 0 &&
      (c->mpi.tag = atomic_inc(&cell_next_tag)) > cell_max_tag)
971
    error("Ran out of cell tags.");
Pedro Gonnet's avatar