common_io.h 3.53 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
#ifndef SWIFT_COMMON_IO_H
#define SWIFT_COMMON_IO_H
22
23
24
25
26
27

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

#if defined(HAVE_HDF5)

28
29
30
31
32
/* Forward-declare stuff to avoid cyclic includes. */
struct UnitSystem;
struct part;
struct gpart;

33
34
35
36
37
/**
 * @brief The different types of data used in the GADGET IC files.
 *
 * (This is admittedly a poor substitute to C++ templates...)
 */
38
39
40
41
42
43
44
45
46
47
48
enum DATA_TYPE {
  INT,
  LONG,
  LONGLONG,
  UINT,
  ULONG,
  ULONGLONG,
  FLOAT,
  DOUBLE,
  CHAR
};
49
50

/**
51
52
 * @brief The two sorts of data present in the GADGET IC files: compulsory to
 *start a run or optional.
53
54
 *
 */
55
enum DATA_IMPORTANCE { COMPULSORY = 1, OPTIONAL = 0 };
56

57
58
59
60
61
62
63
/**
 * @brief The different particle types present in a GADGET IC file
 *
 */
enum PARTICLE_TYPE {
  GAS = 0,
  DM = 1,
64
65
  BOUNDARY = 2,
  DUMMY = 3,
66
  STAR = 4,
67
68
  BH = 5,
  NUM_PARTICLE_TYPES
69
70
};

Matthieu Schaller's avatar
Matthieu Schaller committed
71
extern const char* particle_type_names[];
72

73
74
75
#define FILENAME_BUFFER_SIZE 150
#define PARTICLE_GROUP_BUFFER_SIZE 20

76
77
78
hid_t hdf5Type(enum DATA_TYPE type);
size_t sizeOfType(enum DATA_TYPE type);

Matthieu Schaller's avatar
Matthieu Schaller committed
79
80
81
82
83
84
void collect_dm_gparts(const struct gpart* const gparts, size_t Ntot,
                       struct gpart* const dmparts, size_t Ndm);
void prepare_dm_gparts(struct gpart* const gparts, size_t Ndm);
void duplicate_hydro_gparts(struct part* const parts,
                            struct gpart* const gparts, size_t Ngas,
                            size_t Ndm);
85

86
87
void readAttribute(hid_t grp, char* name, enum DATA_TYPE type, void* data);

88
89
90
91
92
93
94
95
void writeAttribute(hid_t grp, const char* name, enum DATA_TYPE type,
                    void* data, int num);

void writeAttribute_d(hid_t grp, const char* name, double data);
void writeAttribute_f(hid_t grp, const char* name, float data);
void writeAttribute_i(hid_t grp, const char* name, int data);
void writeAttribute_l(hid_t grp, const char* name, long data);
void writeAttribute_s(hid_t grp, const char* name, const char* str);
96

97
98
void createXMFfile(const char* baseName);
FILE* prepareXMFfile(const char* baseName);
99
100
101
void writeXMFoutputheader(FILE* xmfFile, char* hdfFileName, float time);
void writeXMFoutputfooter(FILE* xmfFile, int outputCount, float time);
void writeXMFgroupheader(FILE* xmfFile, char* hdfFileName, size_t N,
Matthieu Schaller's avatar
Matthieu Schaller committed
102
                         enum PARTICLE_TYPE ptype);
103
104
void writeXMFgroupfooter(FILE* xmfFile, enum PARTICLE_TYPE ptype);
void writeXMFline(FILE* xmfFile, char* fileName, char* partTypeGroupName,
Matthieu Schaller's avatar
Matthieu Schaller committed
105
                  char* name, size_t N, int dim, enum DATA_TYPE type);
106

107
void writeCodeDescription(hid_t h_file);
108
109
110
void writeUnitSystem(hid_t h_file, struct UnitSystem* us);

#endif
111
112

#endif /* SWIFT_COMMON_IO_H */