common_io.c 16.2 KB
Newer Older
1
2
/*******************************************************************************
 * This file is part of SWIFT.
3
 * Copyright (c) 2012 Pedro Gonnet (pedro.gonnet@durham.ac.uk),
4
 *                    Matthieu Schaller (matthieu.schaller@durham.ac.uk).
5
 *
6
7
8
9
 * 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.
10
 *
11
12
13
14
 * 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.
15
 *
16
17
 * 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/>.
18
 *
19
20
21
22
23
24
25
26
 ******************************************************************************/

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

#if defined(HAVE_HDF5)

/* Some standard headers. */
27
28
29
#include <hdf5.h>
#include <math.h>
#include <stddef.h>
30
31
32
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
33
34

/* MPI headers. */
35
36
37
#ifdef WITH_MPI
#include <mpi.h>
#endif
38

39
40
41
42
/* This object's header. */
#include "common_io.h"

/* Local includes. */
43
44
45
#include "const.h"
#include "error.h"
#include "kernel.h"
46
#include "version.h"
47
48

/**
49
 * @brief Converts a C data type to the HDF5 equivalent.
50
51
 *
 * This function is a trivial wrapper around the HDF5 types but allows
52
53
 * to change the exact storage types matching the code types in a transparent
 *way.
54
 */
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
hid_t hdf5Type(enum DATA_TYPE type) {
  switch (type) {
    case INT:
      return H5T_NATIVE_INT;
    case UINT:
      return H5T_NATIVE_UINT;
    case LONG:
      return H5T_NATIVE_LONG;
    case ULONG:
      return H5T_NATIVE_ULONG;
    case LONGLONG:
      return H5T_NATIVE_LLONG;
    case ULONGLONG:
      return H5T_NATIVE_ULLONG;
    case FLOAT:
      return H5T_NATIVE_FLOAT;
    case DOUBLE:
      return H5T_NATIVE_DOUBLE;
    case CHAR:
      return H5T_C_S1;
    default:
      error("Unknown type");
      return 0;
  }
79
80
81
82
83
}

/**
 * @brief Returns the memory size of the data type
 */
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
size_t sizeOfType(enum DATA_TYPE type) {
  switch (type) {
    case INT:
      return sizeof(int);
    case UINT:
      return sizeof(unsigned int);
    case LONG:
      return sizeof(long);
    case ULONG:
      return sizeof(unsigned long);
    case LONGLONG:
      return sizeof(long long);
    case ULONGLONG:
      return sizeof(unsigned long long);
    case FLOAT:
      return sizeof(float);
    case DOUBLE:
      return sizeof(double);
    case CHAR:
      return sizeof(char);
    default:
      error("Unknown type");
      return 0;
  }
108
109
110
111
112
113
114
115
116
117
118
119
}

/**
 * @brief Reads an attribute from a given HDF5 group.
 *
 * @param grp The group from which to read.
 * @param name The name of the attribute to read.
 * @param type The #DATA_TYPE of the attribute.
 * @param data (output) The attribute read from the HDF5 group.
 *
 * Calls #error() if an error occurs.
 */
120
121
void readAttribute(hid_t grp, char* name, enum DATA_TYPE type, void* data) {
  hid_t h_attr = 0, h_err = 0;
122
123

  h_attr = H5Aopen(grp, name, H5P_DEFAULT);
124
125
126
  if (h_attr < 0) {
    error("Error while opening attribute '%s'", name);
  }
127
128

  h_err = H5Aread(h_attr, hdf5Type(type), data);
129
130
131
  if (h_err < 0) {
    error("Error while reading attribute '%s'", name);
  }
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

  H5Aclose(h_attr);
}

/**
 * @brief Write an attribute to a given HDF5 group.
 *
 * @param grp The group in which to write.
 * @param name The name of the attribute to write.
 * @param type The #DATA_TYPE of the attribute.
 * @param data The attribute to write.
 * @param num The number of elements to write
 *
 * Calls #error() if an error occurs.
 */
