engine.h 13.2 KB
Newer Older
Pedro Gonnet's avatar
Pedro Gonnet committed
1
/*******************************************************************************
2
 * This file is part of SWIFT.
3
 * Copyright (c) 2012 Pedro Gonnet (pedro.gonnet@durham.ac.uk)
4
5
6
7
8
 *                    Matthieu Schaller (matthieu.schaller@durham.ac.uk)
 *               2015 Peter W. Draper (p.w.draper@durham.ac.uk)
 *                    Angus Lepper (angus.lepper@ed.ac.uk)
 *               2016 John A. Regan (john.a.regan@durham.ac.uk)
 *                    Tom Theuns (tom.theuns@durham.ac.uk)
9
 *
Pedro Gonnet's avatar
Pedro Gonnet committed
10
11
12
13
 * 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.
14
 *
Pedro Gonnet's avatar
Pedro Gonnet committed
15
16
17
18
 * 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.
19
 *
Pedro Gonnet's avatar
Pedro Gonnet committed
20
21
 * 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/>.
22
 *
Pedro Gonnet's avatar
Pedro Gonnet committed
23
 ******************************************************************************/
24
25
#ifndef SWIFT_ENGINE_H
#define SWIFT_ENGINE_H
Pedro Gonnet's avatar
Pedro Gonnet committed
26

27
28
29
30
31
32
33
34
/* Config parameters. */
#include "../config.h"

/* MPI headers. */
#ifdef WITH_MPI
#include <mpi.h>
#endif

Pedro Gonnet's avatar
Pedro Gonnet committed
35
/* Includes. */
36
#include "barrier.h"
37
#include "chemistry_struct.h"
38
#include "clocks.h"
39
#include "collectgroup.h"
40
#include "cooling_struct.h"
41
#include "gravity_properties.h"
42
#include "mesh_gravity.h"
Matthieu Schaller's avatar
Matthieu Schaller committed
43
#include "parser.h"
44
#include "partition.h"
45
#include "potential.h"
Matthieu Schaller's avatar
Matthieu Schaller committed
46
#include "runner.h"
47
#include "scheduler.h"
Tom Theuns's avatar
Tom Theuns committed
48
#include "sourceterms_struct.h"
Matthieu Schaller's avatar
Matthieu Schaller committed
49
50
51
#include "space.h"
#include "task.h"
#include "units.h"
Pedro Gonnet's avatar
Pedro Gonnet committed
52

53
54
55
/**
 * @brief The different policies the #engine can follow.
 */
56
57
enum engine_policy {
  engine_policy_none = 0,
58
59
60
61
  engine_policy_rand = (1 << 0),
  engine_policy_steal = (1 << 1),
  engine_policy_keep = (1 << 2),
  engine_policy_block = (1 << 3),
62
63
64
65
66
67
68
69
  engine_policy_cputight = (1 << 4),
  engine_policy_mpi = (1 << 5),
  engine_policy_setaffinity = (1 << 6),
  engine_policy_hydro = (1 << 7),
  engine_policy_self_gravity = (1 << 8),
  engine_policy_external_gravity = (1 << 9),
  engine_policy_cosmology = (1 << 10),
  engine_policy_drift_all = (1 << 11),
70
71
72
  engine_policy_reconstruct_mpoles = (1 << 12),
  engine_policy_cooling = (1 << 13),
  engine_policy_sourceterms = (1 << 14),
73
74
  engine_policy_stars = (1 << 15),
  engine_policy_structure_finding = (1 << 16)
75
};
James Willis's avatar
James Willis committed
76
#define engine_maxpolicy 16
77
extern const char *engine_policy_names[];
Pedro Gonnet's avatar
Pedro Gonnet committed
78

79
80
81
82
83
84
85
86
87
/**
 * @brief The different unusual events that can take place in a time-step.
 */
enum engine_step_properties {
  engine_step_prop_none = 0,
  engine_step_prop_rebuild = (1 << 0),
  engine_step_prop_redistribute = (1 << 1),
  engine_step_prop_repartition = (1 << 2),
  engine_step_prop_statistics = (1 << 3),
88
89
  engine_step_prop_snapshot = (1 << 4),
  engine_step_prop_restarts = (1 << 5)
90
91
92
};

/* Some constants */
93
#define engine_maxproxies 64
94
#define engine_tasksreweight 1
95
#define engine_parts_size_grow 1.05
96
#define engine_redistribute_alloc_margin 1.2
97
98
#define engine_default_energy_file_name "energy"
#define engine_default_timesteps_file_name "timesteps"
99
#define engine_max_parts_per_ghost 1000
Loic Hausammann's avatar
Loic Hausammann committed
100
#define engine_max_sparts_per_ghost 1000
Pedro Gonnet's avatar
Pedro Gonnet committed
101

