tkfermi_python.py ダウンロード/コピー
tkfermi_python.py
tkfermi_python.py
1"""
2概要:
3 高速でロバストなフェルミ・ディラック積分ライブラリです。
4詳細説明:
5 一般的な r > -1 に対応しており、r = 1/2 と 3/2 には専用の最適化パスがあります。
6 eta >= 20 の場合は縮退展開を使用し、eta < -0.1 の場合は非縮退交替級数を使用します。
7 中間領域では z = x^2 変換と数値積分を使用します。Python 3.12 で安全に動作します。
8"""
9
10from math import exp, gamma
11from functools import lru_cache
12from scipy import integrate
13
14
15# ============================================================
16# internal: integrand (z = x^2)
17# ============================================================
18
19def _func_Fr_x2(x, eta, r):
20 """
21 概要:
22 z = x^2 変換を用いた数値積分用の被積分関数です。
23 引数:
24 :param x: 積分変数
25 :type x: float
26 :param eta: 規格化化学ポテンシャル
27 :type eta: float
28 :param r: 次数
29 :type r: float
30 戻り値:
31 :returns: 被積分関数の値
32 :rtype: float
33 """
34 if x > 26.0:
35 return 0.0
36 return 2.0 * x ** (2.0 * r + 1.0) / (exp(x * x - eta) + 1.0)
37
38
39# ============================================================
40# internal: degenerate limit (Sommerfeld-like)
41# ============================================================
42
43_DegenerateFD_z = (
44 0.822467, 0.947033, 0.985551, 0.996233, 0.999040,
45 0.999758, 0.999939, 0.999985, 0.999996, 0.999999
46)
47
48def _DegenerateFermiDirac(eta, r):
49 """
50 概要:
51 縮退限界におけるフェルミ・ディラック積分を計算します。
52 詳細説明:
53 eta が大きい領域でゾンマーフェルト展開に似た手法を用いて計算します。
54 引数:
55 :param eta: 規格化化学ポテンシャル
56 :type eta: float
57 :param r: 次数
58 :type r: float
59 戻り値:
60 :returns: 積分値
61 :rtype: float
62 """
63 gi = eta ** (r + 1.0) / (r + 1.0)
64 t = r
65 gg = t / (eta * eta)
66 gs = gg * _DegenerateFD_z[0]
67 t -= 1.0
68
69 for k in range(1, 10):
70 gg *= t * (t - 1.0) / (eta * eta)
71 gs += gg * _DegenerateFD_z[k]
72 t -= 2.0
73
74 return gi * (1.0 + 2.0 * (r + 1.0) * gs)
75
76
77# ============================================================
78# internal: non-degenerate limit (alternating series)
79# ============================================================
80
81def _NonDegenerateFermiDirac(eta, r):
82 """
83 概要:
84 非縮退限界におけるフェルミ・ディラック積分を計算します。
85 詳細説明:
86 eta が負で絶対値が大きい領域で交替級数を用いて計算します。
87 引数:
88 :param eta: 規格化化学ポテンシャル
89 :type eta: float
90 :param r: 次数
91 :type r: float
92 戻り値:
93 :returns: 積分値
94 :rtype: float
95 """
96 s = 1.0
97 total = 0.0
98
99 while True:
100 term = exp(s * eta) / s ** (r + 1.0)
101 total += term
102 s += 1.0
103
104 term = exp(s * eta) / s ** (r + 1.0)
105 total -= term
106 s += 1.0
107
108 if abs(term) < 1.0e-8:
109 break
110
111 return total * gamma(r + 1.0)
112
113
114# ============================================================
115# cache-safe wrapper
116# ============================================================
117
118def _round_key(x, ndigit=10):
119 """
120 概要:
121 キャッシュキー用に浮動小数点数を指定した桁数で丸めます。
122 引数:
123 :param x: 丸める対象の数値
124 :type x: float
125 :param ndigit: 丸めの桁数
126 :type ndigit: int
127 戻り値:
128 :returns: 丸められた数値
129 :rtype: float
130 """
131 return round(float(x), ndigit)
132
133
134@lru_cache(maxsize=1024)
135def _FermiIntegral_cached(eta, r, epsabs, epsrel, limit):
136 """
137 概要:
138 キャッシュを利用してフェルミ・ディラック積分を計算します。
139 引数:
140 :param eta: 規格化化学ポテンシャル
141 :type eta: float
142 :param r: 次数
143 :type r: float
144 :param epsabs: 数値積分の絶対誤差許容値
145 :type epsabs: float
146 :param epsrel: 数値積分の相対誤差許容値
147 :type epsrel: float
148 :param limit: 数値積分の区間分割数の上限
149 :type limit: int
150 戻り値:
151 :returns: 計算された積分値
152 :rtype: float
153 """
154 # degenerate
155 if eta >= 20.0:
156 return _DegenerateFermiDirac(eta, r)
157
158 # non-degenerate
159 if eta < -0.1:
160 return _NonDegenerateFermiDirac(eta, r)
161
162 # intermediate: z = x^2 + quad
163 lim = 17.0 + 4.5 * r + eta
164 f = lambda x: _func_Fr_x2(x, eta, r)
165
166 ret = 0.0
167 ret += integrate.quad(f, 0.0, 1.0, epsabs=epsabs, epsrel=epsrel, limit=limit)[0]
168 ret += integrate.quad(f, 1.0, 4.0, epsabs=epsabs, epsrel=epsrel, limit=limit)[0]
169 ret += integrate.quad(f, 4.0, lim, epsabs=epsabs, epsrel=epsrel, limit=limit)[0]
170
171 return ret
172
173
174# ============================================================
175# public API
176# ============================================================
177
178def FermiIntegral_fast(
179 eta, r,
180 *,
181 epsabs=1.0e-10,
182 epsrel=1.0e-8,
183 limit=50
184):
185 """
186 概要:
187 一般的なフェルミ・ディラック積分 F_r(eta) を計算します。
188 引数:
189 :param eta: 規格化化学ポテンシャル
190 :type eta: float
191 :param r: 次数
192 :type r: float
193 :param epsabs: 数値積分の絶対誤差許容値
194 :type epsabs: float
195 :param epsrel: 数値積分の相対誤差許容値
196 :type epsrel: float
197 :param limit: 数値積分の区間分割数の上限
198 :type limit: int
199 戻り値:
200 :returns: フェルミ・ディラック積分の値
201 :rtype: float
202 """
203 key = (
204 _round_key(eta),
205 _round_key(r),
206 epsabs,
207 epsrel,
208 limit,
209 )
210 return _FermiIntegral_cached(*key)
211
212
213def FermiIntegral_half(
214 eta,
215 *,
216 epsabs=1.0e-10,
217 epsrel=1.0e-8,
218 limit=50
219):
220 """
221 概要:
222 次数 r が 1/2 の場合のフェルミ・ディラック積分を計算します。
223 引数:
224 :param eta: 規格化化学ポテンシャル
225 :type eta: float
226 :param epsabs: 数値積分の絶対誤差許容値
227 :type epsabs: float
228 :param epsrel: 数値積分の相対誤差許容値
229 :type epsrel: float
230 :param limit: 数値積分の区間分割数の上限
231 :type limit: int
232 戻り値:
233 :returns: フェルミ・ディラック積分の値
234 :rtype: float
235 """
236 return FermiIntegral_fast(
237 eta, 0.5,
238 epsabs=epsabs,
239 epsrel=epsrel,
240 limit=limit
241 )
242
243
244def FermiIntegral_3half(
245 eta,
246 *,
247 epsabs=1.0e-10,
248 epsrel=1.0e-8,
249 limit=50
250):
251 """
252 概要:
253 次数 r が 3/2 の場合のフェルミ・ディラック積分を計算します。
254 引数:
255 :param eta: 規格化化学ポテンシャル
256 :type eta: float
257 :param epsabs: 数値積分の絶対誤差許容値
258 :type epsabs: float
259 :param epsrel: 数値積分の相対誤差許容値
260 :type epsrel: float
261 :param limit: 数値積分の区間分割数の上限
262 :type limit: int
263 戻り値:
264 :returns: フェルミ・ディラック積分の値
265 :rtype: float
266 """
267 return FermiIntegral_fast(
268 eta, 1.5,
269 epsabs=epsabs,
270 epsrel=epsrel,
271 limit=limit
272 )
273
274
275# ============================================================
276# self-test / example
277# ============================================================
278
279if __name__ == "__main__":
280 print("Fermi–Dirac integral test")
281 print("")
282
283 eta_list = [-10.0, -3.0, -1.0, 0.0, 2.0, 5.0, 10.0]
284
285 print("r = 1/2")
286 for eta in eta_list:
287 print(f" eta={eta:6.2f} F1/2={FermiIntegral_half(eta):.8e}")
288
289 print("\nr = 3/2")
290 for eta in eta_list:
291 print(f" eta={eta:6.2f} F3/2={FermiIntegral_3half(eta):.8e}")
292
293 print("\ncache info:")
294 print(_FermiIntegral_cached.cache_info())