gravity.h 6.93 KB
Newer Older
1
2
3
/*******************************************************************************
 * This file is part of SWIFT.
 * Coypright (c) 2015 Matthieu Schaller (matthieu.schaller@durham.ac.uk)
4
 *               2016 Tom Theuns (tom.theuns@durham.ac.uk)
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 *
 * 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/>.
 *
 ******************************************************************************/
20
21
#ifndef SWIFT_DEFAULT_GRAVITY_H
#define SWIFT_DEFAULT_GRAVITY_H
22
23

#include <float.h>
24

lhausamm's avatar
lhausamm committed
25
/* Local includes. */
26
#include "cosmology.h"
27
#include "gravity_properties.h"
28
#include "kernel_gravity.h"
29
#include "minmax.h"
30

31
32
33
34
35
36
37
38
39
40
41
42
/**
 * @brief Returns the mass of a particle
 *
 * @param gp The particle of interest
 */
__attribute__((always_inline)) INLINE static float gravity_get_mass(
    const struct gpart* restrict gp) {

  return gp->mass;
}

/**
43
 * @brief Returns the current co-moving softening of a particle
44
45
 *
 * @param gp The particle of interest
46
 * @param grav_props The global gravity properties.
47
48
 */
__attribute__((always_inline)) INLINE static float gravity_get_softening(
49
    const struct gpart* gp, const struct gravity_props* restrict grav_props) {
50

51
  return grav_props->epsilon_cur;
52
53
54
}

/**
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 * @brief Add a contribution to this particle's potential.
 *
 * Here we do nothing as this version does not accumulate potential.
 *
 * @param gp The particle.
 * @param pot The contribution to add.
 */
__attribute__((always_inline)) INLINE static void
gravity_add_comoving_potential(struct gpart* restrict gp, float pot) {}

/**
 * @brief Returns the comoving potential of a particle.
 *
 * This returns 0 as this flavour of gravity does not compute the
 * particles' potential.
70
71
72
 *
 * @param gp The particle of interest
 */
73
74
__attribute__((always_inline)) INLINE static float
gravity_get_comoving_potential(const struct gpart* restrict gp) {
75

76
  return 0.f;
77
78
}

79
80
81
/**
 * @brief Returns the physical potential of a particle
 *
82
83
84
 * This returns 0 as this flavour of gravity does not compute the
 * particles' potential.
 *
85
86
87
88
89
90
91
 * @param gp The particle of interest.
 * @param cosmo The cosmological model.
 */
__attribute__((always_inline)) INLINE static float
gravity_get_physical_potential(const struct gpart* restrict gp,
                               const struct cosmology* cosmo) {

92
  return 0.f;
93
94
}

95
96
97
/**
 * @brief Computes the gravity time-step of a given particle due to self-gravity
 *
98
99
 * We use Gadget-2's type 0 time-step criterion.
 *
100
 * @param gp Pointer to the g-particle data.
101
 * @param a_hydro The accelerations coming from the hydro scheme (can be 0).
102
 * @param grav_props Constants used in the gravity scheme.
103
 * @param cosmo The current cosmological model.
104
 */
105
__attribute__((always_inline)) INLINE static float
106
gravity_compute_timestep_self(const struct gpart* const gp,
107
                              const float a_hydro[3],
108
109
                              const struct gravity_props* restrict grav_props,
                              const struct cosmology* cosmo) {
110

111
112
113
114
115
116
117
118
119
120
121
122
  /* Get physical acceleration (gravity contribution) */
  float a_phys_x = gp->a_grav[0] * cosmo->a_factor_grav_accel;
  float a_phys_y = gp->a_grav[1] * cosmo->a_factor_grav_accel;
  float a_phys_z = gp->a_grav[2] * cosmo->a_factor_grav_accel;

  /* Get physical acceleration (hydro contribution) */
  a_phys_x += a_hydro[0] * cosmo->a_factor_hydro_accel;
  a_phys_y += a_hydro[1] * cosmo->a_factor_hydro_accel;
  a_phys_z += a_hydro[2] * cosmo->a_factor_hydro_accel;

  const float ac2 =
      a_phys_x * a_phys_x + a_phys_y * a_phys_y + a_phys_z * a_phys_z;
123

Matthieu Schaller's avatar
Matthieu Schaller committed
124
  const float ac_inv = (ac2 > 0.f) ? 1.f / sqrtf(ac2) : FLT_MAX;
125

126
  const float epsilon = gravity_get_softening(gp, grav_props);
127

128
129
  const float dt = sqrtf(2. * kernel_gravity_softening_plummer_equivalent_inv *
                         cosmo->a * grav_props->eta * epsilon * ac_inv);
130
131
132
133

  return dt;
}