102
103
104
/**
 * @brief The rank of the engine as a global variable (for messages).
 */
105
106
extern int engine_rank;

Pedro Gonnet's avatar
Pedro Gonnet committed
107
108
109
/* Data structure for the engine. */
struct engine {

110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
  /* Number of threads on which to run. */
  int nr_threads;

  /* The space with which the runner is associated. */
  struct space *s;

  /* The runner's threads. */
  struct runner *runners;

  /* The running policy. */
  int policy;

  /* The task scheduler. */
  struct scheduler sched;

125
126
127
  /* Common threadpool for all the engine's tasks. */
  struct threadpool threadpool;

128
  /* The minimum and maximum allowed dt */
129
  double dt_min, dt_max;
130

131
132
133
134
135
136
  /* Maximum time-step allowed by the RMS condition in cosmology runs. */
  double dt_max_RMS_displacement;

  /* Dimensionless factor for the RMS time-step condition. */
  double max_RMS_displacement_factor;

137
  /* Time of the simulation beginning */
138
  double time_begin;
139
140

  /* Time of the simulation end */
141
  double time_end;
142
143

  /* The previous system time. */
144
  double time_old;
145
  integertime_t ti_old;
146
147

  /* The current system time. */
148
  double time;
149
  integertime_t ti_current;
150

151
152
153
  /* The highest active bin at this time */
  timebin_t max_active_bin;

154
155
156
  /* The lowest active bin at this time */
  timebin_t min_active_bin;

157
  /* Time step */
158
  double time_step;
159

160
  /* Time base */
161
162
  double time_base;
  double time_base_inv;
163

164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
  /* Minimal hydro ti_end for the next time-step */
  integertime_t ti_hydro_end_min;

  /* Maximal hydro ti_end for the next time-step */
  integertime_t ti_hydro_end_max;

  /* Maximal hydro ti_beg for the next time-step */
  integertime_t ti_hydro_beg_max;

  /* Minimal gravity ti_end for the next time-step */
  integertime_t ti_gravity_end_min;

  /* Maximal gravity ti_end for the next time-step */
  integertime_t ti_gravity_end_max;

  /* Maximal gravity ti_beg for the next time-step */
  integertime_t ti_gravity_beg_max;

  /* Minimal overall ti_end for the next time-step */
183
  integertime_t ti_end_min;
184

185
  /* Maximal overall ti_end for the next time-step */
Matthieu Schaller's avatar
Matthieu Schaller committed
186
187
  integertime_t ti_end_max;

188
  /* Maximal overall ti_beg for the next time-step */
Matthieu Schaller's avatar
Matthieu Schaller committed
189
190
  integertime_t ti_beg_max;

191
  /* Number of particles updated in the previous step */
192
  long long updates, g_updates, s_updates;
193

194
  /* Number of updates since the last rebuild */
195
196
197
  long long updates_since_rebuild;
  long long g_updates_since_rebuild;
  long long s_updates_since_rebuild;
198

199
  /* Properties of the previous step */
200
  int step_props;
201

202
  /* Total numbers of particles in the system. */
203
  long long total_nr_parts, total_nr_gparts, total_nr_sparts;
204

205
206
207
  /* Total mass in the simulation */
  double total_mass;

208
  /* The internal system of units */
209
  const struct unit_system *internal_units;
Matthieu Schaller's avatar
Matthieu Schaller committed
210

211
  /* Top-level cell locations for VELOCIraptor. */
212
  struct cell_loc *cell_loc;
213

214
  /* Snapshot information */
215
216
217
  double a_first_snapshot;
  double time_first_snapshot;
  double delta_time_snapshot;
Loic Hausammann's avatar
Loic Hausammann committed
218

219
220
  /* Output_List for the snapshots */
  struct output_list *output_list_snapshots;
221
222
223
224

