hydro.h 15.5 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
/*******************************************************************************
 * 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/>.
 *
 ******************************************************************************/
#ifndef SWIFT_PRESSURE_ENTROPY_HYDRO_H
#define SWIFT_PRESSURE_ENTROPY_HYDRO_H

/**
23
24
25
 * @file PressureEntropy/hydro.h
 * @brief Pressure-Entropy implementation of SPH (Non-neighbour loop
 * equations)
26
27
28
29
 *
 * The thermal variable is the entropy (S) and the entropy is smoothed over
 * contact discontinuities to prevent spurious surface tension.
 *
30
31
 * Follows eqautions (19), (21) and (22) of Hopkins, P., MNRAS, 2013,
 * Volume 428, Issue 4, pp. 2840-2856 with a simple Balsara viscosity term.
32
33
34
 */

#include "adiabatic_index.h"
35
#include "approx_math.h"
36
37
38
#include "dimension.h"
#include "equation_of_state.h"
#include "hydro_properties.h"
39
#include "hydro_space.h"
40
#include "kernel_hydro.h"
41
#include "minmax.h"
42
43
44
45
46
47
48

/**
 * @brief Returns the internal energy of a particle
 *
 * @param p The particle of interest
 */
__attribute__((always_inline)) INLINE static float hydro_get_internal_energy(
49
    const struct part *restrict p) {
50

51
  return gas_internal_energy_from_entropy(p->rho_bar, p->entropy);
52
53
54
55
56
57
58
59
}

/**
 * @brief Returns the pressure of a particle
 *
 * @param p The particle of interest
 */
__attribute__((always_inline)) INLINE static float hydro_get_pressure(
60
    const struct part *restrict p) {
61

62
  return gas_pressure_from_entropy(p->rho_bar, p->entropy);
63
64
65
66
67
68
69
70
}

/**
 * @brief Returns the entropy of a particle
 *
 * @param p The particle of interest
 */
__attribute__((always_inline)) INLINE static float hydro_get_entropy(
71
    const struct part *restrict p) {
72

73
  return p->entropy;
74
75
76
77
78
79
80
81
}

/**
 * @brief Returns the sound speed of a particle
 *
 * @param p The particle of interest
 */
__attribute__((always_inline)) INLINE static float hydro_get_soundspeed(
82
    const struct part *restrict p) {
83
84
85
86

  return p->force.soundspeed;
}

87
/**
88
 * @brief Returns the physical density of a particle
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 *
 * @param p The particle of interest
 */
__attribute__((always_inline)) INLINE static float hydro_get_density(
    const struct part *restrict p) {

  return p->rho;
}

/**
 * @brief Returns the mass of a particle
 *
 * @param p The particle of interest
 */
__attribute__((always_inline)) INLINE static float hydro_get_mass(
    const struct part *restrict p) {

  return p->mass;
}

109
/**
110
 * @brief Returns the time derivative of internal energy of a particle
111
 *
112
 * We assume a constant density.
113
 *
114
 * @param p The particle of interest
115
 */
116
117
__attribute__((always_inline)) INLINE static float hydro_get_internal_energy_dt(
    const struct part *restrict p) {
118

119
  return gas_internal_energy_from_entropy(p->rho_bar, p->entropy_dt);
120
121
122
}

/**
123
 * @brief Returns the time derivative of internal energy of a particle
124
 *
125
 * We assume a constant density.
126
 *
127
128
 * @param p The particle of interest.
 * @param du_dt The new time derivative of the internal energy.
129
 */
130
131
__attribute__((always_inline)) INLINE static void hydro_set_internal_energy_dt(
    struct part *restrict p, float du_dt) {
132

133
  p->entropy_dt = gas_entropy_from_internal_energy(p->rho_bar, du_dt);
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
}

/**
 * @brief Computes the hydro time-step of a given particle
 *
 * @param p Pointer to the particle data
 * @param xp Pointer to the extended particle data
 *
 */
__attribute__((always_inline)) INLINE static float hydro_compute_timestep(
    const struct part *restrict p, const struct xpart *restrict xp,
    const struct hydro_props *restrict hydro_properties) {

  const float CFL_condition = hydro_properties->CFL_condition;

  /* CFL condition */
  const float dt_cfl =
      2.f * kernel_gamma * CFL_condition * p->h / p->force.v_sig;

  return dt_cfl;
}

156
157
158
159
160
161
162
163
164
165
/**
 * @brief Does some extra hydro operations once the actual physical time step
 * for the particle is known.
 *
 * @param p The particle to act upon.
 * @param dt Physical time step of the particle during the next step.
 */
__attribute__((always_inline)) INLINE static void hydro_timestep_extra(
    struct part *p, float dt) {}

