hydro_properties.c 13.6 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/*******************************************************************************
 * This file is part of SWIFT.
 * Copyright (c) 2016 Matthieu Schaller (matthieu.schaller@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/>.
 *
 ******************************************************************************/

/* This object's header. */
#include "hydro_properties.h"

/* Standard headers */
24
#include <float.h>
25
26
27
#include <math.h>

/* Local headers. */
28
#include "adiabatic_index.h"
29
#include "common_io.h"
30
#include "dimension.h"
31
#include "equation_of_state.h"
32
33
#include "error.h"
#include "hydro.h"
34
#include "kernel_hydro.h"
35

36
#define hydro_props_default_max_iterations 30
37
#define hydro_props_default_volume_change 1.4f
38
#define hydro_props_default_h_max FLT_MAX
39
#define hydro_props_default_h_tolerance 1e-4
40
#define hydro_props_default_init_temp 0.f
41
#define hydro_props_default_min_temp 0.f
42
#define hydro_props_default_H_ionization_temperature 1e4
Josh Borrow's avatar
Josh Borrow committed
43
44
45
46
47
48
49
#define hydro_props_default_viscosity_alpha 0.8f
#define hydro_props_default_viscosity_alpha_min \
  0.1f /* Values taken from (Price,2004), not used in legacy gadget mode */
#define hydro_props_default_viscosity_alpha_max \
  2.0f /* Values taken from (Price,2004), not used in legacy gadget mode */
#define hydro_props_default_viscosity_length \
  0.1f /* Values taken from (Price,2004), not used in legacy gadget mode */
50

51
52
53
54
55
56
57
58
/**
 * @brief Initialize the global properties of the hydro scheme.
 *
 * @param p The #hydro_props.
 * @param phys_const The physical constants in the internal unit system.
 * @param us The internal unit system.
 * @param params The parsed parameters.
 */