  /* Integer time of the next snapshot */
  integertime_t ti_next_snapshot;

225
226
  char snapshot_base_name[PARSER_MAX_LINE_SIZE];
  int snapshot_compression;
227
  int snapshot_label_first;
228
  int snapshot_label_delta;
229
230
  struct unit_system *snapshot_units;
  int snapshot_output_count;
231

232
  /* Structure finding information */
233
  int stf_output_freq_format;
234
  double a_first_stf;
235
236
  double timeFirstSTFOutput;
  double deltaTimeSTF;
237
  int deltaStepSTF;
Matthieu Schaller's avatar
Matthieu Schaller committed
238

239
240
  /* Output_List for the structure finding */
  struct output_list *output_list_stf;
Loic Hausammann's avatar
Loic Hausammann committed
241

242
  /* Integer time of the next stf output */
243
  integertime_t ti_nextSTF;
Matthieu Schaller's avatar
Matthieu Schaller committed
244

245
  char stfBaseName[PARSER_MAX_LINE_SIZE];
246

247
  /* Statistics information */
248
249
250
251
  double a_first_statistics;
  double time_first_statistics;
  double delta_time_statistics;

252
253
  /* Output_List for the stats */
  struct output_list *output_list_stats;
Loic Hausammann's avatar
Format    
Loic Hausammann committed
254

255
256
257
258
  /* Integer time of the next statistics dump */
  integertime_t ti_next_stats;

  /* File handle for the statistics */
259
  FILE *file_stats;
Pedro Gonnet's avatar
Pedro Gonnet committed
260

261
  /* File handle for the timesteps information */
Matthieu Schaller's avatar
Matthieu Schaller committed
262
263
  FILE *file_timesteps;

264
  /* The current step number. */
265
  int step;
266
267

  /* Data for the threads' barrier. */
268
269
  swift_barrier_t wait_barrier;
  swift_barrier_t run_barrier;
270
271
272
273
274
275
276
277

  /* ID of the node this engine lives on. */
  int nr_nodes, nodeID;

  /* Proxies for the other nodes in this simulation. */
  struct proxy *proxies;
  int nr_proxies, *proxy_ind;

278
#ifdef SWIFT_DEBUG_TASKS
279
280
  /* Tic/toc at the start/end of a step. */
  ticks tic_step, toc_step;
281
#endif
282

283
#ifdef WITH_MPI
284
285
  /* CPU time of the last step. */
  double cputime_last_step;
286

287
288
  /* Step of last repartition. */
  int last_repartition;
289
290
#endif

291
292
  /* Wallclock time of the last time-step */
  float wallclock_time;
293

294
295
296
  /* Are we in the process of restaring a simulation? */
  int restarting;

297
  /* Force the engine to rebuild? */
298
  int forcerebuild;
299
300
301

  /* Force the engine to repartition ? */
  int forcerepart;
302
  struct repartition *reparttype;
303
304
305
306
307
308

  /* How many steps have we done with the same set of tasks? */
  int tasks_age;

  /* Linked list for cell-task association. */
  struct link *links;
309
  size_t nr_links, size_links;
310

311
312
  /* Average number of tasks per cell. Used to estimate the sizes
   * of the various task arrays. */
313
  size_t tasks_per_cell;
314

315
316
  /* Are we talkative ? */
  int verbose;
317
318

  /* Physical constants definition */
Matthieu Schaller's avatar
Matthieu Schaller committed
319
  const struct phys_const *physical_constants;
320

321
322
323
  /* The cosmological model */
  struct cosmology *cosmology;

324
325
326
  /* Properties of the hydro scheme */
  const struct hydro_props *hydro_properties;

Loic Hausammann's avatar
Loic Hausammann committed
327
328
329
  /* Properties of the star model */
  const struct stars_props *stars_properties;

330
  /* Properties of the self-gravity scheme */
331
  struct gravity_props *gravity_properties;
332

333
334
335
  /* The mesh used for long-range gravity forces */
  struct pm_mesh *mesh;

336
  /* Properties of external gravitational potential */
Matthieu Schaller's avatar
Matthieu Schaller committed
337
  const struct external_potential *external_potential;
338

339
  /* Properties of the cooling scheme */
Tom Theuns's avatar
Tom Theuns committed
340
  const struct cooling_function_data *cooling_func;
341

342
  /* Properties of the chemistry model */
343
  const struct chemistry_global_data *chemistry;
344

Tom Theuns's avatar
Tom Theuns committed
345
  /* Properties of source terms */
Tom Theuns's avatar
Tom Theuns committed
346
  struct sourceterms *sourceterms;
Tom Theuns's avatar
Tom Theuns committed
347

348
  /* The (parsed) parameter file */
lhausamm's avatar
lhausamm committed
349
  struct swift_params *parameter_file;
350
351
352
353