147
148
149
150
void writeAttribute(hid_t grp, char* name, enum DATA_TYPE type, void* data,
                    int num) {
  hid_t h_space = 0, h_attr = 0, h_err = 0;
  hsize_t dim[1] = {num};
151
152

  h_space = H5Screate(H5S_SIMPLE);
153
154
155
  if (h_space < 0) {
    error("Error while creating dataspace for attribute '%s'.", name);
  }
156
157

  h_err = H5Sset_extent_simple(h_space, 1, dim, NULL);
158
159
160
  if (h_err < 0) {
    error("Error while changing dataspace shape for attribute '%s'.", name);
  }
161
162

  h_attr = H5Acreate1(grp, name, hdf5Type(type), h_space, H5P_DEFAULT);
163
164
165
  if (h_attr < 0) {
    error("Error while creating attribute '%s'.", name);
  }
166
167

  h_err = H5Awrite(h_attr, hdf5Type(type), data);
168
169
170
  if (h_err < 0) {
    error("Error while reading attribute '%s'.", name);
  }
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

  H5Sclose(h_space);
  H5Aclose(h_attr);
}

/**
 * @brief Write a string as an attribute to a given HDF5 group.
 *
 * @param grp The group in which to write.
 * @param name The name of the attribute to write.
 * @param str The string to write.
 * @param length The length of the string
 *
 * Calls #error() if an error occurs.
 */
186
void writeStringAttribute(hid_t grp, char* name, const char* str, int length) {
187
  hid_t h_space = 0, h_attr = 0, h_err = 0, h_type = 0;
188
189

  h_space = H5Screate(H5S_SCALAR);
190
191
192
  if (h_space < 0) {
    error("Error while creating dataspace for attribute '%s'.", name);
  }
193
194

  h_type = H5Tcopy(H5T_C_S1);
195
196
197
  if (h_type < 0) {
    error("Error while copying datatype 'H5T_C_S1'.");
  }
198
199

  h_err = H5Tset_size(h_type, length);
200
  if (h_err < 0) {
Matthieu Schaller's avatar
Matthieu Schaller committed
201
    error("Error while resizing attribute type to '%i'.", length);
202
  }
203
204

  h_attr = H5Acreate1(grp, name, h_type, h_space, H5P_DEFAULT);
205
206
207
  if (h_attr < 0) {
    error("Error while creating attribute '%s'.", name);
  }
208

209
210
211
212
  h_err = H5Awrite(h_attr, h_type, str);
  if (h_err < 0) {
    error("Error while reading attribute '%s'.", name);
  }
213
214
215
216
217
218
219
220

  H5Tclose(h_type);
  H5Sclose(h_space);
  H5Aclose(h_attr);
}

/**
 * @brief Writes a double value as an attribute
221
 * @param grp The group in which to write
222
223
224
 * @param name The name of the attribute
 * @param data The value to write
 */
225
void writeAttribute_d(hid_t grp, char* name, double data) {
226
227
228
229
230
  writeAttribute(grp, name, DOUBLE, &data, 1);
}

/**
 * @brief Writes a float value as an attribute
231
 * @param grp The group in which to write
232
233
234
 * @param name The name of the attribute
 * @param data The value to write
 */
235
void writeAttribute_f(hid_t grp, char* name, float data) {
236
237
238
239
240
  writeAttribute(grp, name, FLOAT, &data, 1);
}

/**
 * @brief Writes an int value as an attribute
241
 * @param grp The group in which to write
242
243
244
245
 * @param name The name of the attribute
 * @param data The value to write
 */

246
void writeAttribute_i(hid_t grp, char* name, int data) {
247
248
249
250
251
  writeAttribute(grp, name, INT, &data, 1);
}

/**
 * @brief Writes a long value as an attribute
252
 * @param grp The group in which to write
253
254
255
 * @param name The name of the attribute
 * @param data The value to write
 */
256
void writeAttribute_l(hid_t grp, char* name, long data) {
257
258
259
260
261
  writeAttribute(grp, name, LONG, &data, 1);
}

/**
 * @brief Writes a string value as an attribute
262
 * @param grp The group in which to write
263
264
265
 * @param name The name of the attribute
 * @param str The string to write
 */
266
void writeAttribute_s(hid_t grp, char* name, const char* str) {
267
268
269
270
271
272
  writeStringAttribute(grp, name, str, strlen(str));
}

