velociraptor_interface.c 17.5 KB
Newer Older
1
2
/*******************************************************************************
 * This file is part of SWIFT.
3
 * Copyright (c) 2018 James Willis (james.s.willis@durham.ac.uk)
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 *
 * 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.
 *
 * 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.
 *
 * 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/>.
 *
 ******************************************************************************/

/* Config parameters. */
#include "../config.h"

23
/* Some standard headers. */
24
25
#include <unistd.h>

26
27
28
/* This object's header. */
#include "velociraptor_interface.h"

29
/* Local includes. */
30
#include "cooling.h"
31
#include "engine.h"
James Willis's avatar
James Willis committed
32
#include "hydro.h"
33
34
35
36
#include "swift_velociraptor_part.h"

#ifdef HAVE_VELOCIRAPTOR

37
38
39
/**
 * @brief Structure for passing cosmological information to VELOCIraptor.
 */
40
41
42
43
44
45
46
47
48
49
50
struct cosmoinfo {

  /*! Current expansion factor of the Universe. (cosmology.a) */
  double atime;

  /*! Reduced Hubble constant (H0 / (100km/s/Mpc) (cosmology.h) */
  double littleh;

  /*! Matter density parameter (cosmology.Omega_m) */
  double Omega_m;

51
52
53
54
55
56
57
58
59
  /*! Radiation density parameter (cosmology.Omega_r) */
  double Omega_r;

  /*! Neutrino density parameter (0 in SWIFT) */
  double Omega_nu;

  /*! Neutrino density parameter (cosmology.Omega_k) */
  double Omega_k;

60
61
62
63
64
65
66
67
68
69
70
71
72
  /*! Baryon density parameter (cosmology.Omega_b) */
  double Omega_b;

  /*! Radiation constant density parameter (cosmology.Omega_lambda) */
  double Omega_Lambda;

  /*! Dark matter density parameter (cosmology.Omega_m - cosmology.Omega_b) */
  double Omega_cdm;

  /*! Dark-energy equation of state at the current time (cosmology.w)*/
  double w_de;
};

73
74
75
/**
 * @brief Structure for passing unit information to VELOCIraptor.
 */
76
77
struct unitinfo {

78
  /*! Length conversion factor to kpc. */
79
80
  double lengthtokpc;

81
  /*! Velocity conversion factor to km/s. */
82
83
  double velocitytokms;

84
  /*! Mass conversion factor to solar masses. */
85
86
  double masstosolarmass;

87
  /*! Potential conversion factor to (km/s)^2. */
88
89
90
91
92
93
94
95
96
  double energyperunitmass;

  /*! Newton's gravitationl constant (phys_const.const_newton_G)*/
  double gravity;

  /*! Hubble constant at the current redshift (cosmology.H) */
  double hubbleunit;
};

97
98
99
/**
 * @brief Structure to hold the location of a top-level cell.
 */
100
101
struct cell_loc {

102
  /*! Coordinates x,y,z */
103
104
105
  double loc[3];
};

106
107
108
109
/**
 * @brief Structure for passing simulation information to VELOCIraptor for a
 * given call.
 */
110
111
struct siminfo {

112
113
114
115
116
117
118
119
120
121
122
123
124
  /*! Size of periodic replications */
  double period;

  /*! Mass of the high-resolution DM particles in a zoom-in run. */
  double zoomhigresolutionmass;

  /*! Mean inter-particle separation of the DM particles */
  double interparticlespacing;

  /*! Spacial extent of the simulation volume */
  double spacedimension[3];

  /*! Number of top-level cells. */
125
126
127
128
129
130
131
132
133
134
135
  int numcells;

  /*! Locations of top-level cells. */
  struct cell_loc *cell_loc;

  /*! Top-level cell width. */
  double cellwidth[3];

  /*! Inverse of the top-level cell width. */
  double icellwidth[3];

136
137
138
  /*! Holds the node ID of each top-level cell. */
  int *cellnodeids;

139
  /*! Is this a cosmological simulation? */
140
  int icosmologicalsim;
141
142

  /*! Is this a zoom-in simulation? */
143
  int izoomsim;
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

  /*! Do we have DM particles? */
  int idarkmatter;