59
void hydro_props_init(struct hydro_props *p,
60
61
                      const struct phys_const *phys_const,
                      const struct unit_system *us,
lhausamm's avatar
lhausamm committed
62
                      struct swift_params *params) {
63
64
65

  /* Kernel properties */
  p->eta_neighbours = parser_get_param_float(params, "SPH:resolution_eta");
66
67
68
69
70
71

  /* Tolerance for the smoothing length Newton-Raphson scheme */
  p->h_tolerance = parser_get_opt_param_float(params, "SPH:h_tolerance",
                                              hydro_props_default_h_tolerance);

  /* Get derived properties */
72
  p->target_neighbours = pow_dimension(p->eta_neighbours) * kernel_norm;
73
74
75
76
  const float delta_eta = p->eta_neighbours * (1.f + p->h_tolerance);
  p->delta_neighbours =
      (pow_dimension(delta_eta) - pow_dimension(p->eta_neighbours)) *
      kernel_norm;
77

78
79
80
81
#ifdef SHADOWFAX_SPH
  /* change the meaning of target_neighbours and delta_neighbours */
  p->target_neighbours = 1.0f;
  p->delta_neighbours = 0.0f;
82
  p->eta_neighbours = 1.0f;
83
84
#endif

85
86
87
88
89
  /* Maximal smoothing length */
  p->h_max = parser_get_opt_param_float(params, "SPH:h_max",
                                        hydro_props_default_h_max);

  /* Number of iterations to converge h */
90
91
  p->max_smoothing_iterations = parser_get_opt_param_int(
      params, "SPH:max_ghost_iterations", hydro_props_default_max_iterations);
92

93
94
95
  if (p->max_smoothing_iterations <= 10)
    error("The number of smoothing length iterations should be > 10");

96
97
  /* Time integration properties */
  p->CFL_condition = parser_get_param_float(params, "SPH:CFL_condition");
98
99
  const float max_volume_change = parser_get_opt_param_float(
      params, "SPH:max_volume_change", hydro_props_default_volume_change);
100
  p->log_max_h_change = logf(powf(max_volume_change, hydro_dimension_inv));
101
102
103
104
105

  /* Initial temperature */
  p->initial_temperature = parser_get_opt_param_float(
      params, "SPH:initial_temperature", hydro_props_default_init_temp);

106
  /* Minimal temperature */
107
108
109
  p->minimal_temperature = parser_get_opt_param_float(
      params, "SPH:minimal_temperature", hydro_props_default_min_temp);

110
111
  if ((p->initial_temperature != 0.) &&
      (p->initial_temperature < p->minimal_temperature))
112
113
    error("Initial temperature lower than minimal allowed temperature!");

114
115
116
117
118
  /* Neutral to ionized Hydrogen transition temperature */
  p->hydrogen_ionization_temperature =
      parser_get_opt_param_double(params, "SPH:H_ionization_temperature",
                                  hydro_props_default_H_ionization_temperature);

119
  /* Hydrogen mass fraction */
120
121
  const float default_H_fraction =
      1. - phys_const->const_primordial_He_fraction;
122
  p->hydrogen_mass_fraction = parser_get_opt_param_double(
123
      params, "SPH:H_mass_fraction", default_H_fraction);
124

125
126
127
128
129
130
  /* Mean molecular mass for neutral gas */
  p->mu_neutral = 4. / (1. + 3. * p->hydrogen_mass_fraction);

  /* Mean molecular mass for fully ionised gas */
  p->mu_ionised = 4. / (8. - 5. * (1. - p->hydrogen_mass_fraction));

Josh Borrow's avatar
Josh Borrow committed
131
132
  /* Read the artificial viscosity parameters from the file, if they exist */
  p->viscosity.alpha = parser_get_opt_param_float(
Matthieu Schaller's avatar
Matthieu Schaller committed
133
      params, "SPH:viscosity_alpha", hydro_props_default_viscosity_alpha);
Josh Borrow's avatar
Josh Borrow committed
134

Matthieu Schaller's avatar
Matthieu Schaller committed
135
136
137
138
139
140
141
  p->viscosity.alpha_max =
      parser_get_opt_param_float(params, "SPH:viscosity_alpha_max",
                                 hydro_props_default_viscosity_alpha_max);

  p->viscosity.alpha_min =
      parser_get_opt_param_float(params, "SPH:viscosity_alpha_min",
                                 hydro_props_default_viscosity_alpha_min);
Josh Borrow's avatar
Josh Borrow committed
142
143

  p->viscosity.length = parser_get_opt_param_float(
Matthieu Schaller's avatar
Matthieu Schaller committed
144
      params, "SPH:viscosity_length", hydro_props_default_viscosity_length);
Josh Borrow's avatar
Josh Borrow committed
145

146
  /* Compute the initial energy (Note the temp. read is in internal units) */
147
  /* u_init = k_B T_init / (mu m_p (gamma - 1)) */
148
149
150
151
  double u_init = phys_const->const_boltzmann_k / phys_const->const_proton_mass;
  u_init *= p->initial_temperature;
  u_init *= hydro_one_over_gamma_minus_one;

152
  /* Correct for hydrogen mass fraction (mu) */
153
  double mean_molecular_weight;
154
  if (p->initial_temperature > p->hydrogen_ionization_temperature)
155
156
157
158
159
    mean_molecular_weight = 4. / (8. - 5. * (1. - p->hydrogen_mass_fraction));
  else
    mean_molecular_weight = 4. / (1. + 3. * p->hydrogen_mass_fraction);

  p->initial_internal_energy = u_init / mean_molecular_weight;
160
161

  /* Compute the minimal energy (Note the temp. read is in internal units) */
162
  /* u_min = k_B T_min / (mu m_p (gamma - 1)) */
163
  double u_min = phys_const->const_boltzmann_k / phys_const->const_proton_mass;
164
  u_min *= p->minimal_temperature;
165
166
  u_min *= hydro_one_over_gamma_minus_one;

167
  /* Correct for hydrogen mass fraction (mu) */
168
  if (p->minimal_temperature > p->hydrogen_ionization_temperature)
169
170
171
172
173
    mean_molecular_weight = 4. / (8. - 5. * (1. - p->hydrogen_mass_fraction));
  else
    mean_molecular_weight = 4. / (1. + 3. * p->hydrogen_mass_fraction);

  p->minimal_internal_energy = u_min / mean_molecular_weight;
174
175
}

176
177
178
179
180
/**
 * @brief Print the global properties of the hydro scheme.
 *
 * @param p The #hydro_props.
 */