166
167
168
169
170
171
172
/**
 * @brief Prepares a particle for the density calculation.
 *
 * Zeroes all the relevant arrays in preparation for the sums taking place in
 * the variaous density tasks
 *
 * @param p The particle to act upon
173
 * @param hs #hydro_space containing hydro specific space information.
174
175
 */
__attribute__((always_inline)) INLINE static void hydro_init_part(
176
    struct part *restrict p, const struct hydro_space *hs) {
177

178
  p->rho = 0.f;
179
  p->rho_bar = 0.f;
180
181
  p->density.wcount = 0.f;
  p->density.wcount_dh = 0.f;
182
183
  p->density.rho_dh = 0.f;
  p->density.pressure_dh = 0.f;
184

185
186
187
188
  p->density.div_v = 0.f;
  p->density.rot_v[0] = 0.f;
  p->density.rot_v[1] = 0.f;
  p->density.rot_v[2] = 0.f;
189
190
191
192
193
194
195
196
197
198
199
}

/**
 * @brief Finishes the density calculation.
 *
 * Multiplies the density and number of neighbours by the appropiate constants
 * and add the self-contribution term.
 *
 * @param p The particle to act upon
 */
__attribute__((always_inline)) INLINE static void hydro_end_density(
200
    struct part *restrict p) {
201
202
203

  /* Some smoothing length multiples. */
  const float h = p->h;
204
205
206
  const float h_inv = 1.0f / h;                       /* 1/h */
  const float h_inv_dim = pow_dimension(h_inv);       /* 1/h^d */
  const float h_inv_dim_plus_one = h_inv_dim * h_inv; /* 1/h^(d+1) */
207
208
209

  /* Final operation on the density (add self-contribution). */
  p->rho += p->mass * kernel_root;
210
  p->rho_bar += p->mass * p->entropy_one_over_gamma * kernel_root;
211
212
  p->density.rho_dh -= hydro_dimension * p->mass * kernel_root;
  p->density.pressure_dh -=
213
      hydro_dimension * p->mass * p->entropy_one_over_gamma * kernel_root;
214
215
216
217
  p->density.wcount += kernel_root;

  /* Finish the calculation by inserting the missing h-factors */
  p->rho *= h_inv_dim;
218
  p->rho_bar *= h_inv_dim;
219
220
  p->density.rho_dh *= h_inv_dim_plus_one;
  p->density.pressure_dh *= h_inv_dim_plus_one;
221
222
223
  p->density.wcount *= kernel_norm;
  p->density.wcount_dh *= h_inv * kernel_gamma * kernel_norm;

224
225
  const float rho_inv = 1.f / p->rho;
  const float entropy_minus_one_over_gamma = 1.f / p->entropy_one_over_gamma;
226

227
228
  /* Final operation on the weighted density */
  p->rho_bar *= entropy_minus_one_over_gamma;
229
230

  /* Finish calculation of the velocity curl components */
231
232
233
  p->density.rot_v[0] *= h_inv_dim_plus_one * rho_inv;
  p->density.rot_v[1] *= h_inv_dim_plus_one * rho_inv;
  p->density.rot_v[2] *= h_inv_dim_plus_one * rho_inv;
234
235

  /* Finish calculation of the velocity divergence */
236
  p->density.div_v *= h_inv_dim_plus_one * rho_inv;
237
238
}

239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
/**
 * @brief Sets all particle fields to sensible values when the #part has 0 ngbs.
 *
 * @param p The particle to act upon
 * @param xp The extended particle data to act upon
 */
__attribute__((always_inline)) INLINE static void hydro_part_has_no_neighbours(
    struct part *restrict p, struct xpart *restrict xp) {

  /* Some smoothing length multiples. */
  const float h = p->h;
  const float h_inv = 1.0f / h;                 /* 1/h */
  const float h_inv_dim = pow_dimension(h_inv); /* 1/h^d */

  /* Re-set problematic values */
  p->rho = p->mass * kernel_root * h_inv_dim;
  p->rho_bar = p->mass * kernel_root * h_inv_dim;
  p->density.wcount = kernel_root * kernel_norm * h_inv_dim;
  p->density.rho_dh = 0.f;
  p->density.wcount_dh = 0.f;
  p->density.pressure_dh = 0.f;
  p->density.div_v = 0.f;
  p->density.rot_v[0] = 0.f;
  p->density.rot_v[1] = 0.f;
  p->density.rot_v[2] = 0.f;
}

266
267
268
269
270
271
272
273
274
/**
 * @brief Prepare a particle for the force calculation.
 *
 * Computes viscosity term, conduction term and smoothing length gradient terms.
 *
 * @param p The particle to act upon
 * @param xp The extended particle data to act upon
 */