/**
 * @brief Writes the current Unit System
 * @param h_file The (opened) HDF5 file in which to write
273
 * @param us The UnitSystem used in the run
274
 */
275
276
void writeUnitSystem(hid_t h_file, struct UnitSystem* us) {
  hid_t h_grpunit = 0;
277
278

  h_grpunit = H5Gcreate1(h_file, "/Units", 0);
279
280
281
282
283
284
285
286
287
288
289
290
  if (h_grpunit < 0) error("Error while creating Unit System group");

  writeAttribute_d(h_grpunit, "Unit mass in cgs (U_M)",
                   getBaseUnit(us, UNIT_MASS));
  writeAttribute_d(h_grpunit, "Unit length in cgs (U_L)",
                   getBaseUnit(us, UNIT_LENGTH));
  writeAttribute_d(h_grpunit, "Unit time in cgs (U_t)",
                   getBaseUnit(us, UNIT_TIME));
  writeAttribute_d(h_grpunit, "Unit current in cgs (U_I)",
                   getBaseUnit(us, UNIT_CURRENT));
  writeAttribute_d(h_grpunit, "Unit temperature in cgs (U_T)",
                   getBaseUnit(us, UNIT_TEMPERATURE));
291
292
293
294

  H5Gclose(h_grpunit);
}

295
296
297
298
299
300
301
302
303
304
305
/**
 * @brief Writes the code version to the file
 * @param h_file The (opened) HDF5 file in which to write
 */
void writeCodeDescription(hid_t h_file) {
  hid_t h_grpcode = 0;

  h_grpcode = H5Gcreate1(h_file, "/Code", 0);
  if (h_grpcode < 0) error("Error while creating code group");

  writeAttribute_s(h_grpcode, "Code Version", package_version());
306
307
  writeAttribute_s(h_grpcode, "Compiler Name", compiler_name());
  writeAttribute_s(h_grpcode, "Compiler Version", compiler_version());
308
309
  writeAttribute_s(h_grpcode, "Git Branch", git_branch());
  writeAttribute_s(h_grpcode, "Git Revision", git_revision());
310
311
312
313
  writeAttribute_s(h_grpcode, "HDF5 library version", hdf5_version());
#ifdef WITH_MPI
  writeAttribute_s(h_grpcode, "MPI library", mpi_version());
#ifdef HAVE_METIS
314
315
  writeAttribute_s(h_grpcode, "METIS library version", metis_version());
#endif
316
317
318
#else
  writeAttribute_s(h_grpcode, "MPI library", "Non-MPI version of SWIFT");
#endif
319
320
321
  H5Gclose(h_grpcode);
}

322
323
324
325
326
327
/* ------------------------------------------------------------------------------------------------
 * This part writes the XMF file descriptor enabling a visualisation through
 * ParaView
 * ------------------------------------------------------------------------------------------------
 */

328
329
330
331
332
333
334
/**
 * @brief Prepares the XMF file for the new entry
 *
 * Creates a temporary file on the disk in order to copy the right lines.
 *
 * @todo Use a proper XML library to avoid stupid copies.
 */
335
FILE* prepareXMFfile() {
336
337
338
339
340
  char buffer[1024];

  FILE* xmfFile = fopen("output.xmf", "r");
  FILE* tempFile = fopen("output_temp.xmf", "w");

341
  if (xmfFile == NULL) error("Unable to open current XMF file.");
342

343
  if (tempFile == NULL) error("Unable to open temporary file.");
344
345
346

  /* First we make a temporary copy of the XMF file and count the lines */
  int counter = 0;
347
348
349
350
  while (fgets(buffer, 1024, xmfFile) != NULL) {
    counter++;
    fprintf(tempFile, "%s", buffer);
  }
351
352
  fclose(tempFile);
  fclose(xmfFile);
353

354
355
356
357
  /* We then copy the XMF file back up to the closing lines */
  xmfFile = fopen("output.xmf", "w");
  tempFile = fopen("output_temp.xmf", "r");

358
  if (xmfFile == NULL) error("Unable to open current XMF file.");
359

360
  if (tempFile == NULL) error("Unable to open temporary file.");
361

362
363
364
  int i = 0;
  while (fgets(buffer, 1024, tempFile) != NULL && i < counter - 3) {
    i++;
365
366
    fprintf(xmfFile, "%s", buffer);
  }
367
368
369
  fprintf(xmfFile, "\n");
  fclose(tempFile);
  remove("output_temp.xmf");
370

371
372
373
374
375
376
  return xmfFile;
}

