hydro_properties.c 9.69 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
43

44
45
46
47
48
49
50
51
/**
 * @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.
 */
52
void hydro_props_init(struct hydro_props *p,
53
54
                      const struct phys_const *phys_const,
                      const struct unit_system *us,
lhausamm's avatar
lhausamm committed
55
                      struct swift_params *params) {
56
57
58

  /* Kernel properties */
  p->eta_neighbours = parser_get_param_float(params, "SPH:resolution_eta");
59
60
61
62
63
64

  /* 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 */
65
  p->target_neighbours = pow_dimension(p->eta_neighbours) * kernel_norm;
66
67
68
69
  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;
70

71
72
73
74
#ifdef SHADOWFAX_SPH
  /* change the meaning of target_neighbours and delta_neighbours */
  p->target_neighbours = 1.0f;
  p->delta_neighbours = 0.0f;
75
  p->eta_neighbours = 1.0f;
76
77
#endif

78
79
80
81
82
  /* 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 */
83
84
  p->max_smoothing_iterations = parser_get_opt_param_int(
      params, "SPH:max_ghost_iterations", hydro_props_default_max_iterations);
85
86
87

  /* Time integration properties */
  p->CFL_condition = parser_get_param_float(params, "SPH:CFL_condition");
88
89
  const float max_volume_change = parser_get_opt_param_float(
      params, "SPH:max_volume_change", hydro_props_default_volume_change);
90
  p->log_max_h_change = logf(powf(max_volume_change, hydro_dimension_inv));
91
92
93
94
95

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

96
  /* Minimal temperature */
97
98
99
  p->minimal_temperature = parser_get_opt_param_float(
      params, "SPH:minimal_temperature", hydro_props_default_min_temp);

100
101
  if ((p->initial_temperature != 0.) &&
      (p->initial_temperature < p->minimal_temperature))
102
103
    error("Initial temperature lower than minimal allowed temperature!");

104
105
106
107
108
  /* 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);

109
  /* Hydrogen mass fraction */
110
111
  const float default_H_fraction =
      1. - phys_const->const_primordial_He_fraction;
112
  p->hydrogen_mass_fraction = parser_get_opt_param_double(
113
      params, "SPH:H_mass_fraction", default_H_fraction);
114
115

  /* Compute the initial energy (Note the temp. read is in internal units) */
116
  /* u_init = k_B T_init / (mu m_p (gamma - 1)) */
117
118
119
120
  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;

121
  /* Correct for hydrogen mass fraction (mu) */
122
  double mean_molecular_weight;
123
  if (p->initial_temperature > p->hydrogen_ionization_temperature)
124
125
126
127
128
    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;
129
130

  /* Compute the minimal energy (Note the temp. read is in internal units) */
131
  /* u_min = k_B T_min / (mu m_p (gamma - 1)) */
132
  double u_min = phys_const->const_boltzmann_k / phys_const->const_proton_mass;
133
  u_min *= p->minimal_temperature;
134
135
  u_min *= hydro_one_over_gamma_minus_one;

136
  /* Correct for hydrogen mass fraction (mu) */
137
  if (p->minimal_temperature > p->hydrogen_ionization_temperature)
138
139
140
141
142
    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;
143
144
}

145
146
147
148
149
/**
 * @brief Print the global properties of the hydro scheme.
 *
 * @param p The #hydro_props.
 */
150
151
void hydro_props_print(const struct hydro_props *p) {

152
153
  /* Print equation of state first */
  eos_print(&eos);
154

155
  /* Now SPH */
156
157
158
  message("Hydrodynamic scheme: %s in %dD.", SPH_IMPLEMENTATION,
          (int)hydro_dimension);

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

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

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

167
  message(
Matthieu Schaller's avatar
Matthieu Schaller committed
168
169
      "Hydrodynamic integration: Max change of volume: %.2f "
      "(max|dlog(h)/dt|=%f).",
170
      pow_dimension(expf(p->log_max_h_change)), p->log_max_h_change);
171

172
173
174
  if (p->h_max != hydro_props_default_h_max)
    message("Maximal smoothing length allowed: %.4f", p->h_max);

175
176
177
  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);
178
179
180

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

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

Peter W. Draper's avatar
Peter W. Draper committed
185
    // Matthieu: Temporary location for this i/o business.
186
187
188
189
190
191
192
#ifdef PLANETARY_SPH
#ifdef PLANETARY_SPH_BALSARA
  message("Planetary SPH: Balsara switch enabled");
#else
  message("Planetary SPH: Balsara switch disabled");
#endif  // PLANETARY_SPH_BALSARA
#endif  // PLANETARY_SPH
193
}
194
195
196
197

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

198
199
  eos_print_snapshot(h_grpsph, &eos);

200
201
202
203
204
205
  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);
206
  io_write_attribute_f(h_grpsph, "Smoothing length tolerance", p->h_tolerance);
207
  io_write_attribute_f(h_grpsph, "Maximal smoothing length", p->h_max);
208
209
210
211
212
213
214
  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);
215
  io_write_attribute_f(h_grpsph, "Minimal temperature", p->minimal_temperature);
216
217
218
219
220
  io_write_attribute_f(h_grpsph, "Initial temperature", p->initial_temperature);
  io_write_attribute_f(h_grpsph, "Initial energy per unit mass",
                       p->initial_internal_energy);
  io_write_attribute_f(h_grpsph, "Hydrogen mass fraction",
                       p->hydrogen_mass_fraction);
221
222
  io_write_attribute_f(h_grpsph, "Hydrogen ionization transition temperature",
		       p->hydrogen_ionization_temperature);
Matthieu Schaller's avatar
Matthieu Schaller committed
223
  io_write_attribute_f(h_grpsph, "Alpha viscosity", const_viscosity_alpha);
224
225
}
#endif
226
227
228
229
230
231
232
233

/**
 * @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
234
  restart_write_blocks((void *)p, sizeof(struct hydro_props), 1, stream,
235
                       "hydroprops", "hydro props");
236
237
238
239
240
241
242
243
244
245
}

/**
 * @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
246
247
  restart_read_blocks((void *)p, sizeof(struct hydro_props), 1, stream, NULL,
                      "hydro props");
248
}