181
182
void hydro_props_print(const struct hydro_props *p) {

183
184
  /* Print equation of state first */
  eos_print(&eos);
185

186
  /* Now SPH */
187
188
189
  message("Hydrodynamic scheme: %s in %dD.", SPH_IMPLEMENTATION,
          (int)hydro_dimension);

190
191
192
  message("Hydrodynamic kernel: %s with eta=%f (%.2f neighbours).", kernel_name,
          p->eta_neighbours, p->target_neighbours);

193
  message("Hydrodynamic relative tolerance in h: %.5f (+/- %.4f neighbours).",
194
          p->h_tolerance, p->delta_neighbours);
195

Peter W. Draper's avatar
Peter W. Draper committed
196
  message("Hydrodynamic integration: CFL parameter: %.4f.", p->CFL_condition);
197

Matthieu Schaller's avatar
Matthieu Schaller committed
198
199
200
201
202
  message(
      "Artificial viscosity parameters set to alpha: %.3f, max: %.3f, "
      "min: %.3f, length: %.3f.",
      p->viscosity.alpha, p->viscosity.alpha_max, p->viscosity.alpha_min,
      p->viscosity.length);
Josh Borrow's avatar
Josh Borrow committed
203

204
  message(
Matthieu Schaller's avatar
Matthieu Schaller committed
205
206
      "Hydrodynamic integration: Max change of volume: %.2f "
      "(max|dlog(h)/dt|=%f).",
207
      pow_dimension(expf(p->log_max_h_change)), p->log_max_h_change);
208

209
210
211
  if (p->h_max != hydro_props_default_h_max)
    message("Maximal smoothing length allowed: %.4f", p->h_max);

212
213
214
  if (p->max_smoothing_iterations != hydro_props_default_max_iterations)
    message("Maximal iterations in ghost task set to %d (default is %d)",
            p->max_smoothing_iterations, hydro_props_default_max_iterations);
215
216
217

  if (p->initial_temperature != hydro_props_default_init_temp)
    message("Initial gas temperature set to %f", p->initial_temperature);
218
219

  if (p->minimal_temperature != hydro_props_default_min_temp)
220
    message("Minimal gas temperature set to %f", p->minimal_temperature);
221

Peter W. Draper's avatar
Peter W. Draper committed
222
    // Matthieu: Temporary location for this i/o business.
223

224
#ifdef PLANETARY_SPH
225
226
#ifdef PLANETARY_SPH_NO_BALSARA
  message("Planetary SPH: Balsara switch DISABLED");
227
#else
228
229
230
  message("Planetary SPH: Balsara switch ENABLED");
#endif
#endif
231
}
232
233
234
235

#if defined(HAVE_HDF5)
void hydro_props_print_snapshot(hid_t h_grpsph, const struct hydro_props *p) {

236
237
  eos_print_snapshot(h_grpsph, &eos);

238
239
240
241
242
243
  io_write_attribute_i(h_grpsph, "Dimension", (int)hydro_dimension);
  io_write_attribute_s(h_grpsph, "Scheme", SPH_IMPLEMENTATION);
  io_write_attribute_s(h_grpsph, "Kernel function", kernel_name);
  io_write_attribute_f(h_grpsph, "Kernel target N_ngb", p->target_neighbours);
  io_write_attribute_f(h_grpsph, "Kernel delta N_ngb", p->delta_neighbours);
  io_write_attribute_f(h_grpsph, "Kernel eta", p->eta_neighbours);
244
  io_write_attribute_f(h_grpsph, "Smoothing length tolerance", p->h_tolerance);
245
246
  io_write_attribute_f(h_grpsph, "Maximal smoothing length [internal units]",
                       p->h_max);
247
248
249
250
251
252
253
  io_write_attribute_f(h_grpsph, "CFL parameter", p->CFL_condition);
  io_write_attribute_f(h_grpsph, "Volume log(max(delta h))",
                       p->log_max_h_change);
  io_write_attribute_f(h_grpsph, "Volume max change time-step",
                       pow_dimension(expf(p->log_max_h_change)));
  io_write_attribute_i(h_grpsph, "Max ghost iterations",
                       p->max_smoothing_iterations);
254
  io_write_attribute_f(h_grpsph, "Minimal temperature", p->minimal_temperature);
255
256
257
  io_write_attribute_f(h_grpsph,
                       "Minimal energy per unit mass [internal units]",
                       p->minimal_internal_energy);
258
  io_write_attribute_f(h_grpsph, "Initial temperature", p->initial_temperature);
259
260
  io_write_attribute_f(h_grpsph,
                       "Initial energy per unit mass [internal units]",
261
262
263
                       p->initial_internal_energy);
  io_write_attribute_f(h_grpsph, "Hydrogen mass fraction",
                       p->hydrogen_mass_fraction);
264
  io_write_attribute_f(h_grpsph, "Hydrogen ionization transition temperature",
265
                       p->hydrogen_ionization_temperature);
Josh Borrow's avatar
Josh Borrow committed
266
267
268
269
270
  io_write_attribute_f(h_grpsph, "Alpha viscosity", p->viscosity.alpha);
  io_write_attribute_f(h_grpsph, "Alpha viscosity (max)",
                       p->viscosity.alpha_max);
  io_write_attribute_f(h_grpsph, "Alpha viscosity (min)",
                       p->viscosity.alpha_min);
271
272
  io_write_attribute_f(h_grpsph, "Viscosity decay length [internal units]",
                       p->viscosity.length);
Josh Borrow's avatar
Josh Borrow committed
273
  io_write_attribute_f(h_grpsph, "Beta viscosity", const_viscosity_beta);
274
275
  io_write_attribute_f(h_grpsph, "Max v_sig ratio (limiter)",
                       const_limiter_max_v_sig_ratio);
276
277
}
#endif
278