/**
 * @brief Writes the begin of the XMF file
 *
377
378
 * @todo Exploit the XML nature of the XMF format to write a proper XML writer
 *and simplify all the XMF-related stuff.
379
 */
380
void createXMFfile() {
381
382
383
384
  FILE* xmfFile = fopen("output.xmf", "w");

  fprintf(xmfFile, "<?xml version=\"1.0\" ?> \n");
  fprintf(xmfFile, "<!DOCTYPE Xdmf SYSTEM \"Xdmf.dtd\" []> \n");
385
386
387
  fprintf(
      xmfFile,
      "<Xdmf xmlns:xi=\"http://www.w3.org/2003/XInclude\" Version=\"2.1\">\n");
388
  fprintf(xmfFile, "<Domain>\n");
389
390
391
  fprintf(xmfFile,
          "<Grid Name=\"TimeSeries\" GridType=\"Collection\" "
          "CollectionType=\"Temporal\">\n\n");
392
393
394
395
396
397
398
399
400

  fprintf(xmfFile, "</Grid>\n");
  fprintf(xmfFile, "</Domain>\n");
  fprintf(xmfFile, "</Xdmf>\n");

  fclose(xmfFile);
}

/**
401
402
 * @brief Writes the part of the XMF entry presenting the geometry of the
 *snapshot
403
404
405
406
407
408
 *
 * @param xmfFile The file to write in.
 * @param Nparts The number of particles.
 * @param hdfFileName The name of the HDF5 file corresponding to this output.
 * @param time The current simulation time.
 */
409
410
void writeXMFheader(FILE* xmfFile, long long Nparts, char* hdfFileName,
                    float time) {
411
  /* Write end of file */
412
413
414

  fprintf(xmfFile,
          "<Grid GridType=\"Collection\" CollectionType=\"Spatial\">\n");
415
416
  fprintf(xmfFile, "<Time Type=\"Single\" Value=\"%f\"/>\n", time);
  fprintf(xmfFile, "<Grid Name=\"Gas\" GridType=\"Uniform\">\n");
417
418
419
  fprintf(xmfFile,
          "<Topology TopologyType=\"Polyvertex\" Dimensions=\"%lld\"/>\n",
          Nparts);
420
  fprintf(xmfFile, "<Geometry GeometryType=\"XYZ\">\n");
421
422
423
424
425
  fprintf(xmfFile,
          "<DataItem Dimensions=\"%lld 3\" NumberType=\"Double\" "
          "Precision=\"8\" "
          "Format=\"HDF\">%s:/PartType0/Coordinates</DataItem>\n",
          Nparts, hdfFileName);
426
427
428
429
430
431
432
433
  fprintf(xmfFile, "</Geometry>");
}

/**
 * @brief Writes the end of the XMF file (closes all open markups)
 *
 * @param xmfFile The file to write in.
 */
434
void writeXMFfooter(FILE* xmfFile) {
435
  /* Write end of the section of this time step */
436

437
438
439
440
441
  fprintf(xmfFile, "\n</Grid>\n");
  fprintf(xmfFile, "</Grid>\n");
  fprintf(xmfFile, "\n</Grid>\n");
  fprintf(xmfFile, "</Domain>\n");
  fprintf(xmfFile, "</Xdmf>\n");
442

443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
  fclose(xmfFile);
}

/**
 * @brief Writes the lines corresponding to an array of the HDF5 output
 *
 * @param xmfFile The file in which to write
 * @param fileName The name of the HDF5 file associated to this XMF descriptor.
 * @param name The name of the array in the HDF5 file.
 * @param N The number of particles.
 * @param dim The dimension of the quantity (1 for scalars, 3 for vectors).
 * @param type The type of the data to write.
 *
 * @todo Treat the types in a better way.
 */
