engine.h 13.9 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"
Loikki's avatar
Loikki committed
41
#include "dump.h"
42
#include "gravity_properties.h"
43
#include "mesh_gravity.h"
Matthieu Schaller's avatar
Matthieu Schaller committed
44
#include "parser.h"
45
#include "partition.h"
46
#include "potential.h"
Matthieu Schaller's avatar
Matthieu Schaller committed
47
#include "runner.h"
48
#include "scheduler.h"
Tom Theuns's avatar
Tom Theuns committed
49
#include "sourceterms_struct.h"
Matthieu Schaller's avatar
Matthieu Schaller committed
50
51
52
#include "space.h"
#include "task.h"
#include "units.h"
53
#include "velociraptor_interface.h"
Pedro Gonnet's avatar
Pedro Gonnet committed
54

55
56
57
/**
 * @brief The different policies the #engine can follow.
 */
58
59
enum engine_policy {
  engine_policy_none = 0,
60
61
62
63
  engine_policy_rand = (1 << 0),
  engine_policy_steal = (1 << 1),
  engine_policy_keep = (1 << 2),
  engine_policy_block = (1 << 3),
64
65
66
67
68
69
70
71
  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),
72
73
74
  engine_policy_reconstruct_mpoles = (1 << 12),
  engine_policy_cooling = (1 << 13),
  engine_policy_sourceterms = (1 << 14),
75
  engine_policy_stars = (1 << 15),
Loic Hausammann's avatar
Loic Hausammann committed
76
  engine_policy_structure_finding = (1 << 16),
Matthieu Schaller's avatar
Matthieu Schaller committed
77
  engine_policy_star_formation = (1 << 17),
Loikki's avatar
Loikki committed
78
79
  engine_policy_feedback = (1 << 18),
  engine_policy_logger = (1 << 19)
80
};
Loikki's avatar
Loikki committed
81
#define engine_maxpolicy 19
82
extern const char *engine_policy_names[];
Pedro Gonnet's avatar
Pedro Gonnet committed
83

84
85
86
87
88
89
90
91
92
/**
 * @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),
93
94
  engine_step_prop_snapshot = (1 << 4),
  engine_step_prop_restarts = (1 << 5)
95
96
97
};

/* Some constants */
98
#define engine_maxproxies 64
99
#define engine_tasksreweight 1
100
#define engine_parts_size_grow 1.05
101
#define engine_redistribute_alloc_margin 1.2
102
103
#define engine_default_energy_file_name "energy"
#define engine_default_timesteps_file_name "timesteps"
104
#define engine_max_parts_per_ghost 1000
Loic Hausammann's avatar
Loic Hausammann committed
105
#define engine_max_sparts_per_ghost 1000
Pedro Gonnet's avatar
Pedro Gonnet committed
106

107
108
109
/**
 * @brief The rank of the engine as a global variable (for messages).
 */
110
111
extern int engine_rank;

Pedro Gonnet's avatar
Pedro Gonnet committed
112
113
114
/* Data structure for the engine. */
struct engine {

115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
  /* 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;

130
131
132
  /* Common threadpool for all the engine's tasks. */
  struct threadpool threadpool;

133
  /* The minimum and maximum allowed dt */
134
  double dt_min, dt_max;
135

136
137
138
139
140
141
  /* 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;

142
  /* Time of the simulation beginning */
143
  double time_begin;
144
145

  /* Time of the simulation end */
146
  double time_end;
147
148

  /* The previous system time. */
149
  double time_old;
150
  integertime_t ti_old;
151
152