Josh Borrow's avatar
Josh Borrow committed
279
280
281
282
/**
 * @brief Initialises a hydro_props struct with somewhat useful values for
 *        the automated test suite. This is not intended for production use,
 *        but rather to fill for the purposes of mocking.
Matthieu Schaller's avatar
Matthieu Schaller committed
283
 *
Josh Borrow's avatar
Josh Borrow committed
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 * @param p the struct
 */
void hydro_props_init_no_hydro(struct hydro_props *p) {
  p->eta_neighbours = 1.2348;
  p->h_tolerance = hydro_props_default_h_tolerance;
  p->target_neighbours = pow_dimension(p->eta_neighbours) * kernel_norm;
  const float delta_eta = p->eta_neighbours * (1.f + p->h_tolerance);
  p->delta_neighbours =
      (pow_dimension(delta_eta) - pow_dimension(p->eta_neighbours)) *
      kernel_norm;
  p->h_max = hydro_props_default_h_max;
  p->max_smoothing_iterations = hydro_props_default_max_iterations;
  p->CFL_condition = 0.1;
  p->log_max_h_change = logf(powf(1.4, hydro_dimension_inv));
Matthieu Schaller's avatar
Matthieu Schaller committed
298

Josh Borrow's avatar
Josh Borrow committed
299
300
301
302
303
304
305
306
307
  /* These values are inconsistent and in a production run would probably lead
     to a crash. Again, this function is intended for mocking use in unit tests
     and is _not_ to be used otherwise! */
  p->minimal_temperature = hydro_props_default_min_temp;
  p->minimal_internal_energy = 0.f;
  p->initial_temperature = hydro_props_default_init_temp;
  p->initial_internal_energy = 0.f;

  p->hydrogen_mass_fraction = 0.755;
Matthieu Schaller's avatar
Matthieu Schaller committed
308
309
  p->hydrogen_ionization_temperature =
      hydro_props_default_H_ionization_temperature;
Josh Borrow's avatar
Josh Borrow committed
310
311

  p->viscosity.alpha = hydro_props_default_viscosity_alpha;
Matthieu Schaller's avatar
Matthieu Schaller committed
312
313
314
  p->viscosity.alpha_max = hydro_props_default_viscosity_alpha_max;
  p->viscosity.alpha_min = hydro_props_default_viscosity_alpha_min;
  p->viscosity.length = hydro_props_default_viscosity_length;
Josh Borrow's avatar
Josh Borrow committed
315
316
}

317
318
319
320
321
322
323
/**
 * @brief Write a hydro_props struct to the given FILE as a stream of bytes.
 *
 * @param p the struct
 * @param stream the file stream
 */
void hydro_props_struct_dump(const struct hydro_props *p, FILE *stream) {
Peter W. Draper's avatar
Peter W. Draper committed
324
  restart_write_blocks((void *)p, sizeof(struct hydro_props), 1, stream,
325
                       "hydroprops", "hydro props");
326
327
328
329
330
331
332
333
334
335
}

/**
 * @brief Restore a hydro_props struct from the given FILE as a stream of
 * bytes.
 *
 * @param p the struct
 * @param stream the file stream
 */
void hydro_props_struct_restore(const struct hydro_props *p, FILE *stream) {
Peter W. Draper's avatar
Peter W. Draper committed
336
337
  restart_read_blocks((void *)p, sizeof(struct hydro_props), 1, stream, NULL,
                      "hydro props");
338
}