logger.h 6.32 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/*******************************************************************************
 * This file is part of SWIFT.
 * Copyright (c) 2017 Pedro Gonnet (pedro.gonnet@durham.ac.uk)
 *
 * 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/>.
 *
 ******************************************************************************/
#ifndef SWIFT_LOGGER_H
#define SWIFT_LOGGER_H

lhausamm's avatar
lhausamm committed
22
23
#ifdef WITH_LOGGER

24
25
/* Includes. */
#include "part.h"
lhausamm's avatar
lhausamm committed
26
27
28
#include "units.h"
#include "engine.h"
#include "common_io.h"
29

30
31
32
/* Forward declaration */
struct dump;

33
34
/**
 * Logger entries contain messages representing the particle data at a given
35
 * point in time during the simulation.
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 *
 * The logger messages always start with an 8-byte header structured as
 * follows:
 *
 *   data: [ mask |                     offset                     ]
 *   byte: [  01  |  02  |  03  |  04  |  05  |  06  |  07  |  08  ]
 *
 * I.e. a first "mask" byte followed by 7 "offset" bytes. The mask contains
 * information on what kind of data is packed after the header. The mask
 * bits correspond to the following data:
 *
 *   bit | name   | size | comment
 *   -------------------------------------------------------------------------
 *   0   | x      | 24   | The particle position, in absolute coordinates,
 *       |        |      | stored as three doubles.
 *   1   | v      | 12   | Particle velocity, stored as three floats.
 *   2   | a      | 12   | Particle acceleration, stored as three floats.
53
54
 *   3   | u      | 4    | Particle internal energy (or entropy, if Gadget-SPH
 *       |        |      | is used), stored as a single float.
55
56
 *   4   | h      | 4    | Particle smoothing length (or epsilon, if a gpart),
 *       |        |      | stored as a single float.
57
 *   5   | rho    | 4    | Particle density, stored as a single float.
58
59
 *   6   | consts | 12   | Particle constants, i.e. mass and ID.
 *   7   | time   | 8    | Timestamp, not associated with a particle, just
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 *       |        |      | marks the transitions from one timestep to another.
 *
 * There is no distinction between gravity and SPH particles.
 *
 * The offset refers to the relative location of the previous message for the
 * same particle or for the previous timestamp (if mask bit 7 is set). I.e.
 * the previous log entry will be at the address of the current mask byte minus
 * the unsigned value stored in the offset. An offset of zero indicates that
 * this is the first message for the given particle/timestamp.
 */

/* Some constants. */
#define logger_mask_x 1
#define logger_mask_v 2
#define logger_mask_a 4
#define logger_mask_u 8
#define logger_mask_h 16
#define logger_mask_rho 32
#define logger_mask_consts 64
#define logger_mask_timestamp 128

81
82
83
84
85
/* header constants
 * Thoses are definitions from the format and therefore should not be changed!
 * Size in bytes
 */
#define LOGGER_VERSION_SIZE 20 // size of the version message
lhausamm's avatar
lhausamm committed
86
87
88
#define LOGGER_NAME_SIZE 2 // size of the labels size
#define LOGGER_MASK_SIZE 1 // size of the masks size
#define LOGGER_NBER_SIZE 1 // size of the number of elements size
lhausamm's avatar
lhausamm committed
89
#define LOGGER_OFFSET_SIZE 1// size of the offset size information
90
#define LOGGER_DATATYPE_SIZE 1
91

lhausamm's avatar
lhausamm committed
92
93
extern char LOGGER_VERSION[LOGGER_VERSION_SIZE];

94
struct logger_const {
lhausamm's avatar
lhausamm committed
95
96
97
  size_t name; // labels size
  size_t offset; // offset size
  size_t mask; // mask size
lhausamm's avatar
lhausamm committed
98
  size_t number; // number size
lhausamm's avatar
lhausamm committed
99
100
101
102
103
  size_t nber_mask; // number of different masks
  size_t *masks; // value of each masks (e.g. logger_mask_...)
  size_t *masks_size; // size of each mask
  char *masks_name; // label of each mask
  char *masks_type; // type of data (e.g. 'CHAR', 'INT', 'FLOAT')
104
105
};

106
107
108
109
110
111
enum logger_datatype {
  logger_data_int,
  logger_data_float,
  logger_data_double,
  logger_data_char,
};
112

113
114
/* Function prototypes. */
int logger_size(unsigned int mask);
115
116
117
118
void logger_log_part(struct part *p, unsigned int mask, size_t *offset,
                     struct dump *dump);
void logger_log_gpart(struct gpart *p, unsigned int mask, size_t *offset,
                      struct dump *dump);
Pedro Gonnet's avatar
Pedro Gonnet committed
119
void logger_log_timestamp(unsigned long long int t, size_t *offset,
120
                          struct dump *dump);
Pedro Gonnet's avatar
Pedro Gonnet committed
121
122
123
124
int logger_read_part(struct part *p, size_t *offset, const char *buff);
int logger_read_gpart(struct gpart *p, size_t *offset, const char *buff);
int logger_read_timestamp(unsigned long long int *t, size_t *offset,
                          const char *buff);
125
void logger_write_file_header(struct dump *dump, struct engine* e);
126
void logger_const_init(struct logger_const* log_const);
lhausamm's avatar
lhausamm committed
127
128
void logger_const_free(struct logger_const* log_const);
void logger_ensure_size(size_t total_nr_parts, size_t logger_size);
lhausamm's avatar
lhausamm committed
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

/**
 * @brief Should this particle write its data now ?
 *
 * @param xp The #xpart.
 * @param e The #engine containing information about the current time.
 * @return 1 if the #part should write, 0 otherwise.
 */
__attribute__((always_inline)) INLINE static int xpart_should_write(
    const struct xpart *xp, const struct engine *e) {

  return (xp->last_output > e->logger_max_steps);  
}

/**
 * @brief Should this particle write its data now ?
 *
 * @param p The #gpart.
 * @param e The #engine containing information about the current time.
 * @return 1 if the #gpart should write, 0 otherwise.
 */
__attribute__((always_inline)) INLINE static int gpart_should_write(
    const struct gpart *gp, const struct engine *e) {

  return (gp->last_output > e->logger_max_steps);  
}

/**
 * @brief Should this particle write its data now ?
 *
 * @param p The #spart.
 * @param e The #engine containing information about the current time.
 * @return 1 if the #spart should write, 0 otherwise.
 */
__attribute__((always_inline)) INLINE static int spart_should_write(
    const struct spart *sp, const struct engine *e) {

  return (sp->last_output > e->logger_max_steps);  
}

lhausamm's avatar
lhausamm committed
169
170
#endif /* WITH_LOGGER */

171
#endif /* SWIFT_LOGGER_H */