__attribute__((always_inline)) INLINE static void hydro_prepare_force(
275
    struct part *restrict p, struct xpart *restrict xp) {
276

277
278
279
280
281
282
283
284
285
286
  const float fac_mu = 1.f; /* Will change with cosmological integration */

  /* Compute the norm of the curl */
  const float curl_v = sqrtf(p->density.rot_v[0] * p->density.rot_v[0] +
                             p->density.rot_v[1] * p->density.rot_v[1] +
                             p->density.rot_v[2] * p->density.rot_v[2]);

  /* Compute the norm of div v */
  const float abs_div_v = fabsf(p->density.div_v);

287
  /* Compute the pressure */
288
  const float pressure = gas_pressure_from_entropy(p->rho_bar, p->entropy);
289

290
  /* Compute the sound speed from the pressure*/
291
292
  const float soundspeed = gas_soundspeed_from_pressure(p->rho_bar, pressure);

293
294
295
296
  /* Compute the Balsara switch */
  const float balsara =
      abs_div_v / (abs_div_v + curl_v + 0.0001f * soundspeed / fac_mu / p->h);

Matthieu Schaller's avatar
Matthieu Schaller committed
297
298
299
300
301
  /* Divide the pressure by the density squared to get the SPH term */
  const float rho_bar_inv = 1.f / p->rho_bar;
  const float P_over_rho2 = pressure * rho_bar_inv * rho_bar_inv;

  /* Compute "grad h" term (note we use rho here and not rho_bar !)*/
302
303
304
  const float rho_inv = 1.f / p->rho;
  const float rho_dh =
      1.f / (1.f + hydro_dimension_inv * p->h * p->density.rho_dh * rho_inv);
305
306
  const float pressure_dh =
      p->density.pressure_dh * rho_inv * p->h * hydro_dimension_inv;
307
308

  const float grad_h_term = rho_dh * pressure_dh;
309

310
311
  /* Update variables. */
  p->force.soundspeed = soundspeed;
312
  p->force.P_over_rho2 = P_over_rho2;
313
314
  p->force.balsara = balsara;
  p->force.f = grad_h_term;
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
}

/**
 * @brief Reset acceleration fields of a particle
 *
 * Resets all hydro acceleration and time derivative fields in preparation
 * for the sums taking place in the variaous force tasks
 *
 * @param p The particle to act upon
 */
__attribute__((always_inline)) INLINE static void hydro_reset_acceleration(
    struct part *restrict p) {

  /* Reset the acceleration. */
  p->a_hydro[0] = 0.0f;
  p->a_hydro[1] = 0.0f;
  p->a_hydro[2] = 0.0f;

  /* Reset the time derivatives. */
  p->entropy_dt = 0.0f;
  p->force.h_dt = 0.0f;

  /* Reset maximal signal velocity */
  p->force.v_sig = 0.0f;
}

341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
/**
 * @brief Sets the values to be predicted in the drifts to their values at a
 * kick time
 *
 * @param p The particle.
 * @param xp The extended data of this particle.
 */
__attribute__((always_inline)) INLINE static void hydro_reset_predicted_values(
    struct part *restrict p, const struct xpart *restrict xp) {

  /* Re-set the predicted velocities */
  p->v[0] = xp->v_full[0];
  p->v[1] = xp->v_full[1];
  p->v[2] = xp->v_full[2];

  /* Re-set the entropy */
  p->entropy = xp->entropy_full;
}

360
361
362
363
364
/**
 * @brief Predict additional particle fields forward in time when drifting
 *
 * @param p The particle
 * @param xp The extended data of the particle
365
 * @param dt The drift time-step.
366
367
 */
__attribute__((always_inline)) INLINE static void hydro_predict_extra(
368
    struct part *restrict p, const struct xpart *restrict xp, float dt) {
369

370
  const float h_inv = 1.f / p->h;
371

372
373
  /* Predict smoothing length */
  const float w1 = p->force.h_dt * h_inv * dt;
374
  if (fabsf(w1) < 0.2f)
375
    p->h *= approx_expf(w1); /* 4th order expansion of exp(w) */
376
  else
377
378
379
380
381
382
383
384
385
386
387
388
    p->h *= expf(w1);

  /* Predict density */
  const float w2 = -hydro_dimension * w1;
  if (fabsf(w2) < 0.2f) {
    p->rho *= approx_expf(w2); /* 4th order expansion of exp(w) */
    p->rho_bar *= approx_expf(w2);
  } else {
    p->rho *= expf(w2);
    p->rho_bar *= expf(w2);
  }

389
390
  /* Predict the entropy */
  p->entropy += p->entropy_dt * dt;
391
392

  /* Compute the pressure */
393
  const float pressure = gas_pressure_from_entropy(p->rho_bar, p->entropy);
394

395
396
397
398
  /* Compute the new sound speed */
  const float soundspeed = gas_soundspeed_from_pressure(p->rho_bar, pressure);

  /* Divide the pressure by the density squared to get the SPH term */
399
  const float rho_bar_inv = 1.f / p->rho_bar;
400
  const float P_over_rho2 = pressure * rho_bar_inv * rho_bar_inv;
401

402
  /* Update the variables */
403
  p->entropy_one_over_gamma = pow_one_over_gamma(p->entropy);
404
  p->force.soundspeed = soundspeed;
405
  p->force.P_over_rho2 = P_over_rho2;
406
407
408
409
410
411
412
413
414
415
416
417
418
419
}

