Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
mhd.hpp
Go to the documentation of this file.
1// -------------------------------------------------------//
2//
3// SHAMROCK code for hydrodynamics
4// Copyright (c) 2021-2026 Timothée David--Cléris <tim.shamrock@proton.me>
5// SPDX-License-Identifier: CeCILL Free Software License Agreement v2.1
6// Shamrock is licensed under the CeCILL 2.1 License, see LICENSE for more information
7//
8// -------------------------------------------------------//
9
10#pragma once
11
19
21#include "shambackends/math.hpp"
22#include "shamcomm/logs.hpp"
27#include "shamphys/mhd.hpp"
28#include <tuple>
29
30namespace shamrock::sph::mhd {
31
32 enum MHDType { Ideal = 0, NonIdeal = 1 };
33
34 template<class Tvec, class Tscal, MHDType mhd_mode = NonIdeal>
35 inline Tvec mag_current_j_sum(
36 Tscal m_b, Tvec B_a, Tvec B_b, Tvec nabla_Wab_ha, Tscal sub_fact_a, Tscal mu_0) {
37
38 // J = curl(B)/mu_0 (mu_0 explicit, SI/Heaviside-Lorentz-like convention, not
39 // Gaussian-cgs 4*pi/c)
40
41 return m_b * sham::inv_sat_zero(sub_fact_a) * sycl::cross(B_a - B_b, nabla_Wab_ha) / mu_0;
42 // return {0., 0., 0.};
43 }
44
45 template<class Tvec, class Tscal, MHDType mhd_mode = NonIdeal>
46 inline Tvec wurster_d(Tvec B, Tvec J, Tscal etaO, Tscal etaH, Tscal etaAD, Tscal mu_0) {
47
48 Tvec Bhat = B * sham::inv_sat_zero(sycl::length(B));
49 Tvec curlB = mu_0 * J; // diffusivities in L^2/T in any unit system
50 Tvec D = etaO * curlB + etaH * sycl::cross(curlB, Bhat)
51 - etaAD * sycl::cross(sycl::cross(curlB, Bhat), Bhat);
52
53 return D;
54 }
55
56 template<class Tvec, class Tscal, MHDType mhd_mode = NonIdeal>
57 inline Tscal u_ni_heating(
58 Tvec B, Tvec J, Tscal rho, Tscal etaO, Tscal etaH, Tscal etaAD, Tscal mu_0) {
59
60 // return sycl::dot(D, J) * sham::inv_sat_zero(rho);
61 // Tscal BdB = sycl::dot(B, B);
62 // Tscal JdJ = sycl::dot(J, J);
63 // Tscal BdJ = sycl::dot(B, J);
64 // Tscal BdJBdJhat = sham::inv_sat_zero(BdB) * BdJ * BdJ;
65
66 // return (etaO * JdJ + etaAD * (JdJ - BdJBdJhat)) * sham::inv_sat_zero(rho); @ to check
67 Tvec D = wurster_d(B, J, etaO, etaH, etaAD, mu_0);
68 return sycl::dot(D, J) * sham::inv_sat_zero(rho);
69 }
70
71 template<class Tvec, class Tscal, MHDType mhd_mode = NonIdeal>
72 inline Tvec b_ni_terms(
73 Tvec D_a,
74 Tvec D_b,
75 Tscal m_b,
76 Tscal rho_a_sq,
77 Tscal rho_b_sq,
78 Tscal omega_a,
79 Tscal omega_b,
80 Tvec nabla_Wab_ha,
81 Tvec nabla_Wab_hb) {
82
83 Tscal sub_fact_a = rho_a_sq * omega_a;
84 Tscal sub_fact_b = rho_b_sq * omega_b;
85
86 Tvec acc_a = sham::inv_sat_zero(sub_fact_a) * (sycl::cross(D_a, nabla_Wab_ha));
87 Tvec acc_b = sham::inv_sat_zero(sub_fact_b) * (sycl::cross(D_b, nabla_Wab_hb));
88 return m_b * (acc_a + acc_b);
89 }
90
91 // not using Whurster D, developping with J. Equivalent to b_ni_terms
92 template<class Tvec, class Tscal, MHDType mhd_mode = NonIdeal>
93 inline Tvec b_ni_ad(
94 Tscal eta_AD,
95 Tvec J_a,
96 Tvec J_b,
97 Tscal m_b,
98 Tscal rho_a_sq,
99 Tscal rho_b_sq,
100 Tvec B_a,
101 Tvec B_b,
102 Tscal omega_a,
103 Tscal omega_b,
104 Tvec nabla_Wab_ha,
105 Tvec nabla_Wab_hb) {
106
107 Tscal sub_fact_a = rho_a_sq * omega_a;
108 Tscal sub_fact_b = rho_b_sq * omega_b;
109
110 Tvec Bhat_a = B_a * sham::inv_sat_zero(sycl::length(B_a));
111 Tvec Bhat_b = B_b * sham::inv_sat_zero(sycl::length(B_b));
112 Tvec JcB_a = sycl::cross(J_a, Bhat_a);
113 Tvec JcB_b = sycl::cross(J_b, Bhat_b);
114
115 Tvec JcBcB_a = sycl::cross(JcB_a, Bhat_a);
116 Tvec JcBcB_b = sycl::cross(JcB_b, Bhat_b);
117
118 Tvec acc_a = sham::inv_sat_zero(sub_fact_a) * eta_AD * sycl::cross(JcBcB_a, nabla_Wab_ha);
119 Tvec acc_b = sham::inv_sat_zero(sub_fact_b) * eta_AD * sycl::cross(JcBcB_b, nabla_Wab_hb);
120 return -m_b * (acc_a + acc_b);
121 }
122
123 // mag tension form the Tricco 2023 formula
124 template<class Tvec, class Tscal>
125 inline Tvec b_dot_grad_w(
126 Tscal m_b,
127 Tscal rho_a_sq,
128 Tscal rho_b_sq,
129 Tvec B_a,
130 Tvec B_b,
131 Tscal omega_a,
132 Tscal omega_b,
133 Tvec nabla_Wab_ha,
134 Tvec nabla_Wab_hb,
135 Tscal mu_0) {
136
137 Tscal sub_fact_a = rho_a_sq * omega_a;
138 Tscal sub_fact_b = rho_b_sq * omega_b;
139
140 Tscal B_dot_grad_W_a = sycl::dot(B_a, nabla_Wab_ha);
141 Tscal B_dot_grad_W_b = sycl::dot(B_b, nabla_Wab_hb);
142
143 Tvec acc_a = ((B_dot_grad_W_a) *sham::inv_sat_zero(sub_fact_a)) * B_a / mu_0;
144 Tvec acc_b = ((B_dot_grad_W_b) *sham::inv_sat_zero(sub_fact_b)) * B_b / mu_0;
145
146 return -m_b * (acc_a + acc_b);
147 }
148
149 // from the Phantom paper formula
150 template<class Tvec, class Tscal, MHDType mhd_mode = Ideal>
151 inline Tvec mag_tension(
152 Tscal m_b,
153 Tvec B_a,
154 Tvec B_b,
155 Tvec nabla_Wab_ha,
156 Tvec nabla_Wab_hb,
157 Tscal sub_fact_a,
158 Tscal sub_fact_b,
159 Tscal mu_0) {
160 Tvec magnetic_tension_term;
161
162 for (int i = 0; i < 3; ++i) {
163 for (int j = 0; j < 3; ++j) {
164
165 Tscal mag_tension_a = -(1. / mu_0) * B_a[i] * B_a[j];
166 Tscal mag_tension_b = -(1. / mu_0) * B_b[i] * B_b[j];
167 Tscal acc_mag_tension_a = mag_tension_a * sham::inv_sat_zero(sub_fact_a);
168 Tscal acc_mag_tension_b = mag_tension_b * sham::inv_sat_zero(sub_fact_b);
169
170 magnetic_tension_term[i] += -m_b
171 * (acc_mag_tension_a * nabla_Wab_ha[j]
172 + acc_mag_tension_b * nabla_Wab_hb[j]);
173 }
174 }
175
176 return magnetic_tension_term;
177 }
178
179 template<class Tvec, class Tscal, MHDType mhd_mode = Ideal>
180 inline Tvec fdiv_b(
181 Tscal m_b,
182 Tvec B_a,
183 Tvec B_b,
184 Tvec nabla_Wab_ha,
185 Tvec nabla_Wab_hb,
186 Tscal sub_fact_a,
187 Tscal sub_fact_b,
188 Tscal mu_0) {
189
190 Tscal acc_fdivB_a = sycl::dot(B_a, nabla_Wab_ha) * sham::inv_sat_zero(sub_fact_a);
191 Tscal acc_fdivB_b = sycl::dot(B_b, nabla_Wab_hb) * sham::inv_sat_zero(sub_fact_b);
192 return -0.5 * B_a * m_b * (acc_fdivB_a + acc_fdivB_b)
193 / mu_0; // tested, this is what works best
194 }
195
196 template<class Tvec, class Tscal>
197 inline Tscal lambda_artes(
198 Tscal m_b,
199 Tscal rho_a_sq,
200 Tscal rho_b_sq,
201 Tscal vsigb,
202 Tvec B_a,
203 Tvec B_b,
204 Tscal omega_a,
205 Tscal omega_b,
206 Tscal Fab_a,
207 Tscal Fab_b) {
208
209 Tscal B_ab_sq = sycl::dot(B_a - B_b, B_a - B_b);
210
211 Tscal sub_fact_a = rho_a_sq * omega_a;
212 Tscal sub_fact_b = rho_b_sq * omega_b;
213
214 Tscal acc_a = Fab_a * sham::inv_sat_zero(sub_fact_a);
215 Tscal acc_b = Fab_b * sham::inv_sat_zero(sub_fact_b);
216
217 Tscal artres = -0.25 * m_b * vsigb * (acc_a + acc_b) * B_ab_sq;
218 return artres;
219 }
220
221 template<class Tvec, class Tscal, MHDType mhd_mode = Ideal>
222 inline Tscal d_b_on_rho_induction_term(
223 Tscal m_b, Tscal rho_a_sq, Tvec B_a, Tscal omega_a, Tvec nabla_Wab_ha) {
224
225 Tscal sub_fact_a = rho_a_sq * omega_a;
226 Tscal induction_term_no_vab
227 = -sham::inv_sat_zero(sub_fact_a) * m_b * sycl::dot(B_a, nabla_Wab_ha);
228
229 return induction_term_no_vab;
230 }
231
232 template<class Tvec, class Tscal, MHDType mhd_mode = Ideal>
233 inline Tvec d_b_on_rho_psi_term(
234 Tscal m_b,
235 Tscal rho_a_sq,
236 Tscal rho_b_sq,
237 Tscal psi_a,
238 Tscal psi_b,
239 Tscal omega_a,
240 Tscal omega_b,
241 Tvec nabla_Wab_ha,
242 Tvec nabla_Wab_hb) {
243
244 Tscal sub_fact_a = rho_a_sq * omega_a;
245 Tscal sub_fact_b = rho_b_sq * omega_b;
246
247 Tvec psisubterm_a = ((psi_a) *sham::inv_sat_zero(sub_fact_a)) * nabla_Wab_ha;
248 Tvec psisubterm_b = ((psi_b) *sham::inv_sat_zero(sub_fact_b)) * nabla_Wab_hb;
249
250 Tvec psiterm = -m_b * (psisubterm_a + psisubterm_b);
251
252 return psiterm;
253 }
254
255 template<class Tvec, class Tscal, MHDType mhd_mode = Ideal>
256 inline Tscal dpsi_on_ch_parabolic_propag(
257 Tscal m_b, Tscal rho_a, Tvec B_a, Tvec B_b, Tscal omega_a, Tvec nabla_Wab_ha, Tscal ch_a) {
258
259 Tscal sub_fact_a = rho_a * omega_a;
260 Tvec B_ab = (B_a - B_b);
261
262 Tscal divB_a = -(1. * sham::inv_sat_zero(sub_fact_a)) * m_b * sycl::dot(B_ab, nabla_Wab_ha);
263
264 Tscal parabolic_propag = m_b * (ch_a * sham::inv_sat_zero(sub_fact_a))
265 * sycl::dot(B_ab, nabla_Wab_ha); //-ch_a * divB_a;
266
267 return parabolic_propag;
268 }
269
270 template<class Tvec, class Tscal, MHDType mhd_mode = Ideal>
271 inline Tscal dpsi_on_ch_parabolic_diff(
272 Tscal m_b,
273 Tscal rho_a,
274 Tvec v_ab,
275 Tscal psi_a,
276 Tscal omega_a,
277 Tvec nabla_Wab_ha,
278 Tscal ch_a) {
279
280 Tscal sub_fact_a = 2. * rho_a * omega_a * ch_a;
281
282 Tscal parabolic_diff
283 = m_b * (psi_a * sham::inv_sat_zero(sub_fact_a)) * sycl::dot(v_ab, nabla_Wab_ha);
284
285 return parabolic_diff;
286 }
287
294 template<class Kernel, class Tvec, class Tscal, MHDType mhd_mode = Ideal>
296 Tscal pmass,
297 Tvec dr,
298 Tscal rab,
299 Tscal rho_a,
300 Tscal rho_a_sq,
301 Tscal rho_b,
302 Tscal omega_a,
303 Tscal omega_b,
304 Tscal Fab_a,
305 Tscal Fab_b,
306 Tvec vxyz_a,
307 Tvec vxyz_b,
308 Tscal cs_a,
309 Tscal cs_b,
310 Tscal h_a,
311 Tscal h_b,
312
313 Tscal alpha_B,
314
315 Tvec B_a,
316 Tvec B_b,
317
318 Tvec J_a,
319 Tvec J_b,
320
321 Tscal psi_a,
322 Tscal psi_b,
323
324 Tscal mu_0,
325 Tscal sigma_mhd,
326
327 Tscal etaO,
328 Tscal etaH,
329 Tscal etaAD,
330
331 Tvec &dv_dt,
332 Tscal &du_dt,
333 Tvec &dB_on_rho_dt,
334 Tscal &dpsi_on_ch_dt,
335 Tscal &drho_dt,
336
337 Tvec &mag_pressure,
338 Tvec &mag_tension,
339 Tvec &tensile_corr,
340
341 Tscal &psi_propag,
342 Tscal &psi_diff,
343 Tscal &psi_cons) {
344
345 using namespace shamrock::sph;
346
347 Tvec v_ab = vxyz_a - vxyz_b;
348 Tvec r_ab_unit = dr * sham::inv_sat_positive(rab);
349
350 Tscal dWab_a = Fab_a;
351 Tscal dWab_b = Fab_b;
352
353 Tscal sub_fact_a = rho_a_sq * omega_a;
354 Tscal sub_fact_b = rho_b * rho_b * omega_b;
355
356 Tscal v_shock_a = shamphys::MHD_physics<Tvec, Tscal>::v_shock(cs_a, B_a, rho_a, mu_0);
357 Tscal v_shock_b = shamphys::MHD_physics<Tvec, Tscal>::v_shock(cs_b, B_b, rho_b, mu_0);
358 Tscal vsig_B = shamphys::MHD_physics<Tvec, Tscal>::vsigB(v_ab, r_ab_unit);
359
360 Tvec sum_mag_tension{}, sum_fdivB{};
361 Tscal sum_psi_propag{}, sum_psi_diff{};
362
363 // (gas_pressure_pishock, pressure_term, viscous_heating & shock_conductivity are added by
364 // the hydro update derivs)
365 // dv/dt += magnetic_pressure_term + sum_mag_tension + sum_fdivB;
366 // du/dt += artificial_resistivity;
367 // d(B/rho)/dt = induction_term + psi_term + dissipation_term
368 // d(psi/ch)/dt = psi_propag + psi_diff + psi_cons (not in the SPH sum, hence added in
369 // update_derivs)
370
371 // dv/dt terms
372 sum_fdivB += fdiv_b(
373 pmass, B_a, B_b, r_ab_unit * dWab_a, r_ab_unit * dWab_b, sub_fact_a, sub_fact_b, mu_0);
374
375 sum_mag_tension += -b_dot_grad_w(
376 pmass,
377 rho_a_sq,
378 rho_b * rho_b,
379 B_a,
380 B_b,
381 omega_a,
382 omega_b,
383 r_ab_unit * dWab_a,
384 r_ab_unit * dWab_b,
385 mu_0);
386
387 Tvec magnetic_pressure_term = (1. / (2 * mu_0))
389 pmass,
390 rho_a_sq,
391 rho_b * rho_b,
392 sycl::dot(B_a, B_a),
393 sycl::dot(B_b, B_b),
394 omega_a,
395 omega_b,
396 r_ab_unit * dWab_a,
397 r_ab_unit * dWab_b);
398
399 dv_dt += magnetic_pressure_term + sum_mag_tension + sum_fdivB;
400 // end dv/dt terms
401
402 // get terms for debugging
403 mag_pressure += magnetic_pressure_term;
404 mag_tension += sum_mag_tension;
405 tensile_corr += sum_fdivB;
406 // end get terms for debugging
407
408 // du/dt terms
409 du_dt += alpha_B
410 * lambda_artes(
411 pmass,
412 rho_a_sq,
413 rho_b * rho_b,
414 vsig_B,
415 B_a,
416 B_b,
417 omega_a,
418 omega_b,
419 Fab_a,
420 Fab_b);
421
422 // end du/dt terms
423
424 // d(B/rho)/dt terms
425 Tscal rho_diss_term_a = Fab_a * sham::inv_sat_zero(sub_fact_a);
426 Tscal rho_diss_term_b = Fab_b * sham::inv_sat_zero(sub_fact_b);
427
428 Tvec dB_on_rho_dissipation_term
429 = 0.5 * pmass * (rho_diss_term_a + rho_diss_term_b) * (B_a - B_b) * vsig_B;
430
431 dB_on_rho_dt += v_ab
432 * d_b_on_rho_induction_term(
433 pmass, rho_a_sq, B_a, omega_a, r_ab_unit * dWab_a); // @@@ dWab_b ?
434
435 dB_on_rho_dt += d_b_on_rho_psi_term(
436 pmass,
437 rho_a_sq,
438 rho_b * rho_b,
439 psi_a,
440 psi_b,
441 omega_a,
442 omega_b,
443 r_ab_unit * dWab_a,
444 r_ab_unit * dWab_b);
445
446 dB_on_rho_dt += alpha_B * dB_on_rho_dissipation_term;
447
448 // end d(B/rho)/dt terms
449
450 // d(psi/ch)/dt terms
451 sum_psi_propag = dpsi_on_ch_parabolic_propag(
452 pmass, rho_a, B_a, B_b, omega_a, r_ab_unit * dWab_a, v_shock_a);
453
454 sum_psi_diff = dpsi_on_ch_parabolic_diff(
455 pmass, rho_a, v_ab, psi_a, omega_a, r_ab_unit * dWab_a, v_shock_a);
456
457 dpsi_on_ch_dt += sum_psi_propag;
458 dpsi_on_ch_dt += sum_psi_diff;
459
460 // end d(psi/ch)/dt terms
461
462 // get debugging terms
463 psi_propag += sum_psi_propag;
464 psi_diff += sum_psi_diff;
465 // end get debugging terms
466
467 // for conservative checks
468 drho_dt += (1. / omega_a) * pmass * sycl::dot(v_ab, r_ab_unit * dWab_a);
469
470 // Non-ideal MHD terms
471 if constexpr (mhd_mode == NonIdeal) {
472
473 Tvec D_a = wurster_d<Tvec, Tscal, mhd_mode>(B_a, J_a, etaO, etaH, etaAD, mu_0);
474 Tvec D_b = wurster_d<Tvec, Tscal, mhd_mode>(B_b, J_b, etaO, etaH, etaAD, mu_0);
475
476 Tvec B_NI = b_ni_terms<Tvec, Tscal, mhd_mode>(
477 D_a,
478 D_b,
479 pmass,
480 rho_a_sq,
481 rho_b * rho_b,
482 omega_a,
483 omega_b,
484 r_ab_unit * dWab_a,
485 r_ab_unit * dWab_b);
486
487 dB_on_rho_dt += B_NI;
488
489 // Tvec B_NI_ADterm = b_ni_ad<Tvec, Tscal, mhd_mode>(
490 // etaAD,
491 // J_a,
492 // J_b,
493 // pmass,
494 // rho_a_sq,
495 // rho_b * rho_b,
496 // B_a,
497 // B_b,
498 // omega_a,
499 // omega_b,
500 // r_ab_unit * dWab_a,
501 // r_ab_unit * dWab_b);
502
503 // dB_on_rho_dt += B_NI_ADterm;
504
505 // Tscal u_NI = u_ni_heating<Tvec, Tscal, mhd_mode>(B_a, J_a, rho_a, etaO, etaAD) * 0.5
506 // + u_ni_heating<Tvec, Tscal, mhd_mode>(B_b, J_b, rho_b, etaO, etaAD) *
507 // 0.5;
508 }
509 }
510
511} // namespace shamrock::sph::mhd
constexpr Unit mu_0
vacuum permeability
T inv_sat_positive(T v, T minvsat=T{1e-9}, T satval=T{0.}) noexcept
inverse saturated (positive numbers only)
Definition math.hpp:841
T inv_sat_zero(T v, T satval=T{0.}) noexcept
inverse saturated (zero version)
Definition math.hpp:870
void add_to_derivs_spmhd(Tscal pmass, Tvec dr, Tscal rab, Tscal rho_a, Tscal rho_a_sq, Tscal rho_b, Tscal omega_a, Tscal omega_b, Tscal Fab_a, Tscal Fab_b, Tvec vxyz_a, Tvec vxyz_b, Tscal cs_a, Tscal cs_b, Tscal h_a, Tscal h_b, Tscal alpha_B, Tvec B_a, Tvec B_b, Tvec J_a, Tvec J_b, Tscal psi_a, Tscal psi_b, Tscal mu_0, Tscal sigma_mhd, Tscal etaO, Tscal etaH, Tscal etaAD, Tvec &dv_dt, Tscal &du_dt, Tvec &dB_on_rho_dt, Tscal &dpsi_on_ch_dt, Tscal &drho_dt, Tvec &mag_pressure, Tvec &mag_tension, Tvec &tensile_corr, Tscal &psi_propag, Tscal &psi_diff, Tscal &psi_cons)
Add the pure MHD terms of the pair (a,b) to the derivatives of particle a.
Definition mhd.hpp:295
file containing formulas for sph forces
Tvec sph_pressure_symetric(const Tscal &m_b, const Tscal &rho_a_sq, const Tscal &rho_b_sq, const Tscal &P_a, const Tscal &P_b, const Tscal &omega_a, const Tscal &omega_b, const Tvec &nabla_Wab_ha, const Tvec &nabla_Wab_hb)
phantom_2018 eq.34, with
Definition forces.hpp:60