  /* Temporary struct to hold a group of deferable properties (in MPI mode
   * these are reduced together, but may not be required just yet). */
  struct collectgroup1 collect_group1;
Peter W. Draper's avatar
Peter W. Draper committed
354

355
356
357
  /* Whether to dump restart files. */
  int restart_dump;

358
359
360
  /* Whether to save previous generation of restart files. */
  int restart_save;

361
362
363
  /* Whether to dump restart files after the last step. */
  int restart_onexit;

Peter W. Draper's avatar
Peter W. Draper committed
364
  /* Name of the restart file. */
365
  const char *restart_file;
366
367
368
369
370
371

  /* Ticks between restart dumps. */
  ticks restart_dt;

  /* Time after which next dump will occur. */
  ticks restart_next;
372
373
374

  /* Maximum number of tasks needed for restarting. */
  int restart_max_tasks;
375
};
Pedro Gonnet's avatar
Pedro Gonnet committed
376
377

/* Function prototypes. */
378
void engine_addlink(struct engine *e, struct link **l, struct task *t);
Pedro Gonnet's avatar
Pedro Gonnet committed
379
void engine_barrier(struct engine *e);
380
void engine_compute_next_snapshot_time(struct engine *e);
381
void engine_compute_next_stf_time(struct engine *e);
382
void engine_compute_next_statistics_time(struct engine *e);
383
void engine_recompute_displacement_constraint(struct engine *e);
384
385
void engine_unskip(struct engine *e);
void engine_drift_all(struct engine *e);
386
void engine_drift_top_multipoles(struct engine *e);
387
void engine_reconstruct_multipoles(struct engine *e);
388
void engine_print_stats(struct engine *e);
389
void engine_check_for_dumps(struct engine *e);
390
void engine_dump_snapshot(struct engine *e);
391
void engine_init_output_lists(struct engine *e, struct swift_params *params);
Matthieu Schaller's avatar
Matthieu Schaller committed
392
393
394
void engine_init(struct engine *e, struct space *s, struct swift_params *params,
                 long long Ngas, long long Ngparts, long long Nstars,
                 int policy, int verbose, struct repartition *reparttype,
Matthieu Schaller's avatar
Matthieu Schaller committed
395
396
397
                 const struct unit_system *internal_units,
                 const struct phys_const *physical_constants,
                 struct cosmology *cosmo, const struct hydro_props *hydro,
Loic Hausammann's avatar
Loic Hausammann committed
398
                 struct gravity_props *gravity, const struct stars_props *stars,
399
                 struct pm_mesh *mesh,
Matthieu Schaller's avatar
Matthieu Schaller committed
400
401
402
403
                 const struct external_potential *potential,
                 const struct cooling_function_data *cooling_func,
                 const struct chemistry_global_data *chemistry,
                 struct sourceterms *sourceterms);
Matthieu Schaller's avatar
Matthieu Schaller committed
404
405
406
void engine_config(int restart, struct engine *e, struct swift_params *params,
                   int nr_nodes, int nodeID, int nr_threads, int with_aff,
                   int verbose, const char *restart_file);
407
void engine_launch(struct engine *e);
408
void engine_prepare(struct engine *e);
409
410
void engine_init_particles(struct engine *e, int flag_entropy_ICs,
                           int clean_h_values);
411
412
void engine_step(struct engine *e);
void engine_maketasks(struct engine *e);
413
void engine_split(struct engine *e, struct partition *initial_partition);
414
415
void engine_exchange_strays(struct engine *e, size_t offset_parts,
                            int *ind_part, size_t *Npart, size_t offset_gparts,
416
417
418
                            int *ind_gpart, size_t *Ngpart,
                            size_t offset_sparts, int *ind_spart,
                            size_t *Nspart);
419
void engine_rebuild(struct engine *e, int clean_h_values);
420
void engine_repartition(struct engine *e);
421
void engine_repartition_trigger(struct engine *e);
422
423
void engine_makeproxies(struct engine *e);
void engine_redistribute(struct engine *e);
Matthieu Schaller's avatar
Matthieu Schaller committed
424
void engine_print_policy(struct engine *e);
425
int engine_is_done(struct engine *e);
426
427
void engine_pin(void);
void engine_unpin(void);
428
void engine_clean(struct engine *e);
429
int engine_estimate_nr_tasks(struct engine *e);
430

431
#ifdef HAVE_SETAFFINITY
432
cpu_set_t *engine_entry_affinity(void);
433
434
#endif

435
436
437
/* Struct dump/restore support. */
void engine_struct_dump(struct engine *e, FILE *stream);
void engine_struct_restore(struct engine *e, FILE *stream);
438
void engine_dump_restarts(struct engine *e, int drifted_all, int final_step);
439

440
#endif /* SWIFT_ENGINE_H */