458
459
460
461
462
463
464
465
466
467
void writeXMFline(FILE* xmfFile, char* fileName, char* name, long long N,
                  int dim, enum DATA_TYPE type) {
  fprintf(xmfFile,
          "<Attribute Name=\"%s\" AttributeType=\"%s\" Center=\"Node\">\n",
          name, dim == 1 ? "Scalar" : "Vector");
  if (dim == 1)
    fprintf(xmfFile,
            "<DataItem Dimensions=\"%lld\" NumberType=\"Double\" "
            "Precision=\"%d\" Format=\"HDF\">%s:/PartType0/%s</DataItem>\n",
            N, type == FLOAT ? 4 : 8, fileName, name);
468
  else
469
470
471
472
    fprintf(xmfFile,
            "<DataItem Dimensions=\"%lld %d\" NumberType=\"Double\" "
            "Precision=\"%d\" Format=\"HDF\">%s:/PartType0/%s</DataItem>\n",
            N, dim, type == FLOAT ? 4 : 8, fileName, name);
473
474
475
  fprintf(xmfFile, "</Attribute>\n");
}

476
477
478
479
480
481
482
483
484
485
/**
 * @brief Prepare the DM particles (in gparts) read in for the addition of the
 * other particle types
 *
 * This function assumes that the DM particles are all at the start of the
 * gparts array
 *
 * @param gparts The array of #gpart freshly read in.
 * @param Ndm The number of DM particles read in.
 */
486
void prepare_dm_gparts(struct gpart* gparts, size_t Ndm) {
487
488

  /* Let's give all these gparts a negative id */
489
  for (size_t i = 0; i < Ndm; ++i) {
490

Matthieu Schaller's avatar
typo    
Matthieu Schaller committed
491
    /* 0 or negative ids are not allowed */
Matthieu Schaller's avatar
Matthieu Schaller committed
492
493
    if (gparts[i].id <= 0) error("0 or negative ID for DM particle");

494
    gparts[i].id = -gparts[i].id;
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
  }
}

/**
 * @brief Copy every #part into the corresponding #gpart and link them.
 *
 * This function assumes that the DM particles are all at the start of the
 * gparts array and adds the hydro particles afterwards
 *
 * @param parts The array of #part freshly read in.
 * @param gparts The array of #gpart freshly read in with all the DM particles
 *at the start
 * @param Ngas The number of gas particles read in.
 * @param Ndm The number of DM particles read in.
 */
510
511
void duplicate_hydro_gparts(struct part* parts, struct gpart* gparts,
                            size_t Ngas, size_t Ndm) {
512

513
  for (size_t i = 0; i < Ngas; ++i) {
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539

    /* Duplicate the crucial information */
    gparts[i + Ndm].x[0] = parts[i].x[0];
    gparts[i + Ndm].x[1] = parts[i].x[1];
    gparts[i + Ndm].x[2] = parts[i].x[2];

    gparts[i + Ndm].v_full[0] = parts[i].v[0];
    gparts[i + Ndm].v_full[1] = parts[i].v[1];
    gparts[i + Ndm].v_full[2] = parts[i].v[2];

    gparts[i + Ndm].mass = parts[i].mass;

    /* Link the particles */
    gparts[i + Ndm].part = &parts[i];
    parts[i].gpart = &gparts[i + Ndm];
  }
}

/**
 * @brief Copy every DM #gpart into the dmparts array.
 *
 * @param gparts The array of #gpart containing all particles.
 * @param Ntot The number of #gpart.
 * @param dmparts The array of #gpart containg DM particles to be filled.
 * @param Ndm The number of DM particles.
 */
540
541
void collect_dm_gparts(struct gpart* gparts, size_t Ntot, struct gpart* dmparts,
                       size_t Ndm) {
542

543
  size_t count = 0;
544
545

  /* Loop over all gparts */
546
  for (size_t i = 0; i < Ntot; ++i) {
547
548
549
550

    /* And collect the DM ones */
    if (gparts[i].id < 0) {
      memcpy(&dmparts[count], &gparts[i], sizeof(struct gpart));
551
      dmparts[count].id = -dmparts[count].id;
552
553
554
555
556
557
      count++;
    }
  }

  /* Check that everything is fine */
  if (count != Ndm)
558
    error("Collected the wrong number of dm particles (%zd vs. %zd expected)",
559
560
561
          count, Ndm);
}

562
#endif