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

76
  /* Stats on this cell's particles. */
77
  double h_max;
78
  integertime_t ti_end_min, ti_end_max, ti_beg_max, ti_old_part, ti_old_gpart;
79
80

  /* Number of particles in this cell. */
81
  int count, gcount, scount;
Pedro Gonnet's avatar
Pedro Gonnet committed
82

83
84
  /* tag used for MPI communication. */
  int tag;
85

86
87
  /* Relative indices of the cell's progeny. */
  int progeny[8];
88
89

} SWIFT_STRUCT_ALIGN;
90

91
92
93
94
95
/**
 * @brief Cell within the tree structure.
 *
 * Contains particles, links to tasks, a multipole object and counters.
 */
96
97
struct cell {

98
  /*! The cell location on the grid. */
99
100
  double loc[3];

101
  /*! The cell dimensions. */
102
  double width[3];
103

104
  /*! Max smoothing length in this cell. */
105
106
  double h_max;

107
  /*! This cell's multipole. */
108
  struct gravity_tensors *multipole;
109

110
111
  /*! Linking pointer for "memory management". */
  struct cell *next;
112

113
  /*! Pointer to the #part data. */
114
115
  struct part *parts;

116
  /*! Pointer to the #xpart data. */
117
118
  struct xpart *xparts;

119
  /*! Pointer to the #gpart data. */
120
121
  struct gpart *gparts;

122
  /*! Pointer to the #spart data. */
123
  struct spart *sparts;
124

125
  /*! Pointer for the sorted indices. */
126
  struct entry *sort;
127

128
  /*! Pointers to the next level of cells. */
129
130
  struct cell *progeny[8];

131
  /*! Parent cell. */
132
133
  struct cell *parent;

134
  /*! Super cell, i.e. the highest-level parent cell that has pair/self tasks */
135
  struct cell *super;
136

137
  /*! The task computing this cell's sorts. */
138
  struct task *sorts;
139

140
141
  /*! Linked list of the tasks computing this cell's hydro density. */
  struct link *density;
142

143
144
  /* Linked list of the tasks computing this cell's hydro gradients. */
  struct link *gradient;
145

146
147
  /*! Linked list of the tasks computing this cell's hydro forces. */
  struct link *force;
148

149
150
  /*! Linked list of the tasks computing this cell's gravity forces. */
  struct link *grav;
151

152
153
154
  /*! The multipole initialistation task */
  struct task *init_grav;

155
156
157
  /*! The ghost tasks */
  struct task *ghost_in;
  struct task *ghost_out;
158
  struct task *ghost;
159

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

163
164
165
166
167
  /*! The drift task for parts */
  struct task *drift_part;

  /*! The drift task for gparts */
  struct task *drift_gpart;
168

169
170
171
172
173
  /*! The first kick task */
  struct task *kick1;

  /*! The second kick task */
  struct task *kick2;
174

175
176
  /*! The task to compute time-steps */
  struct task *timestep;
177

178
179
  /*! Task linking the FFT mesh to the rest of gravity tasks */
  struct task *grav_ghost[2];
180

181
  /*! Task computing long range non-periodic gravity interactions */
182
  struct task *grav_long_range;
Tom Theuns's avatar
Tom Theuns committed
183

184
185
  /*! Task propagating the multipole to the particles */
  struct task *grav_down;
186

187
188
  /*! Task for cooling */
  struct task *cooling;
189

190
191
  /*! Task for source terms */
  struct task *sourceterms;
192

193
#ifdef WITH_MPI
194

195
196
  /* Task receiving data (positions). */
  struct task *recv_xv;
197

198
199
  /* Task receiving data (density). */
  struct task *recv_rho;
200

201
202
  /* Task receiving data (gradient). */
  struct task *recv_gradient;
203

204
205
  /* Task receiving data (time-step). */
  struct task *recv_ti;
206

207
208
  /* Linked list for sending data (positions). */
  struct link *send_xv;
209

210
211
  /* Linked list for sending data (density). */
  struct link *send_rho;
212

213
214
215
216
217
  /* Linked list for sending data (gradient). */
  struct link *send_gradient;

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

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

222
  /*! Pointer to this cell's packed representation. */
223
  struct pcell *pcell;
224
225

  /*! Size of the packed representation */
226
  int pcell_size;
227
228

  /*! MPI tag associated with this cell */
229
230
  int tag;

231
#endif
232

233
  /*! Minimum end of (integer) time step in this cell. */
234
  integertime_t ti_end_min;
235
236

  /*! Maximum end of (integer) time step in this cell. */
237
  integertime_t ti_end_max;
238

239
240
  /*! Maximum beginning of (integer) time step in this cell. */
  integertime_t ti_beg_max;
Matthieu Schaller's avatar
Matthieu Schaller committed
241

242
243
244
  /*! Last (integer) time the cell's sort arrays were updated. */
  integertime_t ti_sort;

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

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

251
252
253
  /*! Last (integer) time the cell's multipole was drifted forward in time. */
  integertime_t ti_old_multipole;

254
255
256
  /*! Minimum dimension, i.e. smallest edge of this cell (min(width)). */
  float dmin;

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

260
261
262
263
264
265
  /*! Maximum part movement in this cell since last construction. */
  float dx_max_part;

  /*! Maximum gpart movement in this cell since last construction. */
  float dx_max_gpart;

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

  /*! Nr of #gpart in this cell. */
  int gcount;

272
273
274
  /*! Nr of #spart in this cell. */
  int scount;

275
276
277
278
279
280
281
282
283
  /*! Bit-mask indicating the sorted directions */
  unsigned int sorted;

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