134
135
136
137
138
139
140
141
/**
 * @brief Prepares a g-particle for the gravity calculation
 *
 * Zeroes all the relevant arrays in preparation for the sums taking place in
 * the variaous tasks
 *
 * @param gp The particle to act upon
 */
142
__attribute__((always_inline)) INLINE static void gravity_init_gpart(
143
    struct gpart* gp) {
144

145
146
147
148
  /* Zero the acceleration */
  gp->a_grav[0] = 0.f;
  gp->a_grav[1] = 0.f;
  gp->a_grav[2] = 0.f;
149

150
151
152
153
154
155
156
#ifdef SWIFT_GRAVITY_FORCE_CHECKS
  gp->potential_PM = 0.f;
  gp->a_grav_PM[0] = 0.f;
  gp->a_grav_PM[1] = 0.f;
  gp->a_grav_PM[2] = 0.f;
#endif

157
#ifdef SWIFT_DEBUG_CHECKS
158
  gp->num_interacted = 0;
159
  gp->initialised = 1;
160
#endif
161
}
Tom Theuns's avatar
Tom Theuns committed
162

Matthieu Schaller's avatar
Matthieu Schaller committed
163
164
165
/**
 * @brief Finishes the gravity calculation.
 *
166
167
 * Multiplies the forces and accelerations by the appropiate constants.
 * Applies cosmological correction for periodic BCs.
Matthieu Schaller's avatar
Matthieu Schaller committed
168
 *
Matthieu Schaller's avatar
Matthieu Schaller committed
169
170
171
 * No need to apply the potential normalisation correction for periodic
 * BCs here since we do not compute the potential.
 *
Matthieu Schaller's avatar
Matthieu Schaller committed
172
 * @param gp The particle to act upon
173
174
 * @param const_G Newton's constant in internal units.
 * @param potential_normalisation Term to be added to all the particles.
175
 * @param periodic Are we using periodic BCs?
Matthieu Schaller's avatar
Matthieu Schaller committed
176
 */
177
__attribute__((always_inline)) INLINE static void gravity_end_force(
178
179
    struct gpart* gp, float const_G, const float potential_normalisation,
    const int periodic) {
180
181
182
183
184

  /* Let's get physical... */
  gp->a_grav[0] *= const_G;
  gp->a_grav[1] *= const_G;
  gp->a_grav[2] *= const_G;
185
186
187
188
189
190
191

#ifdef SWIFT_GRAVITY_FORCE_CHECKS
  gp->potential_PM *= const_G;
  gp->a_grav_PM[0] *= const_G;
  gp->a_grav_PM[1] *= const_G;
  gp->a_grav_PM[2] *= const_G;
#endif
192
193
194
195

#ifdef SWIFT_DEBUG_CHECKS
  gp->initialised = 0; /* Ready for next step */
#endif
196
}
Matthieu Schaller's avatar
Matthieu Schaller committed
197

198
199
200
201
202
203
204
/**
 * @brief Kick the additional variables
 *
 * @param gp The particle to act upon
 * @param dt The time-step for this kick
 */
__attribute__((always_inline)) INLINE static void gravity_kick_extra(
205
    struct gpart* gp, float dt) {}
206

207
208
209
210
211
212
/**
 * @brief Sets the values to be predicted in the drifts to their values at a
 * kick time
 *
 * @param gp The particle.
 */
213
214
__attribute__((always_inline)) INLINE static void
gravity_reset_predicted_values(struct gpart* gp) {}
215

216
217
218
219
220
221
222
/**
 * @brief Initialises the g-particles for the first time
 *
 * This function is called only once just after the ICs have been
 * read in to do some conversions.
 *
 * @param gp The particle to act upon
223
 * @param grav_props The global properties of the gravity calculation.
224
225
 */
__attribute__((always_inline)) INLINE static void gravity_first_init_gpart(
226
    struct gpart* gp, const struct gravity_props* grav_props) {
227
228
229
230
231
232

  gp->time_bin = 0;

  gravity_init_gpart(gp);
}

233
#endif /* SWIFT_DEFAULT_GRAVITY_H */