Note
Go to the end to download the full example code.
Dustywave TVA dispersion relation#
This example shows how to derive the dustywave TVA dispersion relation using SymPy
8 import os
9
10 import matplotlib.pyplot as plt
11 import numpy as np
12 import sympy as sp
Usefull symbols
16 omega = sp.symbols(r"\omega", complex=True)
17
18 k, cs, ts, eps = sp.symbols(
19 r"k c_s t_s \epsilon",
20 positive=True,
21 real=True,
22 )
23
24 i = sp.I # imaginary unit
25
26 a = k * cs # s^-1
27 b = a**2 * ts * eps # s^-1
The perturbation matrix is M = K(omega = 0) The eigenfrequencies are the roots of det(M + i omega I) = 0
33 K = sp.Matrix(
34 [
35 [i * omega, 0, -i * a],
36 [b * (1 - eps), i * omega - b, 0],
37 [-i * a * (1 - eps), i * a, i * omega],
38 ]
39 ) # s^-1
Compute the determinant
44 det = sp.factor(K.det())
45 print(sp.latex(det))
\omega \left(\epsilon \omega c_{s}^{2} k^{2} t_{s} - i \epsilon c_{s}^{2} k^{2} - i \omega^{2} + i c_{s}^{2} k^{2}\right)
Let’s remove the leading omega mode (omega = 0)
49 det /= i * omega
50 det = sp.simplify(det)
51 det = sp.collect(det, omega)
52 print(sp.latex(det))
- i \epsilon \omega c_{s}^{2} k^{2} t_{s} - \epsilon c_{s}^{2} k^{2} - \omega^{2} + c_{s}^{2} k^{2}
Find the roots of the dispersion relation
56 r1, r2 = sp.solve(sp.Eq(det, 0), omega)
57 print(sp.latex(r1))
58 print(sp.latex(r2))
59
60 print(r1)
61 print(r2)
\frac{c_{s} k \left(- i \epsilon c_{s} k t_{s} - \sqrt{- \epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} - 4 \epsilon + 4}\right)}{2}
\frac{c_{s} k \left(- i \epsilon c_{s} k t_{s} + \sqrt{- \epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} - 4 \epsilon + 4}\right)}{2}
c_s*k*(-I*\epsilon*c_s*k*t_s - sqrt(-\epsilon**2*c_s**2*k**2*t_s**2 - 4*\epsilon + 4))/2
c_s*k*(-I*\epsilon*c_s*k*t_s + sqrt(-\epsilon**2*c_s**2*k**2*t_s**2 - 4*\epsilon + 4))/2
Function to plot the roots
66 def get_roots(_r1, _r2, k_list, eps_value, cs_value, ts_value):
67
68 # Substitute all parameters
69 r1_num = _r1.subs({cs: cs_value, ts: ts_value, eps: eps_value})
70
71 r2_num = _r2.subs({cs: cs_value, ts: ts_value, eps: eps_value})
72
73 r1_num_re = sp.re(r1_num)
74 r1_num_im = sp.im(r1_num)
75 r2_num_re = sp.re(r2_num)
76 r2_num_im = sp.im(r2_num)
77
78 # Lambdify only k remains
79 r1_re_func = sp.lambdify(k, r1_num_re, modules="numpy")
80 r1_im_func = sp.lambdify(k, r1_num_im, modules="numpy")
81 r2_re_func = sp.lambdify(k, r2_num_re, modules="numpy")
82 r2_im_func = sp.lambdify(k, r2_num_im, modules="numpy")
83
84 # Evaluate
85 r1_vals_re = r1_re_func(k_list)
86 r1_vals_im = r1_im_func(k_list)
87 r2_vals_re = r2_re_func(k_list)
88 r2_vals_im = r2_im_func(k_list)
89
90 def restore(lst):
91 # if it is not a numpy array return a np.zeros_like(k_list)
92 if not isinstance(lst, np.ndarray):
93 return np.zeros_like(k_list)
94 return lst
95
96 r1_vals_re = restore(r1_vals_re)
97 r1_vals_im = restore(r1_vals_im)
98 r2_vals_re = restore(r2_vals_re)
99 r2_vals_im = restore(r2_vals_im)
100
101 return r1_vals_re, r1_vals_im, r2_vals_re, r2_vals_im
102
103
104 def get_roots_LP14(k_list, eps_value, cs_value, ts_value):
105 _r1 = +cs * sp.sqrt(1 - eps) * k - i * ts * k**2 * cs**2 * eps / 2
106 _r2 = -cs * sp.sqrt(1 - eps) * k - i * ts * k**2 * cs**2 * eps / 2
107
108 return get_roots(_r1, _r2, k_list, eps_value, cs_value, ts_value)
109
110
111 def get_overroots_DCL26_simple(k_list, eps_value, cs_value, ts_value):
112 _r1 = +cs * sp.sqrt(1 - eps) * k + i * k**2 * cs**2 * eps * ts * (-1 + 1) / 2
113 _r2 = -cs * sp.sqrt(1 - eps) * k + i * k**2 * cs**2 * eps * ts * (-1 - 1) / 2
114
115 return get_roots(_r1, _r2, k_list, eps_value, cs_value, ts_value)
116
117
118 def get_overroots_DCL26(k_list, eps_value, cs_value, ts_value):
119 D = 4 * (1 - eps) - eps**2 * cs**2 * ts**2 * k**2
120
121 sqrtD_real = sp.sqrt(sp.Max(D, 0))
122 sqrtD_imag = sp.sqrt(sp.Max(-D, 0))
123
124 _r1 = cs * k / 2 * (+sqrtD_real + i * (sqrtD_imag - eps * cs * k * ts))
125
126 _r2 = cs * k / 2 * (-sqrtD_real + i * (-sqrtD_imag - eps * cs * k * ts))
127
128 print(sp.latex(sp.Abs(_r1)))
129 print(sp.latex(sp.Abs(_r2)))
130
131 return get_roots(_r1, _r2, k_list, eps_value, cs_value, ts_value)
132
133
134 def plot_case(k_plot, eps_value, cs_value, ts_value):
135
136 r1_vals_re, r1_vals_im, r2_vals_re, r2_vals_im = get_roots(
137 r1, r2, k_plot, eps_value, cs_value, ts_value
138 )
139
140 r1_vals_re_LP14, r1_vals_im_LP14, r2_vals_re_LP14, r2_vals_im_LP14 = get_roots_LP14(
141 k_plot, eps_value, cs_value, ts_value
142 )
143
144 (
145 r1_vals_re_DCL26_simple,
146 r1_vals_im_DCL26_simple,
147 r2_vals_re_DCL26_simple,
148 r2_vals_im_DCL26_simple,
149 ) = get_overroots_DCL26_simple(k_plot, eps_value, cs_value, ts_value)
150 r1_vals_re_DCL26, r1_vals_im_DCL26, r2_vals_re_DCL26, r2_vals_im_DCL26 = get_overroots_DCL26(
151 k_plot, eps_value, cs_value, ts_value
152 )
153
154 # Create figure
155 fig, axs = plt.subplots(2, 2, figsize=(6, 6), sharex=True)
156
157 # Real parts
158 axs[0, 0].plot(k_plot, r1_vals_re, color="0", linewidth=2, label=r"Re($\omega_+$)")
159 axs[0, 0].plot(k_plot, r2_vals_re, color="0", linewidth=2, label=r"Re($\omega_-$)")
160 axs[0, 0].plot(k_plot, r1_vals_re_LP14, "--", label=r"Re($\omega_{+,LP14}$)")
161 axs[0, 0].plot(k_plot, r2_vals_re_LP14, "--", label=r"Re($\omega_{-,LP14}$)")
162 axs[0, 0].plot(
163 k_plot, r1_vals_re_DCL26_simple, linestyle="dotted", label=r"Re($\omega_{+,approx}$)"
164 )
165 axs[0, 0].plot(
166 k_plot, r2_vals_re_DCL26_simple, linestyle="dotted", label=r"Re($\omega_{-,approx}$)"
167 )
168 # axs[0,0].plot(k_plot, r1_vals_re_DCL26,"--", label="Re($r_1$) DCL26")
169 # axs[0,0].plot(k_plot, r2_vals_re_DCL26,"--", label="Re($r_2$) DCL26")
170 axs[0, 0].set_ylabel("Real part")
171 axs[0, 0].grid(True)
172 axs[0, 0].legend()
173
174 # Imaginary parts
175 axs[0, 1].plot(k_plot, r1_vals_im, color="0", linewidth=2, label=r"Im($\omega_+$)")
176 axs[0, 1].plot(k_plot, r2_vals_im, color="0", linewidth=2, label=r"Im($\omega_-$)")
177 axs[0, 1].plot(k_plot, r1_vals_im_LP14, "--", label=r"Im($\omega_{+,LP14}$)")
178 axs[0, 1].plot(k_plot, r2_vals_im_LP14, "--", label=r"Im($\omega_{-,LP14}$)")
179 axs[0, 1].plot(
180 k_plot, r1_vals_im_DCL26_simple, linestyle="dotted", label=r"Im($\omega_{+,approx}$)"
181 )
182 axs[0, 1].plot(
183 k_plot, r2_vals_im_DCL26_simple, linestyle="dotted", label=r"Im($\omega_{-,approx}$)"
184 )
185 # axs[0,1].plot(k_plot, r1_vals_im_DCL26,"--", label="Im($r_1$) DCL26")
186 # axs[0,1].plot(k_plot, r2_vals_im_DCL26,"--", label="Im($r_2$) DCL26")
187 axs[0, 1].set_xlabel("$k$")
188 axs[0, 1].set_ylabel("Imaginary part")
189 axs[0, 1].grid(True)
190 axs[0, 1].legend()
191
192 # Abs
193 r1_vals_abs = np.sqrt(r1_vals_re**2 + r1_vals_im**2)
194 r2_vals_abs = np.sqrt(r2_vals_re**2 + r2_vals_im**2)
195 r1_vals_abs_LP14 = np.sqrt(r1_vals_re_LP14**2 + r1_vals_im_LP14**2)
196 r2_vals_abs_LP14 = np.sqrt(r2_vals_re_LP14**2 + r2_vals_im_LP14**2)
197 r1_vals_abs_DCL26_simple = np.sqrt(r1_vals_re_DCL26_simple**2 + r1_vals_im_DCL26_simple**2)
198 r2_vals_abs_DCL26_simple = np.sqrt(r2_vals_re_DCL26_simple**2 + r2_vals_im_DCL26_simple**2)
199 r1_vals_abs_DCL26 = np.sqrt(r1_vals_re_DCL26**2 + r1_vals_im_DCL26**2)
200 r2_vals_abs_DCL26 = np.sqrt(r2_vals_re_DCL26**2 + r2_vals_im_DCL26**2)
201 axs[1, 0].plot(k_plot, r1_vals_abs, color="0", linewidth=2, label=r"Abs($\omega_+$)")
202 axs[1, 0].plot(k_plot, r2_vals_abs, color="0", linewidth=2, label=r"Abs($\omega_-$)")
203 axs[1, 0].plot(k_plot, r1_vals_abs_LP14, "--", label=r"Abs($\omega_{+,LP14}$)")
204 axs[1, 0].plot(k_plot, r2_vals_abs_LP14, "--", label=r"Abs($\omega_{-,LP14}$)")
205 axs[1, 0].plot(
206 k_plot, r1_vals_abs_DCL26_simple, linestyle="dotted", label=r"Abs($\omega_{+,approx}$)"
207 )
208 axs[1, 0].plot(
209 k_plot, r2_vals_abs_DCL26_simple, linestyle="dotted", label=r"Abs($\omega_{-,approx}$)"
210 )
211
212 def approx(_k, _cs, _ts, _eps):
213 print(type(_k), type(_cs), type(_ts), type(_eps))
214 return _cs * _k * np.sqrt((1 - _eps) + (_k * _cs * _ts * _eps) ** 2)
215
216 axs[1, 0].plot(
217 k_plot,
218 approx(k_plot, cs_value, ts_value, eps_value),
219 "--",
220 label=r"$max(\vert \omega_{\pm,approx} \vert)$",
221 )
222
223 # axs[1,0].plot(k_plot, r1_vals_abs_DCL26,"--", label="Abs($r_1$) DCL26")
224 # axs[1,0].plot(k_plot, r2_vals_abs_DCL26,"--", label="Abs($r_2$) DCL26")
225 axs[1, 0].set_xlabel("$k$")
226 axs[1, 0].set_ylabel("Abs part")
227 axs[1, 0].grid(True)
228 axs[1, 0].legend()
229
230 # delta with max
231 r_max = np.maximum(r1_vals_abs, r2_vals_abs)
232 r_max_LP14 = np.maximum(r1_vals_abs_LP14, r2_vals_abs_LP14)
233 r_max_DCL26_simple = np.maximum(r1_vals_abs_DCL26_simple, r2_vals_abs_DCL26_simple)
234 r_max_DCL26 = np.maximum(r1_vals_abs_DCL26, r2_vals_abs_DCL26)
235 axs[1, 1].plot(k_plot, (r_max_LP14 - r_max) / r_max, label="Analytic - LP14")
236 axs[1, 1].plot(k_plot, (r_max_DCL26_simple - r_max) / r_max, label="Analytic - approx")
237 # axs[1,1].plot(k_plot, (r_max_DCL26 - r_max) / r_max, label="Ana - DCL26")
238 axs[1, 1].set_xlabel("$k$")
239 axs[1, 1].set_ylabel("Abs(Ana) - Abs(Max model) / Abs(Ana)")
240 axs[1, 1].grid(True)
241 axs[1, 1].legend()
242
243 plt.suptitle(f"eps = {eps_value}, cs = {cs_value}, ts = {ts_value}")
244
245 plt.tight_layout()
246
247 # Create figure
248 fig, axs = plt.subplots(2, 1, figsize=(4, 6), sharex=True)
249
250 # Abs
251 r1_vals_abs = np.sqrt(r1_vals_re**2 + r1_vals_im**2)
252 r2_vals_abs = np.sqrt(r2_vals_re**2 + r2_vals_im**2)
253 r1_vals_abs_LP14 = np.sqrt(r1_vals_re_LP14**2 + r1_vals_im_LP14**2)
254 r2_vals_abs_LP14 = np.sqrt(r2_vals_re_LP14**2 + r2_vals_im_LP14**2)
255 r1_vals_abs_DCL26_simple = np.sqrt(r1_vals_re_DCL26_simple**2 + r1_vals_im_DCL26_simple**2)
256 r2_vals_abs_DCL26_simple = np.sqrt(r2_vals_re_DCL26_simple**2 + r2_vals_im_DCL26_simple**2)
257 r1_vals_abs_DCL26 = np.sqrt(r1_vals_re_DCL26**2 + r1_vals_im_DCL26**2)
258 r2_vals_abs_DCL26 = np.sqrt(r2_vals_re_DCL26**2 + r2_vals_im_DCL26**2)
259 (line_ana,) = axs[0].plot(
260 k_plot, r1_vals_abs, color="0", linewidth=2, label=r"Abs($\omega_\pm$)"
261 )
262 axs[0].plot(k_plot, r2_vals_abs, color=line_ana.get_color(), linewidth=2)
263 (line_lp14,) = axs[0].plot(k_plot, r1_vals_abs_LP14, "--", label=r"Abs($\omega_{\pm,LP14}$)")
264 axs[0].plot(k_plot, r2_vals_abs_LP14, "--", color=line_lp14.get_color())
265 (line_approx,) = axs[0].plot(
266 k_plot,
267 r1_vals_abs_DCL26_simple,
268 label=r"Abs($\omega_{\pm,approx}$)",
269 alpha=0.7,
270 )
271 axs[0].plot(
272 k_plot,
273 r2_vals_abs_DCL26_simple,
274 color=line_approx.get_color(),
275 alpha=0.7,
276 )
277
278 # axs[1,0].plot(k_plot, r1_vals_abs_DCL26,"--", label="Abs($r_1$) DCL26")
279 # axs[1,0].plot(k_plot, r2_vals_abs_DCL26,"--", label="Abs($r_2$) DCL26")
280 axs[0].set_xlabel("$k$")
281 axs[0].set_ylabel("Abs part")
282 axs[0].grid(True)
283 axs[0].legend()
284
285 # delta with max
286 r_max = np.maximum(r1_vals_abs, r2_vals_abs)
287 r_max_LP14 = np.maximum(r1_vals_abs_LP14, r2_vals_abs_LP14)
288 r_max_DCL26_simple = np.maximum(r1_vals_abs_DCL26_simple, r2_vals_abs_DCL26_simple)
289 r_max_DCL26 = np.maximum(r1_vals_abs_DCL26, r2_vals_abs_DCL26)
290 delta_LP14 = (r_max_LP14 - r_max) / r_max
291 delta_DCL26_simple = (r_max_DCL26_simple - r_max) / r_max
292 axs[1].plot(k_plot, delta_LP14, label="LP14")
293 axs[1].plot(k_plot, delta_DCL26_simple, label="approx")
294 # axs[1,1].plot(k_plot, (r_max_DCL26 - r_max) / r_max, label="Ana - DCL26")
295 axs[1].set_xlabel("$k$")
296 axs[1].set_ylabel(
297 r"$(\vert \omega_{ana} \vert_{\rm max} - \vert \omega_{model} \vert_{\rm max} )/ \vert \omega_{ana} \vert_{\rm max}$"
298 )
299 axs[1].grid(True)
300 axs[1].legend()
301 ymin, ymax = axs[1].get_ylim()
302 axs[1].axhspan(ymin=min(ymin, 0) * 10, ymax=0, facecolor="red", alpha=0.15, zorder=0)
303 axs[1].text(
304 0.05,
305 0.05,
306 "CFL underestimated",
307 transform=axs[1].transAxes,
308 ha="left",
309 va="bottom",
310 color="red",
311 fontsize=9,
312 )
313 plt.ylim(ymin, ymax)
314 plt.suptitle(rf"$\epsilon = {eps_value}, c_s = {cs_value}, t_s = {ts_value}$")
315
316 plt.tight_layout()
317 os.makedirs("_to_trash", exist_ok=True)
318 plt.savefig(f"_to_trash/dustywave_sympy_eps_{eps_value}_cs_{cs_value}_ts_{ts_value}.pdf")
Plot the case eps = 0.5, cs = 1.0, ts = 1.0
323 k_plot = np.linspace(0, 5, 1000)
324 plot_case(k_plot, 0.5, 1.0, 1.0)
325 plt.show()
\frac{c_{s} k \sqrt{\epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} - 2 \epsilon c_{s} k t_{s} \sqrt{\max\left(0, \epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} + 4 \epsilon - 4\right)} + \max\left(0, - \epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} - 4 \epsilon + 4\right) + \max\left(0, \epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} + 4 \epsilon - 4\right)}}{2}
\frac{c_{s} k \sqrt{\epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} + 2 \epsilon c_{s} k t_{s} \sqrt{\max\left(0, \epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} + 4 \epsilon - 4\right)} + \max\left(0, - \epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} - 4 \epsilon + 4\right) + \max\left(0, \epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} + 4 \epsilon - 4\right)}}{2}
<class 'numpy.ndarray'> <class 'float'> <class 'float'> <class 'float'>
/work/doc/sphinx/examples/physics/run_dustywave_sympy.py:235: RuntimeWarning: invalid value encountered in divide
axs[1, 1].plot(k_plot, (r_max_LP14 - r_max) / r_max, label="Analytic - LP14")
/work/doc/sphinx/examples/physics/run_dustywave_sympy.py:236: RuntimeWarning: invalid value encountered in divide
axs[1, 1].plot(k_plot, (r_max_DCL26_simple - r_max) / r_max, label="Analytic - approx")
/work/doc/sphinx/examples/physics/run_dustywave_sympy.py:290: RuntimeWarning: invalid value encountered in divide
delta_LP14 = (r_max_LP14 - r_max) / r_max
/work/doc/sphinx/examples/physics/run_dustywave_sympy.py:291: RuntimeWarning: invalid value encountered in divide
delta_DCL26_simple = (r_max_DCL26_simple - r_max) / r_max
Plot the case eps = 0.1, cs = 1.0, ts = 1.0
330 k_plot = np.linspace(0, 40, 1000)
331 plot_case(k_plot, 0.1, 1.0, 1.0)
332 plt.show()
\frac{c_{s} k \sqrt{\epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} - 2 \epsilon c_{s} k t_{s} \sqrt{\max\left(0, \epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} + 4 \epsilon - 4\right)} + \max\left(0, - \epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} - 4 \epsilon + 4\right) + \max\left(0, \epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} + 4 \epsilon - 4\right)}}{2}
\frac{c_{s} k \sqrt{\epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} + 2 \epsilon c_{s} k t_{s} \sqrt{\max\left(0, \epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} + 4 \epsilon - 4\right)} + \max\left(0, - \epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} - 4 \epsilon + 4\right) + \max\left(0, \epsilon^{2} c_{s}^{2} k^{2} t_{s}^{2} + 4 \epsilon - 4\right)}}{2}
<class 'numpy.ndarray'> <class 'float'> <class 'float'> <class 'float'>
/work/doc/sphinx/examples/physics/run_dustywave_sympy.py:235: RuntimeWarning: invalid value encountered in divide
axs[1, 1].plot(k_plot, (r_max_LP14 - r_max) / r_max, label="Analytic - LP14")
/work/doc/sphinx/examples/physics/run_dustywave_sympy.py:236: RuntimeWarning: invalid value encountered in divide
axs[1, 1].plot(k_plot, (r_max_DCL26_simple - r_max) / r_max, label="Analytic - approx")
/work/doc/sphinx/examples/physics/run_dustywave_sympy.py:290: RuntimeWarning: invalid value encountered in divide
delta_LP14 = (r_max_LP14 - r_max) / r_max
/work/doc/sphinx/examples/physics/run_dustywave_sympy.py:291: RuntimeWarning: invalid value encountered in divide
delta_DCL26_simple = (r_max_DCL26_simple - r_max) / r_max
Total running time of the script: (0 minutes 4.113 seconds)
Estimated memory usage: 218 MB