  /*! Do we have gas particles? */
  int igas;

  /*! Do we have star particles? */
  int istar;

  /*! Do we have BH particles? */
  int ibh;

  /*! Do we have other particles? */
  int iother;
159
160
};

161
162
163
/**
 * @brief Structure for group information back to swift
 */
164
struct groupinfo {
165
166

  /*! Index of a #gpart in the global array on this MPI rank */
167
  int index;
168
169

  /*! Group number of the #gpart. */
170
171
172
  long long groupid;
};

pelahi's avatar
pelahi committed
173
174
175
int InitVelociraptor(char *config_name, struct unitinfo unit_info,
                     struct siminfo sim_info, const int numthreads);

176
struct groupinfo *InvokeVelociraptor(
177
178
    const int snapnum, char *output_name, struct cosmoinfo cosmo_info,
    struct siminfo sim_info, const size_t num_gravity_parts,
179
180
181
182
    const size_t num_hydro_parts, const size_t num_star_parts,
    struct swift_vel_part *swift_parts, const int *cell_node_ids,
    const int numthreads, const int return_group_flags,
    int *const num_in_groups);
183
184

#endif /* HAVE_VELOCIRAPTOR */
185

186
/**
187
188
 * @brief Initialise VELOCIraptor with configuration, units,
 * simulation info needed to run.
189
190
191
 *
 * @param e The #engine.
 */
192
void velociraptor_init(struct engine *e) {
193

194
#ifdef HAVE_VELOCIRAPTOR
195
196
  const ticks tic = getticks();

197
  /* Internal SWIFT units */
198
199
  const struct unit_system *swift_us = e->internal_units;

200
  /* CGS units and physical constants in CGS */
201
202
203
204
205
  struct unit_system cgs_us;
  units_init_cgs(&cgs_us);
  struct phys_const cgs_pc;
  phys_const_init(&cgs_us, /*params=*/NULL, &cgs_pc);

Matthieu Schaller's avatar
Matthieu Schaller committed
206
  /* Set unit conversions. */
207
  struct unitinfo unit_info;
208
209
210
211
212
213
214
215
216
217
218
  unit_info.lengthtokpc =
      units_cgs_conversion_factor(swift_us, UNIT_CONV_LENGTH) /
      (1000. * cgs_pc.const_parsec);
  unit_info.velocitytokms =
      units_cgs_conversion_factor(swift_us, UNIT_CONV_VELOCITY) / 1.0e5;
  unit_info.masstosolarmass =
      units_cgs_conversion_factor(swift_us, UNIT_CONV_MASS) /
      cgs_pc.const_solar_mass;
  unit_info.energyperunitmass =
      units_cgs_conversion_factor(swift_us, UNIT_CONV_ENERGY_PER_UNIT_MASS) /
      (1.0e10);
Matthieu Schaller's avatar
Matthieu Schaller committed
219
  unit_info.gravity = e->physical_constants->const_newton_G;
James Willis's avatar
James Willis committed
220
  unit_info.hubbleunit = e->cosmology->H0 / e->cosmology->h;
Matthieu Schaller's avatar
Matthieu Schaller committed
221

222
223
  /* Gather some information about the simulation */
  struct siminfo sim_info;
Matthieu Schaller's avatar
Matthieu Schaller committed
224

225
226
  /* Are we running with cosmology? */
  if (e->policy & engine_policy_cosmology) {
Matthieu Schaller's avatar
Matthieu Schaller committed
227
    sim_info.icosmologicalsim = 1;
228
  } else {
Matthieu Schaller's avatar
Matthieu Schaller committed
229
    sim_info.icosmologicalsim = 0;
230
  }
231
  sim_info.izoomsim = 0;
232
233
234
235
236

  /* Tell VELOCIraptor what we have in the simulation */
  sim_info.idarkmatter = (e->total_nr_gparts - e->total_nr_parts > 0);
  sim_info.igas = (e->policy & engine_policy_hydro);
  sim_info.istar = (e->policy & engine_policy_stars);
237
  sim_info.ibh = 0;  // sim_info.ibh = (e->policy&engine_policy_bh);
238
  sim_info.iother = 0;
239
240
241
242
243
244
245
246
247

  /* Be nice, talk! */
  if (e->verbose) {
    message("VELOCIraptor conf: Length conversion factor: %e",
            unit_info.lengthtokpc);
    message("VELOCIraptor conf: Velocity conversion factor: %e",
            unit_info.velocitytokms);
    message("VELOCIraptor conf: Mass conversion factor: %e",
            unit_info.masstosolarmass);
248
    message("VELOCIraptor conf: Internal energy conversion factor: %e",
249
250
251
252
253
254
255
            unit_info.energyperunitmass);
    message("VELOCIraptor conf: G: %e", unit_info.gravity);
    message("VELOCIraptor conf: H0/h: %e", unit_info.hubbleunit);
    message("VELOCIraptor conf: Config file name: %s", e->stf_config_file_name);
    message("VELOCIraptor conf: Cosmological Simulation: %d",
            sim_info.icosmologicalsim);
  }
Matthieu Schaller's avatar
Matthieu Schaller committed
256
257

  /* Initialise VELOCIraptor. */
258
259
  if (InitVelociraptor(e->stf_config_file_name, unit_info, sim_info,
                       e->nr_threads) != 1)
260
    error("VELOCIraptor initialisation failed.");
261
262
263
264

  if (e->verbose)
    message("took %.3f %s.", clocks_from_ticks(getticks() - tic),
            clocks_getunit());
265
266
#else
  error("SWIFT not configure to run with VELOCIraptor.");
267
#endif /* HAVE_VELOCIRAPTOR */
268
269
270
271
272
273
}

