cell.h 26.3 KB
Newer Older
1
/*******************************************************************************
2
 * This file is part of SWIFT.
3
 * Copyright (c) 2012 Pedro Gonnet (pedro.gonnet@durham.ac.uk)
4
5
6
7
 *                    Matthieu Schaller (matthieu.schaller@durham.ac.uk)
 *               2015 Peter W. Draper (p.w.draper@durham.ac.uk)
 *               2016 John A. Regan (john.a.regan@durham.ac.uk)
 *                    Tom Theuns (tom.theuns@durham.ac.uk)
8
 *
9
10
11
12
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
13
 *
14
15
16
17
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
18
 *
19
20
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21
 *
22
 ******************************************************************************/
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
  } stars;

152
153
154
  /*! Maximal depth in that part of the tree */
  int maxdepth;

155
156
  /*! Relative indices of the cell's progeny. */
  int progeny[8];
157

158
159
160
161
162
#ifdef SWIFT_DEBUG_CHECKS
  /* Cell ID (for debugging) */
  int cellID;
#endif

163
} SWIFT_STRUCT_ALIGN;
164

165
166
167
168
169
/**
 * @brief Cell information at the end of a time-step.
 */
struct pcell_step {

170
171
172
173
174
  /*! Hydro variables */
  struct {

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

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

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

182
  } hydro;
183

184
185
186
187
188
189
190
191
  /*! 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;
192

193
  } grav;
194
195
196

  /*! Stars variables */
  struct {
Loic Hausammann's avatar
Loic Hausammann committed
197
198
199
200

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

201
  } stars;
202
203
};

204
205
206
207
208
/**
 * @brief Cell within the tree structure.
 *
 * Contains particles, links to tasks, a multipole object and counters.
 */