/**
 * @brief Finishes the force calculation.
 *
 * Multiplies the forces and accelerationsby the appropiate constants
 *
 * @param p The particle to act upon
 */
__attribute__((always_inline)) INLINE static void hydro_end_force(
    struct part *restrict p) {

  p->force.h_dt *= p->h * hydro_dimension_inv;

Matthieu Schaller's avatar
Matthieu Schaller committed
420
  p->entropy_dt =
421
      0.5f * gas_entropy_from_internal_energy(p->rho_bar, p->entropy_dt);
422
423
424
425
426
427
428
429
430
431
432
}

/**
 * @brief Kick the additional variables
 *
 * @param p The particle to act upon
 * @param xp The particle extended data to act upon
 * @param dt The time-step for this kick
 * @param half_dt The half time-step for this kick
 */
__attribute__((always_inline)) INLINE static void hydro_kick_extra(
433
    struct part *restrict p, struct xpart *restrict xp, float dt) {
434
435

  /* Do not decrease the entropy (temperature) by more than a factor of 2*/
436
  if (dt > 0. && p->entropy_dt * dt < -0.5f * xp->entropy_full) {
437
438
439
    p->entropy_dt = -0.5f * xp->entropy_full / dt;
  }
  xp->entropy_full += p->entropy_dt * dt;
440
441

  /* Compute the pressure */
442
443
  const float pressure =
      gas_pressure_from_entropy(p->rho_bar, xp->entropy_full);
444

445
446
447
448
  /* Compute the new sound speed */
  const float soundspeed = gas_soundspeed_from_pressure(p->rho_bar, pressure);

  /* Divide the pressure by the density squared to get the SPH term */
449
  const float rho_bar_inv = 1.f / p->rho_bar;
450
  const float P_over_rho2 = pressure * rho_bar_inv * rho_bar_inv;
451
452
453

  p->entropy_one_over_gamma = pow_one_over_gamma(p->entropy);
  p->force.soundspeed = soundspeed;
454
  p->force.P_over_rho2 = P_over_rho2;
455
456
457
458
459
460
461
462
463
464
}

/**
 *  @brief Converts hydro quantity of a particle at the start of a run
 *
 * Requires the density to be known
 *
 * @param p The particle to act upon
 */
__attribute__((always_inline)) INLINE static void hydro_convert_quantities(
465
    struct part *restrict p, struct xpart *restrict xp) {
466
467

  /* We read u in the entropy field. We now get S from u */
468
469
  xp->entropy_full = gas_entropy_from_internal_energy(p->rho_bar, p->entropy);
  p->entropy = xp->entropy_full;
470
471
472
  p->entropy_one_over_gamma = pow_one_over_gamma(p->entropy);

  /* Compute the pressure */
473
  const float pressure = gas_pressure_from_entropy(p->rho_bar, p->entropy);
474

475
476
477
478
  /* Compute the sound speed */
  const float soundspeed = gas_soundspeed_from_pressure(p->rho_bar, pressure);

  /* Divide the pressure by the density squared to get the SPH term */
479
  const float rho_bar_inv = 1.f / p->rho_bar;
480
481
  const float P_over_rho2 = pressure * rho_bar_inv * rho_bar_inv;

482
  p->force.soundspeed = soundspeed;
483
  p->force.P_over_rho2 = P_over_rho2;
484
485
}

486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
/**
 * @brief Initialises the particles for the first time
 *
 * This function is called only once just after the ICs have been
 * read in to do some conversions.
 *
 * @param p The particle to act upon
 * @param xp The extended particle data to act upon
 */
__attribute__((always_inline)) INLINE static void hydro_first_init_part(
    struct part *restrict p, struct xpart *restrict xp) {

  p->time_bin = 0;
  p->rho_bar = 0.f;
  p->entropy_one_over_gamma = pow_one_over_gamma(p->entropy);
  xp->v_full[0] = p->v[0];
  xp->v_full[1] = p->v[1];
  xp->v_full[2] = p->v[2];

  hydro_reset_acceleration(p);
506
  hydro_init_part(p, NULL);
507
508
}

509
#endif /* SWIFT_PRESSURE_ENTROPY_HYDRO_H */