  /* The current system time. */
153
  double time;
154
  integertime_t ti_current;
155

156
157
158
  /* The highest active bin at this time */
  timebin_t max_active_bin;

159
160
161
  /* The lowest active bin at this time */
  timebin_t min_active_bin;

162
  /* Time step */
163
  double time_step;
164

165
  /* Time base */
166
167
  double time_base;
  double time_base_inv;
168

169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
  /* 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 */
188
  integertime_t ti_end_min;
189

190
  /* Maximal overall ti_end for the next time-step */
Matthieu Schaller's avatar
Matthieu Schaller committed
191
192
  integertime_t ti_end_max;

193
  /* Maximal overall ti_beg for the next time-step */
Matthieu Schaller's avatar
Matthieu Schaller committed
194
195
  integertime_t ti_beg_max;

196
  /* Number of particles updated in the previous step */
197
  long long updates, g_updates, s_updates;
198

199
  /* Number of updates since the last rebuild */
200
201
202
  long long updates_since_rebuild;
  long long g_updates_since_rebuild;
  long long s_updates_since_rebuild;
203

204
  /* Properties of the previous step */
205
  int step_props;
206

207
  /* Total numbers of particles in the system. */
208
  long long total_nr_parts, total_nr_gparts, total_nr_sparts;
209

210
  /* The total number of inhibted particles in the system. */
211
  long long nr_inhibited_parts, nr_inhibited_gparts, nr_inhibited_sparts;
212

Matthieu Schaller's avatar
Matthieu Schaller committed
213
214
215
216
217
218
#ifdef SWIFT_DEBUG_CHECKS
  /* Total number of particles removed from the system since the last rebuild */
  long long count_inhibited_parts, count_inhibited_gparts,
      count_inhibited_sparts;
#endif

219
220
221
  /* Total mass in the simulation */
  double total_mass;

222
  /* The internal system of units */
223
  const struct unit_system *internal_units;
Matthieu Schaller's avatar
Matthieu Schaller committed
224

225
  /* Top-level cell locations for VELOCIraptor. */
226
  struct cell_loc *cell_loc;
227

228
  /* Snapshot information */
229
230
231
  double a_first_snapshot;
  double time_first_snapshot;
  double delta_time_snapshot;
Loic Hausammann's avatar
Loic Hausammann committed
232

233
234
  /* Output_List for the snapshots */
  struct output_list *output_list_snapshots;
235
236
237
238

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

239
240
  char snapshot_base_name[PARSER_MAX_LINE_SIZE];
  int snapshot_compression;
241
  int snapshot_int_time_label_on;
242
243
  struct unit_system *snapshot_units;
  int snapshot_output_count;
244

245
  /* Structure finding information */
246
  enum io_stf_output_format stf_output_freq_format;
247
248
249
250
  int delta_step_stf;
  double a_first_stf_output;
  double time_first_stf_output;
  double delta_time_stf;
Matthieu Schaller's avatar
Matthieu Schaller committed
251

252
253
  /* Output_List for the structure finding */
  struct output_list *output_list_stf;
Loic Hausammann's avatar
Loic Hausammann committed
254

255
  /* Integer time of the next stf output */
256
  integertime_t ti_next_stf;
Matthieu Schaller's avatar
Matthieu Schaller committed
257

258
  char stfBaseName[PARSER_MAX_LINE_SIZE];
259

260
  /* Statistics information */
261
262
263
264
  double a_first_statistics;
  double time_first_statistics;
  double delta_time_statistics;

265
266
  /* Output_List for the stats */
  struct output_list *output_list_stats;
Loic Hausammann's avatar
Format    
Loic Hausammann committed
267

268
269
270
271
  /* Integer time of the next statistics dump */
  integertime_t ti_next_stats;

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

274
  /* File handle for the timesteps information */
Matthieu Schaller's avatar
Matthieu Schaller committed
275
276
  FILE *file_timesteps;

277
  /* The current step number. */
278
  int step;
279
280

  /* Data for the threads' barrier. */
281
282
  swift_barrier_t wait_barrier;
  swift_barrier_t run_barrier;
283
284
285
286
287
288
289
290

  /* 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;

291
#ifdef SWIFT_DEBUG_TASKS
292
293
  /* Tic/toc at the start/end of a step. */
  ticks tic_step, toc_step;
294
#endif
295

296
#ifdef WITH_MPI
297
298
  /* CPU time of the last step. */
  double cputime_last_step;
299

300
301
  /* Step of last repartition. */
  int last_repartition;
302
303
#endif

304
305
  /* Wallclock time of the last time-step */
  float wallclock_time;
306

307
308
309
  /* Are we in the process of restaring a simulation? */
  int restarting;

310
  /* Force the engine to rebuild? */
311
  int forcerebuild;
312
313
314

  /* Force the engine to repartition ? */
  int forcerepart;
315
  struct repartition *reparttype;
316

Loikki's avatar
Loikki committed
317
318
319
320
321
322
  /* Number of particle steps between dumping a chunk of data */
  int logger_max_steps;