209
210
struct cell {

211
  /*! The cell location on the grid. */
212
213
  double loc[3];

214
  /*! The cell dimensions. */
215
  double width[3];
216

217
218
  /*! Linking pointer for "memory management". */
  struct cell *next;
219

220
  /*! Pointers to the next level of cells. */
221
222
  struct cell *progeny[8];

223
  /*! Parent cell. */
224
225
  struct cell *parent;

226
  /*! Super cell, i.e. the highest-level parent cell with *any* task */
227
  struct cell *super;
228

229
230
  /*! Hydro variables */
  struct {
231

232
233
    /*! Pointer to the #part data. */
    struct part *parts;
234

235
236
    /*! Pointer to the #xpart data. */
    struct xpart *xparts;
237

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

241
242
    /*! Super cell, i.e. the highest-level parent cell that has a hydro
     * pair/self tasks */
243
    struct cell *super;
244

245
    /*! Last (integer) time the cell's part were drifted forward in time. */
246
    integertime_t ti_old_part;
247

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

251
252
    /*! Maximum particle movement in this cell since the last sort. */
    float dx_max_sort;
253

254
255
    /*! Max smoothing length in this cell. */
    double h_max;
256

257
258
    /*! Minimum end of (integer) time step in this cell for hydro tasks. */
    integertime_t ti_end_min;
259

260
261
    /*! Maximum end of (integer) time step in this cell for hydro tasks. */
    integertime_t ti_end_max;
262

263
264
    /*! Maximum beginning of (integer) time step in this cell for hydro tasks.
     */
265
    integertime_t ti_beg_max;
266

267
268
    /*! Nr of #part in this cell. */
    int count;
269

270
271
    /*! Spin lock for various uses (#part case). */
    swift_lock_type lock;
272

273
274
    /*! Number of #part updated in this cell. */
    int updated;
275

276
277
278
    /*! Number of #part inhibited in this cell. */
    int inhibited;

279
280
    /*! Is the #part data of this cell being used in a sub-cell? */
    int hold;
281

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

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

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

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

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

297
298
    /*! Does this cell need to be drifted (hydro)? */
    char do_drift;
299

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

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

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

309
310
    /*! The task computing this cell's sorts. */
    struct task *sorts;
311

312
313
    /*! The drift task for parts */
    struct task *drift;
314

315
316
    /*! Linked list of the tasks computing this cell's hydro density. */
    struct link *density;
Loic Hausammann's avatar
Loic Hausammann committed
317

318
319
    /* Linked list of the tasks computing this cell's hydro gradients. */
    struct link *gradient;
Loic Hausammann's avatar
Loic Hausammann committed
320

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

324
325
    /*! Dependency implicit task for the ghost  (in->ghost->out)*/
    struct task *ghost_in;
326

327
328
    /*! Dependency implicit task for the ghost  (in->ghost->out)*/
    struct task *ghost_out;
329

330
331
332
333
334
335
336
337
    /*! 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;
338

Matthieu Schaller's avatar
Matthieu Schaller committed
339
340
341
    /*! Task for star formation */
    struct task *star_formation;

342
#ifdef SWIFT_DEBUG_CHECKS
343

344
345
    /*! Last (integer) time the cell's sort arrays were updated. */
    integertime_t ti_sort;
346

347
#endif
348

349
  } hydro;
350

351
352
  /*! Grav variables */
  struct {
353

354
    /*! Pointer to the #gpart data. */
355
    struct gpart *parts;
356

357
358
    /*! This cell's multipole. */
    struct gravity_tensors *multipole;
359

360
361
362
    /*! Super cell, i.e. the highest-level parent cell that has a grav pair/self
     * tasks */
    struct cell *super;
363

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

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

370
371
372
    /*! Maximum beginning of (integer) time step in this cell for gravity tasks.
     */
    integertime_t ti_beg_max;
373

374
    /*! Last (integer) time the cell's gpart were drifted forward in time. */
375
    integertime_t ti_old_part;
376

377
378
    /*! Last (integer) time the cell's multipole was drifted forward in time. */
    integertime_t ti_old_multipole;
379

380
    /*! Nr of #gpart in this cell. */
381
    int count;
382

383
    /*! Spin lock for various uses (#gpart case). */
384
    swift_lock_type plock;
385

386
387
    /*! Spin lock for various uses (#multipole case). */
    swift_lock_type mlock;
388

389
    /*! Number of #gpart updated in this cell. */
390
    int updated;
391

392
393
394
    /*! Number of #gpart inhibited in this cell. */
    int inhibited;

395
    /*! Is the #gpart data of this cell being used in a sub-cell? */
396
    int phold;
397

398
399
    /*! Is the #multipole data of this cell being used in a sub-cell? */
    int mhold;
400

401
402
    /*! Does this cell need to be drifted (gravity)? */
    char do_drift;
403

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

407
    /*! The drift task for gparts */
408
    struct task *drift;
409

410
411
412
    /*! Implicit task (going up- and down the tree) for the #gpart drifts */
    struct task *drift_out;

413
414
    /*! Linked list of the tasks computing this cell's gravity forces. */
    struct link *grav;
415

416
417
    /*! Linked list of the tasks computing this cell's gravity M-M forces. */
    struct link *mm;
418

419
420
    /*! The multipole initialistation task */
    struct task *init;
421

422
423
    /*! Implicit task for the gravity initialisation */
    struct task *init_out;
424

425
426
    /*! Task computing long range non-periodic gravity interactions */
    struct task *long_range;
427

428
429
    /*! Implicit task for the down propagation */
    struct task *down_in;
430

431
432
    /*! Task propagating the mesh forces to the particles */
    struct task *mesh;
433

434
435
    /*! Task propagating the multipole to the particles */
    struct task *down;
436

437
438
    /*! Number of M-M tasks that are associated with this cell. */
    short int nr_mm_tasks;
439

440
  } grav;
441

442
443
  /*! Stars variables */
  struct {
444

445
446
    /*! Pointer to the #spart data. */
    struct spart *parts;
447

448
449
    /*! Nr of #spart in this cell. */
    int count;
450

Loic Hausammann's avatar
Loic Hausammann committed
451
452
453
454
455
456
457
458
459
460
461
462
    /*! 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
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
    /*! 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;

487
488
    /*! Dependency implicit task for the star ghost  (in->ghost->out)*/
    struct task *ghost_in;
489

490
491
    /*! Dependency implicit task for the star ghost  (in->ghost->out)*/
    struct task *ghost_out;
492

493
494
    /*! The star ghost task itself */
    struct task *ghost;
495

Loic Hausammann's avatar
Loic Hausammann committed
496
497
498
    /*! The task computing this cell's sorts. */
    struct task *sorts;

499
500
    /*! Linked list of the tasks computing this cell's star density. */
    struct link *density;
501

502
503
    /*! Number of #spart updated in this cell. */
    int updated;
504

505
506
507
    /*! Number of #spart inhibited in this cell. */
    int inhibited;

508
509
    /*! Is the #spart data of this cell being used in a sub-cell? */
    int hold;
510

511
512
    /*! Spin lock for various uses (#spart case). */
    swift_lock_type lock;
513

Loic Hausammann's avatar
Loic Hausammann committed
514
515
516
517
518
#ifdef SWIFT_DEBUG_CHECKS
    /*! Last (integer) time the cell's sort arrays were updated. */
    integertime_t ti_sort;
#endif

519
  } stars;
520

521
522
523
#ifdef WITH_MPI
  /*! MPI variables */
  struct {
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

    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;

555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
    /* 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;
572

573
574
  } mpi;
#endif
575

576
577
578
  /*! The task to end the force calculation */
  struct task *end_force;

579
580
  /*! The first kick task */
  struct task *kick1;
581

582
583
  /*! The second kick task */
  struct task *kick2;
584

585
586
587
588
589
590
  /*! The task to compute time-steps */
  struct task *timestep;

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

Loic Hausammann's avatar
Format    
Loic Hausammann committed
591
592
593
  /*! The logger task */
  struct task *logger;

594
595
  /*! Minimum dimension, i.e. smallest edge of this cell (min(width)). */
  float dmin;
596

597
598
599
600
601
602
  /*! ID of the previous owner, e.g. runner. */
  int owner;

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

603
604
605
606
607
608
609
610
611
612
613
614
  /*! 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;

615
#ifdef SWIFT_DEBUG_CHECKS
616
617
618
  /* Cell ID (for debugging) */
  int cellID;

619
620
621
622
623
624
625
  /*! 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

626
} SWIFT_STRUCT_ALIGN;
627

628
629
630
631
/* Convert cell location to ID. */
#define cell_getid(cdim, i, j, k) \
  ((int)(k) + (cdim)[2] * ((int)(j) + (cdim)[1] * (int)(i)))

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

/* 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
716
717
__attribute__((always_inline)) INLINE static int
cell_can_recurse_in_pair_hydro_task(const struct cell *c) {
718
719
720
721
722

  /* 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 */
723
  return c->split && ((kernel_gamma * c->hydro.h_max_old +
724
                       c->hydro.dx_max_part_old) < 0.5f * c->dmin);
725
726
727
728
729
730
731
732
}

/**
 * @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
733
734
__attribute__((always_inline)) INLINE static int
cell_can_recurse_in_self_hydro_task(const struct cell *c) {
735

736
  /* Is the cell split and not smaller than the smoothing length? */
737
  return c->split && (kernel_gamma * c->hydro.h_max_old < 0.5f * c->dmin);
738
739
}