  /*! Spin lock for various uses (#gpart case). */
  swift_lock_type glock;

284
285
286
  /*! Spin lock for various uses (#multipole case). */
  swift_lock_type mlock;

287
288
289
  /*! Spin lock for various uses (#spart case). */
  swift_lock_type slock;

290
291
292
293
294
295
296
297
298
  /*! ID of the previous owner, e.g. runner. */
  int owner;

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

  /*! Number of #gpart updated in this cell. */
  int g_updated;

299
300
301
  /*! Number of #spart updated in this cell. */
  int s_updated;

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

305
306
307
308
309
310
  /*! Is the #part data of this cell being used in a sub-cell? */
  int hold;

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

311
312
313
  /*! Is the #multipole data of this cell being used in a sub-cell? */
  int mhold;

314
315
316
  /*! Is the #spart data of this cell being used in a sub-cell? */
  int shold;

317
318
319
320
321
322
323
324
325
326
327
328
  /*! 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;

329
330
331
332
333
334
335
  /*! Values of dx_max and h_max before the drifts, used for sub-cell tasks. */
  float dx_max_old;
  float h_max_old;
  float dx_max_sort_old;

  /* Will this cell do anything that relies on its sorts being set correctly? */
  integertime_t requires_sorts;
336

337
338
  /*! Does this cell need to be drifted? */
  char do_drift;
339

340
341
  /*! Does any of this cell's sub-cells need to be drifted? */
  char do_sub_drift;
342

343
344
345
346
347
348
349
350
#ifdef SWIFT_DEBUG_CHECKS
  /*! 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

351
} SWIFT_STRUCT_ALIGN;
352

353
354
355
356
/* Convert cell location to ID. */
#define cell_getid(cdim, i, j, k) \
  ((int)(k) + (cdim)[2] * ((int)(j) + (cdim)[1] * (int)(i)))

357
/* Function prototypes. */
358
359
void cell_split(struct cell *c, ptrdiff_t parts_offset, ptrdiff_t sparts_offset,
                struct cell_buff *buff, struct cell_buff *sbuff,
360
                struct cell_buff *gbuff);
361
void cell_sanitize(struct cell *c);
362
363
364
365
int cell_locktree(struct cell *c);
void cell_unlocktree(struct cell *c);
int cell_glocktree(struct cell *c);
void cell_gunlocktree(struct cell *c);
366
367
int cell_mlocktree(struct cell *c);
void cell_munlocktree(struct cell *c);
368
369
int cell_slocktree(struct cell *c);
void cell_sunlocktree(struct cell *c);
370
371
int cell_pack(struct cell *c, struct pcell *pc);
int cell_unpack(struct pcell *pc, struct cell *c, struct space *s);
372
373
int cell_pack_ti_ends(struct cell *c, integertime_t *ti_ends);
int cell_unpack_ti_ends(struct cell *c, integertime_t *ti_ends);
374
int cell_getsize(struct cell *c);
375
376
int cell_link_parts(struct cell *c, struct part *parts);
int cell_link_gparts(struct cell *c, struct gpart *gparts);
377
int cell_link_sparts(struct cell *c, struct spart *sparts);
378
void cell_convert_hydro(struct cell *c, void *data);
379
void cell_clean_links(struct cell *c, void *data);
380
void cell_make_multipoles(struct cell *c, integertime_t ti_current);
381
void cell_check_multipole(struct cell *c, void *data);
382
void cell_clean(struct cell *c);
383
384
void cell_check_part_drift_point(struct cell *c, void *data);
void cell_check_gpart_drift_point(struct cell *c, void *data);
385
void cell_check_multipole_drift_point(struct cell *c, void *data);
386
void cell_reset_task_counters(struct cell *c);
387
int cell_is_drift_needed(struct cell *c, const struct engine *e);
388
int cell_unskip_tasks(struct cell *c, struct scheduler *s);
389
void cell_set_super(struct cell *c, struct cell *super);
390
void cell_drift_part(struct cell *c, const struct engine *e, int force);
391
void cell_drift_gpart(struct cell *c, const struct engine *e);
392
void cell_drift_multipole(struct cell *c, const struct engine *e);
393
void cell_drift_all_multipoles(struct cell *c, const struct engine *e);
394
void cell_check_timesteps(struct cell *c);
395
396
397
void cell_store_pre_drift_values(struct cell *c);
void cell_activate_subcell_tasks(struct cell *ci, struct cell *cj,
                                 struct scheduler *s);
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463

/* 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.
 */
__attribute__((always_inline)) INLINE static int cell_can_recurse_in_pair_task(
    const struct cell *c) {

  /* 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->h_max_old + c->dx_max_old) < 0.5f * c->dmin);
}

/**
 * @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.
 */
__attribute__((always_inline)) INLINE static int cell_can_recurse_in_self_task(
    const struct cell *c) {

  /* Is the cell split ? */
  /* Note: No need for more checks here as all the sub-pairs and sub-self */
  /* operations will be executed. So no need for the particle to be at exactly
   */
  /* the right place. */
  return c->split;
}

/**
 * @brief Can a pair 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_task(
    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) */
  return c->split && (space_stretch * kernel_gamma * c->h_max < 0.5f * c->dmin);
}

/**
 * @brief Can a self 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_task(
    const struct cell *c) {

  /* Is the cell split ? */
  /* 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 */
464
  return c->split && (space_stretch * kernel_gamma * c->h_max < 0.5f * c->dmin);
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
}

/**
 * @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 */
  return (kernel_gamma * max(ci->h_max, cj->h_max) + ci->dx_max_part +
              cj->dx_max_part >
          cj->dmin);
}
484

485
#endif /* SWIFT_CELL_H */