  /* File name of the dump file */
  struct dump *logger_dump;

323
324
325
326
327
  /* How many steps have we done with the same set of tasks? */
  int tasks_age;

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

330
331
  /* Average number of tasks per cell. Used to estimate the sizes
   * of the various task arrays. */
332
  size_t tasks_per_cell;
333

334
335
  /* Are we talkative ? */
  int verbose;
336
337

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

340
341
342
  /* The cosmological model */
  struct cosmology *cosmology;

343
344
345
  /* Properties of the hydro scheme */
  const struct hydro_props *hydro_properties;

Loic Hausammann's avatar
Loic Hausammann committed
346
347
348
  /* Properties of the star model */
  const struct stars_props *stars_properties;

349
  /* Properties of the self-gravity scheme */
350
  struct gravity_props *gravity_properties;
351

352
353
354
  /* The mesh used for long-range gravity forces */
  struct pm_mesh *mesh;

355
  /* Properties of external gravitational potential */
Matthieu Schaller's avatar
Matthieu Schaller committed
356
  const struct external_potential *external_potential;
357

358
  /* Properties of the cooling scheme */
Tom Theuns's avatar
Tom Theuns committed
359
  const struct cooling_function_data *cooling_func;
360

361
  /* Properties of the chemistry model */
362
  const struct chemistry_global_data *chemistry;
363

Tom Theuns's avatar
Tom Theuns committed
364
  /* Properties of source terms */
Tom Theuns's avatar
Tom Theuns committed
365
  struct sourceterms *sourceterms;
Tom Theuns's avatar
Tom Theuns committed
366

367
  /* The (parsed) parameter file */
lhausamm's avatar
lhausamm committed
368
  struct swift_params *parameter_file;
369
370
371
372

  /* 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
373

374
375
376
  /* Whether to dump restart files. */
  int restart_dump;

377
378
379
  /* Whether to save previous generation of restart files. */
  int restart_save;

380
381
382
  /* Whether to dump restart files after the last step. */
  int restart_onexit;

Peter W. Draper's avatar
Peter W. Draper committed
383
  /* Name of the restart file. */
384
  const char *restart_file;
385
386
387
388
389
390

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

  /* Time after which next dump will occur. */
  ticks restart_next;
391
392
393

  /* Maximum number of tasks needed for restarting. */
  int restart_max_tasks;
394
};
Pedro Gonnet's avatar
Pedro Gonnet committed
395
396

/* Function prototypes. */
397
void engine_addlink(struct engine *e, struct link **l, struct task *t);
Pedro Gonnet's avatar
Pedro Gonnet committed
398
void engine_barrier(struct engine *e);
399
void engine_compute_next_snapshot_time(struct engine *e);
400
void engine_compute_next_stf_time(struct engine *e);
401
void engine_compute_next_statistics_time(struct engine *e);
402
void engine_recompute_displacement_constraint(struct engine *e);
403
404
void engine_unskip(struct engine *e);
void engine_drift_all(struct engine *e);
405
void engine_drift_top_multipoles(struct engine *e);
406
void engine_reconstruct_multipoles(struct engine *e);
407
void engine_print_stats(struct engine *e);
408
void engine_check_for_dumps(struct engine *e);
409
void engine_dump_snapshot(struct engine *e);
410
void engine_init_output_lists(struct engine *e, struct swift_params *params);
Matthieu Schaller's avatar
Matthieu Schaller committed
411
412
413
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
414
415
416
                 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
417
                 struct gravity_props *gravity, const struct stars_props *stars,
418
                 struct pm_mesh *mesh,
Matthieu Schaller's avatar
Matthieu Schaller committed
419
420
421
422
                 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
423
424
425
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);
Loikki's avatar
Loikki committed
426
void engine_dump_index(struct engine *e);
427
void engine_launch(struct engine *e);
428
void engine_prepare(struct engine *e);
429
430
void engine_init_particles(struct engine *e, int flag_entropy_ICs,
                           int clean_h_values);
431
432
void engine_step(struct engine *e);
void engine_maketasks(struct engine *e);
433
void engine_split(struct engine *e, struct partition *initial_partition);
434
435
436
437
438
void engine_exchange_strays(struct engine *e, const size_t offset_parts,
                            const int *ind_part, size_t *Npart,
                            const size_t offset_gparts, const int *ind_gpart,
                            size_t *Ngpart, const size_t offset_sparts,
                            const int *ind_spart, size_t *Nspart);
439
void engine_rebuild(struct engine *e, int redistributed, int clean_h_values);
440
void engine_repartition(struct engine *e);
441
void engine_repartition_trigger(struct engine *e);
442
443
void engine_makeproxies(struct engine *e);
void engine_redistribute(struct engine *e);
Matthieu Schaller's avatar
Matthieu Schaller committed
444
void engine_print_policy(struct engine *e);
445
int engine_is_done(struct engine *e);
446
447
void engine_pin(void);
void engine_unpin(void);
448
void engine_clean(struct engine *e);
449
int engine_estimate_nr_tasks(struct engine *e);
450

451
#ifdef HAVE_SETAFFINITY
452
cpu_set_t *engine_entry_affinity(void);
453
454
#endif

455
456
457
/* Struct dump/restore support. */
void engine_struct_dump(struct engine *e, FILE *stream);
void engine_struct_restore(struct engine *e, FILE *stream);
458
void engine_dump_restarts(struct engine *e, int drifted_all, int final_step);
459

460
#endif /* SWIFT_ENGINE_H */