Skip to content

Commit 73d79b8

Browse files
author
lgiacome
committed
style: fix several variable names
1 parent 0170501 commit 73d79b8

File tree

2 files changed

+66
-65
lines changed

2 files changed

+66
-65
lines changed

‎pywit/landau_damping.py‎

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -59,23 +59,23 @@ def dispersion_integral_2d(tune_shift: np.ndarray, b_direct: float, b_cross: flo
5959
return -i
6060

6161

62-
def find_detuning_coeffs_threshold(tune_shift: complex, q_s: float, b_direct_ref: float, b_cross_ref: float,
63-
b_direct_add: float = 0, b_cross_add: float = 0,
62+
def find_detuning_coeffs_threshold(tune_shift: complex, q_s: float, reference_b_direct: float, reference_b_cross: float,
63+
added_b_direct: float = 0, added_b_cross: float = 0,
6464
fraction_of_qs_allowed_on_positive_side: float = 0.05,
6565
distribution: str = 'gaussian', tolerance=1e-10):
6666
"""
6767
Compute the detuning coefficients (multiplied by sigma) corresponding to stability diagram threshold for a complex
6868
tune shift.
69-
It keeps fixed the ratio between b_direct_ref and b_cross_ref.
69+
It keeps fixed the ratio between reference_b_direct and reference_b_cross.
7070
:param tune_shift: the tune shift for which the octupole threshold is computed
7171
:param q_s: the synchrotron tune
72-
:param b_direct_ref: the direct detuning coefficient multiplied by sigma (i.e. $\alpha_x \sigma_x$ if working in
72+
:param reference_b_direct: the direct detuning coefficient multiplied by sigma (i.e. $\alpha_x \sigma_x$ if working in
7373
the x plane or $\alpha_y \sigma_y$ if working in the y plane)
74-
:param b_cross_ref: the cross detuning coefficient multiplied by sigma (i.e. $\alpha_{xy} \sigma_y$ if working in
74+
:param reference_b_cross: the cross detuning coefficient multiplied by sigma (i.e. $\alpha_{xy} \sigma_y$ if working in
7575
the x plane or $\alpha_{yx} \sigma_x$ if working in the y plane)
76-
:param b_direct_add: an additional contribution to the direct detuning coefficient which is kept fixed in the
76+
:param added_b_direct: an additional contribution to the direct detuning coefficient which is kept fixed in the
7777
procedure to find the stability threshold
78-
:param b_cross_add: an additional contribution to the cross detuning coefficient which is kept fixed in the
78+
:param added_b_cross: an additional contribution to the cross detuning coefficient which is kept fixed in the
7979
procedure to find the stability threshold
8080
:param distribution: the transverse distribution of the beam. It can be 'gaussian' or 'parabolic'
8181
:param fraction_of_qs_allowed_on_positive_side: to determine azimuthal mode number l_mode (around which is drawn the
@@ -93,13 +93,13 @@ def find_detuning_coeffs_threshold(tune_shift: complex, q_s: float, b_direct_ref
9393
# take away the shift from azimuthal mode number
9494
tune_shift -= q_s * l_mode
9595

96-
b_ratio = b_cross_ref/b_direct_ref
96+
b_ratio = reference_b_cross / reference_b_direct
9797
if tune_shift.imag < 0.:
9898

9999
# function to solve (distance in imag. part w.r.t stab. diagram, as a function of oct. current)
100100
def f(b_direct):
101-
b_direct_i = b_direct + b_direct_add
102-
b_cross_i = b_ratio * b_direct + b_cross_add
101+
b_direct_i = b_direct + added_b_direct
102+
b_cross_i = b_ratio * b_direct + added_b_cross
103103
stab = [-1. / dispersion_integral_2d(t_s, b_direct_i, b_cross_i, distribution=distribution) for e in (-1, 1)
104104
for t_s in b_direct_i * e * 10. ** np.arange(-3, 2, 0.01)[::e]]
105105
# note: one has to reverse the table to get the interpolation right, for negative polarity (np.interp always
@@ -110,10 +110,10 @@ def f(b_direct):
110110
# Newton root finding
111111
try:
112112
# we use 1e-15 as a bound instead of 0 because 0 would cause a divsion by 0 in dispersion_integral_2d
113-
if b_direct_ref > 0:
114-
b_direct_new = bisect(f, 1e-15, 10 * b_direct_ref)
113+
if reference_b_direct > 0:
114+
b_direct_new = bisect(f, 1e-15, 10 * reference_b_direct)
115115
else:
116-
b_direct_new = bisect(f, 100 * b_direct_ref, 1e-15)
116+
b_direct_new = bisect(f, 100 * reference_b_direct, 1e-15)
117117
except RuntimeError:
118118
b_direct_new = np.nan
119119
else:
@@ -132,23 +132,24 @@ def abs_first_item_or_nan(tup: Tuple):
132132
return np.nan
133133

134134

135-
def find_detuning_coeffs_threshold_many_tune_shifts(tune_shifts: Sequence[complex], q_s: float, b_direct_ref: float,
136-
b_cross_ref: float, b_direct_add: float = 0, b_cross_add: float = 0,
135+
def find_detuning_coeffs_threshold_many_tune_shifts(tune_shifts: Sequence[complex], q_s: float,
136+
reference_b_direct: float, reference_b_cross: float,
137+
added_b_direct: float = 0, added_b_cross: float = 0,
137138
distribution: str = 'gaussian',
138139
fraction_of_qs_allowed_on_positive_side: float = 0.05,
139140
tolerance=1e-10):
140141
"""
141142
Compute the detuning coefficients corresponding to the most stringent stability diagram threshold for a sequence of
142-
complex tune shifts. It keeps fixed the ratio between b_direct_ref and b_cross_ref.
143+
complex tune shifts. It keeps fixed the ratio between reference_b_direct and reference_b_cross.
143144
:param tune_shifts: the sequence of complex tune shifts
144145
:param q_s: the synchrotron tune
145-
:param b_direct_ref: the direct detuning coefficient multiplied by sigma (i.e. $\alpha_x \sigma_x$ if working in
146+
:param reference_b_direct: the direct detuning coefficient multiplied by sigma (i.e. $\alpha_x \sigma_x$ if working in
146147
the x plane or $\alpha_y \sigma_y$ if working in the y plane)
147-
:param b_cross_ref: the cross detuning coefficient multiplied by sigma (i.e. $\alpha_{xy} \sigma_y$ if working in
148+
:param reference_b_cross: the cross detuning coefficient multiplied by sigma (i.e. $\alpha_{xy} \sigma_y$ if working in
148149
the x plane or $\alpha_{yx} \sigma_x$ if working in the y plane)
149-
:param b_direct_add: an additional contribution to the direct detuning coefficient which is kept fixed in the
150+
:param added_b_direct: an additional contribution to the direct detuning coefficient which is kept fixed in the
150151
procedure to find the stability threshold
151-
:param b_cross_add: an additional contribution to the cross detuning coefficient which is kept fixed in the
152+
:param added_b_cross: an additional contribution to the cross detuning coefficient which is kept fixed in the
152153
procedure to find the stability threshold
153154
:param distribution: the transverse distribution of the beam. It can be 'gaussian' or 'parabolic'
154155
:param fraction_of_qs_allowed_on_positive_side: to determine azimuthal mode number l_mode (around which is drawn the
@@ -161,8 +162,8 @@ def find_detuning_coeffs_threshold_many_tune_shifts(tune_shifts: Sequence[comple
161162
"""
162163
# find max octupole current required from a list of modes, given their tuneshifts
163164
b_coefficients = np.array([find_detuning_coeffs_threshold(
164-
tune_shift=tune_shift, q_s=q_s, b_direct_ref=b_direct_ref,
165-
b_cross_ref=b_cross_ref, b_direct_add=b_direct_add, b_cross_add=b_cross_add, distribution=distribution,
165+
tune_shift=tune_shift, q_s=q_s, reference_b_direct=reference_b_direct,
166+
reference_b_cross=reference_b_cross, added_b_direct=added_b_direct, added_b_cross=added_b_cross, distribution=distribution,
166167
fraction_of_qs_allowed_on_positive_side=fraction_of_qs_allowed_on_positive_side,
167168
tolerance=tolerance) for tune_shift in tune_shifts if tune_shift is not np.nan])
168169

‎test/test_landau_damping.py‎

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -46,18 +46,18 @@ def test_find_detuning_coeffs_threshold():
4646
q_s = 2e-3
4747
b_direct = 1.980315192200037e-05
4848
b_cross = -1.4139287608495406e-05
49-
assert np.isclose(b_direct, find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s, b_direct_ref=b_direct,
50-
b_cross_ref=b_cross)[0])
51-
assert np.isclose(b_cross, find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s, b_direct_ref=b_direct,
52-
b_cross_ref=b_cross)[1])
49+
assert np.isclose(b_direct, find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s, reference_b_direct=b_direct,
50+
reference_b_cross=b_cross)[0])
51+
assert np.isclose(b_cross, find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s, reference_b_direct=b_direct,
52+
reference_b_cross=b_cross)[1])
5353
# test negative octupole polarity
5454
b_direct = -1.2718161244917965e-05
5555
b_cross = 9.08066253298482e-06
5656

57-
assert np.isclose(b_direct, find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s, b_direct_ref=b_direct,
58-
b_cross_ref=b_cross)[0])
59-
assert np.isclose(b_cross, find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s, b_direct_ref=b_direct,
60-
b_cross_ref=b_cross)[1])
57+
assert np.isclose(b_direct, find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s, reference_b_direct=b_direct,
58+
reference_b_cross=b_cross)[0])
59+
assert np.isclose(b_cross, find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s, reference_b_direct=b_direct,
60+
reference_b_cross=b_cross)[1])
6161

6262

6363
def test_find_detuning_coeffs_threshold_w_added_term():
@@ -68,38 +68,38 @@ def test_find_detuning_coeffs_threshold_w_added_term():
6868
b_direct = 1.980315192200037e-05
6969
b_cross = -1.4139287608495406e-05
7070

71-
frac_add = 1/3
72-
73-
b_direct_add = b_direct * frac_add
74-
b_cross_add = b_cross * frac_add
75-
76-
assert np.isclose(b_direct * (1-frac_add), find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s,
77-
b_direct_ref=b_direct,
78-
b_cross_ref=b_cross,
79-
b_direct_add=b_direct_add,
80-
b_cross_add=b_cross_add)[0])
81-
assert np.isclose(b_cross * (1-frac_add), find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s,
82-
b_direct_ref=b_direct,
83-
b_cross_ref=b_cross,
84-
b_direct_add=b_direct_add,
85-
b_cross_add=b_cross_add)[1])
71+
added_fraction = 1/3
72+
73+
added_b_direct = b_direct * added_fraction
74+
added_b_cross = b_cross * added_fraction
75+
76+
assert np.isclose(b_direct * (1-added_fraction), find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s,
77+
reference_b_direct=b_direct,
78+
reference_b_cross=b_cross,
79+
added_b_direct=added_b_direct,
80+
added_b_cross=added_b_cross)[0])
81+
assert np.isclose(b_cross * (1-added_fraction), find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s,
82+
reference_b_direct=b_direct,
83+
reference_b_cross=b_cross,
84+
added_b_direct=added_b_direct,
85+
added_b_cross=added_b_cross)[1])
8686
# test negative octupole polarity
8787
b_direct = -1.2718161244917965e-05
8888
b_cross = 9.08066253298482e-06
8989

90-
b_direct_add = b_direct * frac_add
91-
b_cross_add = b_cross * frac_add
90+
added_b_direct = b_direct * added_fraction
91+
added_b_cross = b_cross * added_fraction
9292

93-
assert np.isclose(b_direct * (1-frac_add), find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s,
94-
b_direct_ref=b_direct,
95-
b_cross_ref=b_cross,
96-
b_direct_add=b_direct_add,
97-
b_cross_add=b_cross_add)[0])
98-
assert np.isclose(b_cross * (1-frac_add), find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s,
99-
b_direct_ref=b_direct,
100-
b_cross_ref=b_cross,
101-
b_direct_add=b_direct_add,
102-
b_cross_add=b_cross_add)[1])
93+
assert np.isclose(b_direct * (1-added_fraction), find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s,
94+
reference_b_direct=b_direct,
95+
reference_b_cross=b_cross,
96+
added_b_direct=added_b_direct,
97+
added_b_cross=added_b_cross)[0])
98+
assert np.isclose(b_cross * (1-added_fraction), find_detuning_coeffs_threshold(tune_shift=tune_shift, q_s=q_s,
99+
reference_b_direct=b_direct,
100+
reference_b_cross=b_cross,
101+
added_b_direct=added_b_direct,
102+
added_b_cross=added_b_cross)[1])
103103

104104

105105
def test_find_detuning_coeffs_threshold_many_tune_shifts():
@@ -112,17 +112,17 @@ def test_find_detuning_coeffs_threshold_many_tune_shifts():
112112
b_direct = 3.960630384598084e-05
113113
b_cross = -2.8278575218404585e-05
114114
assert np.isclose(b_direct, find_detuning_coeffs_threshold_many_tune_shifts(tune_shifts=tune_shifts, q_s=q_s,
115-
b_direct_ref=b_direct,
116-
b_cross_ref=b_cross)[0])
115+
reference_b_direct=b_direct,
116+
reference_b_cross=b_cross)[0])
117117
assert np.isclose(b_cross, find_detuning_coeffs_threshold_many_tune_shifts(tune_shifts=tune_shifts, q_s=q_s,
118-
b_direct_ref=b_direct,
119-
b_cross_ref=b_cross)[1])
118+
reference_b_direct=b_direct,
119+
reference_b_cross=b_cross)[1])
120120
# test negative octupole polarity
121121
b_direct = -2.5436322491034757e-05
122122
b_cross = 1.816132506682559e-05
123123
assert np.isclose(b_direct, find_detuning_coeffs_threshold_many_tune_shifts(tune_shifts=tune_shifts, q_s=q_s,
124-
b_direct_ref=b_direct,
125-
b_cross_ref=b_cross)[0])
124+
reference_b_direct=b_direct,
125+
reference_b_cross=b_cross)[0])
126126
assert np.isclose(b_cross, find_detuning_coeffs_threshold_many_tune_shifts(tune_shifts=tune_shifts, q_s=q_s,
127-
b_direct_ref=b_direct,
128-
b_cross_ref=b_cross)[1])
127+
reference_b_direct=b_direct,
128+
reference_b_cross=b_cross)[1])

0 commit comments

Comments
 (0)