/**
 * @brief Run VELOCIraptor with current particle data.
 *
 * @param e The #engine.
274
 * @param linked_with_snap Are we running at the same time as a snapshot dump?
275
 */
276
void velociraptor_invoke(struct engine *e, const int linked_with_snap) {
277

278
#ifdef HAVE_VELOCIRAPTOR
279

280
281
282
283
284
285
286
  const struct cosmology *cosmo = e->cosmology;
  const struct hydro_props *hydro_props = e->hydro_properties;
  const struct unit_system *us = e->internal_units;
  const struct phys_const *phys_const = e->physical_constants;
  const struct cooling_function_data *cool_func = e->cooling_func;

  /* Handle on the particles */
287
288
  const struct space *s = e->s;
  const struct part *parts = s->parts;
289
290
  const struct xpart *xparts = s->xparts;
  const struct gpart *gparts = s->gparts;
291
  const struct spart *sparts = s->sparts;
Matthieu Schaller's avatar
Matthieu Schaller committed
292
  const size_t nr_gparts = s->nr_gparts;
293
294
  const size_t nr_parts = s->nr_parts;
  const size_t nr_sparts = s->nr_sparts;
Matthieu Schaller's avatar
Matthieu Schaller committed
295
  const int nr_cells = s->nr_cells;
296
297

  const ticks tic = getticks();
298

Matthieu Schaller's avatar
Matthieu Schaller committed
299
  /* Allow thread to run on any core for the duration of the call to
300
301
   * VELOCIraptor so that  when OpenMP threads are spawned
   * they can run on any core on the processor. */
Matthieu Schaller's avatar
Matthieu Schaller committed
302
303
304
305
  const int nr_cores = sysconf(_SC_NPROCESSORS_ONLN);
  pthread_t thread = pthread_self();

  /* Set affinity mask to include all cores on the CPU for VELOCIraptor. */
306
  cpu_set_t cpuset;
Matthieu Schaller's avatar
Matthieu Schaller committed
307
308
309
310
  CPU_ZERO(&cpuset);
  for (int j = 0; j < nr_cores; j++) CPU_SET(j, &cpuset);
  pthread_setaffinity_np(thread, sizeof(cpu_set_t), &cpuset);

311
312
  /* Set cosmology information for this point in time */
  struct cosmoinfo cosmo_info;
313
314
315
316
  cosmo_info.atime = e->cosmology->a;
  cosmo_info.littleh = e->cosmology->h;
  cosmo_info.Omega_m = e->cosmology->Omega_m;
  cosmo_info.Omega_b = e->cosmology->Omega_b;
317
318
319
  cosmo_info.Omega_r = e->cosmology->Omega_r;
  cosmo_info.Omega_k = e->cosmology->Omega_k;
  cosmo_info.Omega_nu = 0.;
320
321
322
323
  cosmo_info.Omega_Lambda = e->cosmology->Omega_lambda;
  cosmo_info.Omega_cdm = e->cosmology->Omega_m - e->cosmology->Omega_b;
  cosmo_info.w_de = e->cosmology->w;

324
325
326
327
328
329
330
331
332
333
334
335
336
  /* Report the cosmo info we use */
  if (e->verbose) {
    message("VELOCIraptor conf: Scale factor: %e", cosmo_info.atime);
    message("VELOCIraptor conf: Little h: %e", cosmo_info.littleh);
    message("VELOCIraptor conf: Omega_m: %e", cosmo_info.Omega_m);
    message("VELOCIraptor conf: Omega_b: %e", cosmo_info.Omega_b);
    message("VELOCIraptor conf: Omega_Lambda: %e", cosmo_info.Omega_Lambda);
    message("VELOCIraptor conf: Omega_cdm: %e", cosmo_info.Omega_cdm);
    message("VELOCIraptor conf: w_de: %e", cosmo_info.w_de);
  }

  /* Update the simulation information */
  struct siminfo sim_info;
337

338
  /* Period of the box (Note we assume a cubic box!) */
339
  if (e->s->periodic) {
340
    sim_info.period = s->dim[0];
341
  } else {
342
343
    sim_info.period = 0.0;
  }
344
345

  /* Tell VELOCIraptor this is not a zoom-in simulation */
346
347
  sim_info.zoomhigresolutionmass = -1.0;

348
  /* Are we running with cosmology? */
349
350
  if (e->policy & engine_policy_cosmology) {
    sim_info.icosmologicalsim = 1;
351
    sim_info.izoomsim = 0;
352
353
    const size_t total_nr_baryons = e->total_nr_parts + e->total_nr_sparts;
    const size_t total_nr_dmparts = e->total_nr_gparts - total_nr_baryons;
354
355
    sim_info.interparticlespacing = sim_info.period / cbrt(total_nr_dmparts);
  } else {
356
    sim_info.icosmologicalsim = 0;
357
    sim_info.izoomsim = 0;
358
359
360
    sim_info.interparticlespacing = -1;
  }

361
  /* Set the spatial extent of the simulation volume */
362
363
364
  sim_info.spacedimension[0] = s->dim[0];
  sim_info.spacedimension[1] = s->dim[1];
  sim_info.spacedimension[2] = s->dim[2];
365

366
  /* Store number of top-level cells */
367
  sim_info.numcells = s->nr_cells;
368
369

  /* Size and inverse size of the top-level cells in VELOCIraptor units */
370
371
372
373
374
375
  sim_info.cellwidth[0] = s->cells_top[0].width[0];
  sim_info.cellwidth[1] = s->cells_top[0].width[1];
  sim_info.cellwidth[2] = s->cells_top[0].width[2];
  sim_info.icellwidth[0] = s->iwidth[0];
  sim_info.icellwidth[1] = s->iwidth[1];
  sim_info.icellwidth[2] = s->iwidth[2];
376
377
378
379
380
381

  /* Copy the poisiton of the top-level cells */
  if (posix_memalign((void **)&sim_info.cell_loc, 32,
                     s->nr_cells * sizeof(struct cell_loc)) != 0)
    error("Failed to allocate top-level cell locations for VELOCIraptor.");
  for (int i = 0; i < s->nr_cells; i++) {
382
383
384
    sim_info.cell_loc[i].loc[0] = s->cells_top[i].loc[0];
    sim_info.cell_loc[i].loc[1] = s->cells_top[i].loc[1];
    sim_info.cell_loc[i].loc[2] = s->cells_top[i].loc[2];
385
  }
386

387
388
389
390
391
392
393
394
395
396
397
398
399
  if (e->verbose) {
    message("VELOCIraptor conf: Space dimensions: (%e,%e,%e)",
            sim_info.spacedimension[0], sim_info.spacedimension[1],
            sim_info.spacedimension[2]);
    message("VELOCIraptor conf: No. of top-level cells: %d", sim_info.numcells);
    message(
        "VELOCIraptor conf: Top-level cell locations range: (%e,%e,%e) -> "
        "(%e,%e,%e)",
        sim_info.cell_loc[0].loc[0], sim_info.cell_loc[0].loc[1],
        sim_info.cell_loc[0].loc[2],
        sim_info.cell_loc[sim_info.numcells - 1].loc[0],
        sim_info.cell_loc[sim_info.numcells - 1].loc[1],
        sim_info.cell_loc[sim_info.numcells - 1].loc[2]);
400
401
  }

402
  /* Allocate and populate array of cell node IDs. */
403
  int *cell_node_ids = NULL;
Matthieu Schaller's avatar
Matthieu Schaller committed
404
405
406
407
  if (posix_memalign((void **)&cell_node_ids, 32, nr_cells * sizeof(int)) != 0)
    error("Failed to allocate list of cells node IDs for VELOCIraptor.");
  for (int i = 0; i < nr_cells; i++) cell_node_ids[i] = s->cells_top[i].nodeID;

408
  /* Mention the number of particles being sent */
409
  if (e->verbose)
410
411
412
    message(
        "VELOCIraptor conf: MPI rank %d sending %zu gparts to VELOCIraptor.",
        engine_rank, nr_gparts);
Matthieu Schaller's avatar
Matthieu Schaller committed
413

414
  /* Append base name with the current output number */
Matthieu Schaller's avatar
Matthieu Schaller committed
415
  char outputFileName[PARSER_MAX_LINE_SIZE + 128];
416

417
418
419
420
421
422
423
424
  /* What should the filename be? */
  if (linked_with_snap) {
    snprintf(outputFileName, PARSER_MAX_LINE_SIZE + 128,
             "stf_%s_%04i.VELOCIraptor", e->snapshot_base_name,
             e->snapshot_output_count);
  } else {
    snprintf(outputFileName, PARSER_MAX_LINE_SIZE + 128, "%s_%04i.VELOCIraptor",
             e->stf_base_name, e->stf_output_count);
425
426
427
428
429
430
431
  }

  /* What is the snapshot number? */
  int snapnum;
  if (linked_with_snap) {
    snapnum = e->snapshot_output_count;
  } else {
432
    snapnum = e->stf_output_count;
433
  }
Matthieu Schaller's avatar
Matthieu Schaller committed
434
435
436
437
438
439
440
441

  /* Allocate and populate an array of swift_vel_parts to be passed to
   * VELOCIraptor. */
  struct swift_vel_part *swift_parts = NULL;
  if (posix_memalign((void **)&swift_parts, part_align,
                     nr_gparts * sizeof(struct swift_vel_part)) != 0)
    error("Failed to allocate array of particles for VELOCIraptor.");

442
  const float a_inv = e->cosmology->a_inv;
Matthieu Schaller's avatar
Matthieu Schaller committed
443

444
445
446
447
448
449
450
451
  /* Convert particle properties into VELOCIraptor units.
   * VELOCIraptor wants:
   * - Co-moving positions,
   * - Peculiar velocities,
   * - Co-moving potential,
   * - Physical internal energy (for the gas),
   * - Temperatures (for the gas).
   */
Matthieu Schaller's avatar
Matthieu Schaller committed
452
  for (size_t i = 0; i < nr_gparts; i++) {
453

Matthieu Schaller's avatar
Matthieu Schaller committed
454
455
456
    swift_parts[i].x[0] = gparts[i].x[0];
    swift_parts[i].x[1] = gparts[i].x[1];
    swift_parts[i].x[2] = gparts[i].x[2];
457
458
459
460
461

    swift_parts[i].v[0] = gparts[i].v_full[0] * a_inv;
    swift_parts[i].v[1] = gparts[i].v_full[1] * a_inv;
    swift_parts[i].v[2] = gparts[i].v_full[2] * a_inv;

Matthieu Schaller's avatar
Matthieu Schaller committed
462
    swift_parts[i].mass = gravity_get_mass(&gparts[i]);
James Willis's avatar
James Willis committed
463
    swift_parts[i].potential = gravity_get_comoving_potential(&gparts[i]);
464

Matthieu Schaller's avatar
Matthieu Schaller committed
465
466
    swift_parts[i].type = gparts[i].type;

467
468
    swift_parts[i].index = i;
#ifdef WITH_MPI
469
    swift_parts[i].task = e->nodeID;
470
471
472
473
#else
    swift_parts[i].task = 0;
#endif

Matthieu Schaller's avatar
Matthieu Schaller committed
474
475
    /* Set gas particle IDs from their hydro counterparts and set internal
     * energies. */
476
477
    switch (gparts[i].type) {

478
479
480
      case swift_type_gas: {
        const struct part *p = &parts[-gparts[i].id_or_neg_offset];
        const struct xpart *xp = &xparts[-gparts[i].id_or_neg_offset];
481
482

        swift_parts[i].id = parts[-gparts[i].id_or_neg_offset].id;
483
484
485
486
        swift_parts[i].u = hydro_get_drifted_physical_internal_energy(p, cosmo);
        swift_parts[i].T = cooling_get_temperature(phys_const, hydro_props, us,
                                                   cosmo, cool_func, p, xp);
      } break;
487

488
489
490
491
      case swift_type_stars:

        swift_parts[i].id = sparts[-gparts[i].id_or_neg_offset].id;
        swift_parts[i].u = 0.f;
492
        swift_parts[i].T = 0.f;
493
494
        break;

495
496
497
498
      case swift_type_dark_matter:

        swift_parts[i].id = gparts[i].id_or_neg_offset;
        swift_parts[i].u = 0.f;
499
        swift_parts[i].T = 0.f;
500
501
502
503
        break;

      default:
        error("Particle type not handled by VELOCIraptor.");
504
    }
Matthieu Schaller's avatar
Matthieu Schaller committed
505
  }
506

507
508
509
510
  /* Values returned by VELOCIRaptor */
  int num_gparts_in_groups = -1;
  struct groupinfo *group_info = NULL;

Matthieu Schaller's avatar
Matthieu Schaller committed
511
  /* Call VELOCIraptor. */
512
  group_info = (struct groupinfo *)InvokeVelociraptor(
513
514
      snapnum, outputFileName, cosmo_info, sim_info, nr_gparts, nr_parts,
      nr_sparts, swift_parts, cell_node_ids, e->nr_threads, linked_with_snap,
515
      &num_gparts_in_groups);
516
517

  /* Check that the ouput is valid */
518
  if (linked_with_snap && group_info == NULL && num_gparts_in_groups < 0) {
Matthieu Schaller's avatar
Matthieu Schaller committed
519
    error("Exiting. Call to VELOCIraptor failed on rank: %d.", e->nodeID);
520
  }
521
522
523
  if (!linked_with_snap && group_info != NULL) {
    error("VELOCIraptor returned an array whilst it should not have.");
  }
Matthieu Schaller's avatar
Matthieu Schaller committed
524

525
  /* Assign the group IDs back to the gparts */
526
  if (linked_with_snap) {
527

528
529
530
531
532
533
534
535
    for (int i = 0; i < num_gparts_in_groups; i++) {
      ///\todo need to update particle structure to include a group id
      // gparts[group_info[i].index].groupid=group_info[i].index;
    }

    /* Free the array returned by VELOCIraptor */
    free(group_info);
  }
Matthieu Schaller's avatar
Matthieu Schaller committed
536

537
538
539
  /* Reset the pthread affinity mask after VELOCIraptor returns. */
  pthread_setaffinity_np(thread, sizeof(cpu_set_t), engine_entry_affinity());

540
  /* Increase output counter (if not linked with snapshots) */
541
  if (!linked_with_snap) e->stf_output_count++;
542

543
544
545
  if (e->verbose)
    message("took %.3f %s.", clocks_from_ticks(getticks() - tic),
            clocks_getunit());
546
#else
Matthieu Schaller's avatar
Matthieu Schaller committed
547
  error("SWIFT not configure to run with VELOCIraptor.");
548
#endif /* HAVE_VELOCIRAPTOR */
549
}