cell.h 5.45 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
/* Includes. */
Pedro Gonnet's avatar
Pedro Gonnet committed
27
#include "lock.h"
28
#include "multipole.h"
29
30
#include "part.h"
#include "task.h"
31

32
/* Avoid cyclic inclusions */
33
struct space;
34

35
36
37
/* 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.
38
39
 * The maximum was lowered by a further factor of 2 to be on the safe side.*/
#define cell_max_tag (1 << 29)
40

41
42
43
/* Global variables. */
extern int cell_next_tag;

44
45
46
/* Packed cell. */
struct pcell {

47
  /* Stats on this cell's particles. */
48
49
  double h_max;
  int ti_end_min, ti_end_max;
50
51

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

54
55
  /* tag used for MPI communication. */
  int tag;
56

57
58
59
  /* Relative indices of the cell's progeny. */
  int progeny[8];
};
60

61
62
63
/* Structure to store the data of a single cell. */
struct cell {

64
65
66
67
68
69
70
71
72
  /* The cell location on the grid. */
  double loc[3];

  /* The cell dimensions. */
  double h[3];

  /* Max radii in this cell. */
  double h_max;

73
  /* Minimum and maximum end of time step in this cell. */
74
  int ti_end_min, ti_end_max;
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

  /* Minimum dimension, i.e. smallest edge of this cell. */
  float dmin;

  /* Maximum slack allowed for particle movement. */
  float slack;

  /* Maximum particle movement in this cell. */
  float dx_max;

  /* The depth of this cell in the tree. */
  int depth, split, maxdepth;

  /* Nr of parts. */
  int count, gcount;

  /* Pointers to the particle data. */
  struct part *parts;

  /* Pointers to the extra particle data. */
  struct xpart *xparts;

  /* Pointers to the gravity particle data. */
  struct gpart *gparts;

  /* Pointers for the sorted indices. */
  struct entry *sort, *gsort;
  unsigned int sorted, gsorted;

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

  /* Parent cell. */
  struct cell *parent;

  /* Super cell, i.e. the highest-level supercell that has interactions. */
  struct cell *super;
112

113
114
115
116
117
118
119
120
  /* The task computing this cell's sorts. */
  struct task *sorts, *gsorts;
  int sortsize, gsortsize;

  /* The tasks computing this cell's density. */
  struct link *density, *force, *grav;
  int nr_density, nr_force, nr_grav;

Matthieu Schaller's avatar
Matthieu Schaller committed
121
122
  /* The hierarchical tasks. */
  struct task *ghost, *init, *drift, *kick;
123
124
125
126

  /* Task receiving data. */
  struct task *recv_xv, *recv_rho;

127
128
129
  /* Task send data. */
  struct link *send_xv, *send_rho;

130
131
132
  /* Tasks for gravity tree. */
  struct task *grav_up, *grav_down;

133
134
135
  /* Task for external gravity */
  struct task *grav_external;

136
137
138
139
140
141
142
  /* Number of tasks that are associated with this cell. */
  int nr_tasks;

  /* Is the data of this cell being used in a sub-cell? */
  int hold, ghold;

  /* Spin lock for various uses. */
143
  swift_lock_type lock, glock;
144
145
146
147
148

  /* ID of the previous owner, e.g. runner. */
  int owner;

  /* Momentum of particles in cell. */
149
  double mom[3], ang_mom[3];
150

151
152
  /* Mass, potential, internal  and kinetic energy of particles in this cell. */
  double mass, e_pot, e_int, e_kin;
153
154

  /* Number of particles updated in this cell. */
155
  int updated, g_updated;
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

  /* Linking pointer for "memory management". */
  struct cell *next;

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

  /* 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;
  int pcell_size;
  int tag;

  /* This cell's multipole. */
  struct multipole multipole;

} __attribute__((aligned(64)));
175

176
177
178
179
/* Convert cell location to ID. */
#define cell_getid(cdim, i, j, k) \
  ((int)(k) + (cdim)[2] * ((int)(j) + (cdim)[1] * (int)(i)))

180
/* Function prototypes. */
181
182
183
184
185
186
187
188
void cell_split(struct cell *c);
int cell_locktree(struct cell *c);
void cell_unlocktree(struct cell *c);
int cell_glocktree(struct cell *c);
void cell_gunlocktree(struct cell *c);
int cell_pack(struct cell *c, struct pcell *pc);
int cell_unpack(struct pcell *pc, struct cell *c, struct space *s);
int cell_getsize(struct cell *c);
189
190
int cell_link_parts(struct cell *c, struct part *parts);
int cell_link_gparts(struct cell *c, struct gpart *gparts);
191
void cell_init_parts(struct cell *c, void *data);
192
void cell_init_gparts(struct cell *c, void *data);
193
void cell_convert_hydro(struct cell *c, void *data);
194
void cell_clean_links(struct cell *c, void *data);
195
196

#endif /* SWIFT_CELL_H */