740
741
742
743
744
745
746
747
748
/**
 * @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
749
750
751
752
753
754
  /* 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);
755
756
757
758
759
760
761
762
763
764
765
}

/**
 * @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
766
767
  /* 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);
768
769
}

770
/**
771
 * @brief Can a pair hydro task associated with a cell be split into smaller
772
773
774
775
 * sub-tasks.
 *
 * @param c The #cell.
 */
776
__attribute__((always_inline)) INLINE static int cell_can_split_pair_hydro_task(
777
778
779
780
781
782
783
    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) */
784
785
  return c->split &&
         (space_stretch * kernel_gamma * c->hydro.h_max < 0.5f * c->dmin);
786
787
788
}

/**
789
 * @brief Can a self hydro task associated with a cell be split into smaller
790
791
792
793
 * sub-tasks.
 *
 * @param c The #cell.
 */
794
__attribute__((always_inline)) INLINE static int cell_can_split_self_hydro_task(
795
796
797
    const struct cell *c) {

  /* Is the cell split ? */
798
799
  /* If so, is the cut-off radius with some leeway smaller than */
  /* the sub-cell sizes ? */
800
801
  /* 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 */
802
803
  return c->split &&
         (space_stretch * kernel_gamma * c->hydro.h_max < 0.5f * c->dmin);
804
805
}

806
807
808
809
810
811
812
813
814
/**
 * @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
815
816
817
818
819
820
821
  /* 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);
822
823
824
825
826
827
828
829
830
831
832
}

/**
 * @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
833
834
835
836
837
838
839
  /* 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);
840
841
}

842
843
844
845
846
847
/**
 * @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
848
849
__attribute__((always_inline)) INLINE static int
cell_can_split_pair_gravity_task(const struct cell *c) {
850

851
852
  /* Is the cell split and still far from the leaves ? */
  return c->split && ((c->maxdepth - c->depth) > space_subdepth_diff_grav);
853
854
855
856
857
858
859
860
}

/**
 * @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
861
862
__attribute__((always_inline)) INLINE static int
cell_can_split_self_gravity_task(const struct cell *c) {
863

864
865
  /* Is the cell split and still far from the leaves ? */
  return c->split && ((c->maxdepth - c->depth) > space_subdepth_diff_grav);
866
867
}

868
869
870
871
872
873
874
875
876
877
878
879
880
/**
 * @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 */
881
  return (kernel_gamma * max(ci->hydro.h_max, cj->hydro.h_max) +
882
              ci->hydro.dx_max_part + cj->hydro.dx_max_part >
883
884
          cj->dmin);
}
885

886
/**
887
888
889
 * @brief Add a unique tag to a cell mostly for MPI communications.
 *
 * @param c The #cell to tag.
890
 */
891
__attribute__((always_inline)) INLINE static void cell_tag(struct cell *c) {
892
#ifdef WITH_MPI
893
894

#ifdef SWIFT_DEBUG_CHECKS
895
  if (c->mpi.tag > 0) error("setting tag for already tagged cell");
896
897
#endif

898
899
  if (c->mpi.tag < 0 &&
      (c->mpi.tag = atomic_inc(&cell_next_tag)) > cell_max_tag)
900
901
902
903
904
905
    error("Ran out of cell tags.");
#else
  error("SWIFT was not compiled with MPI enabled.");
#endif  // WITH_MPI
}

906
#endif /* SWIFT_CELL_H */