fe_test.py ドキュメント

概要

fe_test.py は、フェルミ・ディラック積分に関連する関数の精度および実行速度を評価するためのテスト・ベンチマーク用スクリプトです。外部モジュール tkfermi_integral.py で実装された複数の関数に対して、広範囲の入力値(エネルギーパラメータなど)に対する演算結果を比較し、指定された許容誤差の範囲内に収まっているかを判定します。また、ベクトル化された関数とスカラー処理関数の実行時間を計測して比較する機能も備えています。

背景と理論

本スクリプトで評価対象となっている関数群は、半導体物理学やマテリアルズ・インフォマティクスにおいて電子の統計力学的分布を記述するフェルミ・ディラック分布、およびそれに付随するフェルミ・ディラック積分の計算を担っていると推測されます。

フェルミ・ディラック分布関数 \(f(E)\) は以下の式で表されます。

\[f(E) = \frac{1}{1 + \exp\left(\frac{E - E_F}{k_B T}\right)}\]

ここで、\(E\) はエネルギー、\(E_F\) はフェルミエネルギー、\(k_B\) はボルツマン定数、\(T\) は絶対温度です。計算上の安定性や近似アルゴリズムの評価において、極端な正負の入力値(指数部が非常に大きい、または非常に小さい場合)に対する精度が重要となります。

本スクリプトでは、高精度なベクトル計算関数( fermi_dirac_e_npvector )をリファレンスとし、他の実装(条件分岐を用いた fermi_dirac_e_if や fermi_dirac_e )の計算精度を検証します。各テストポイントにおける相対誤差 \(\Delta\) は、ゼロ除算を防ぐための下限値を用いて以下の式で計算されます。

\[\Delta = \frac{|V_{\text{test}} - V_{\text{ref}}|}{\max(|V_{\text{ref}}|, 10^{-300})}\]

この相対誤差 \(\Delta\) が許容誤差( tol = 1e-20 )未満である場合は PASS、そうでない場合は FAIL と判定されます。

非標準ライブラリ

本スクリプトの実行には、以下の非標準ライブラリが必要です。

  • numpy : 数値計算、配列操作、および数学関数のベクトル化処理に使用されます。

  • tkfermi_integral : 評価対象となる関数( fermi_dirac_e_npvector、 fermi_dirac_e_if、 fermi_dirac_e )を提供するカスタムモジュールです。

入出力仕様

  • 入力

    • 外部からのファイル入力やコマンドライン引数による入力はありません。

    • テスト対象となる入力値( x_values )はコード内にハードコードされており、 \(-1000\) から \(1000\) までの浮動小数点数配列が使用されます。

    • その他のパラメータとして、 eta = 0.0、 g = 1.0、許容誤差 tol = 1e-20 がスクリプト内で定義されています。

  • 出力

    • 処理結果は標準出力(コンソール)へ出力されます。

    • 関数ごとのテストにおいて、各入力値 x に対する計算値、リファレンス値、相対誤差( diff )、および判定結果( PASS または FAIL )が出力されます。

    • テスト終了後にベンチマークが実行され、各関数の指定回数(デフォルトは \(20000\) 回)のループ処理にかかる実行時間(秒)が出力されます。

実行例

本スクリプトはコマンドラインから直接実行します。依存する tkfermi_integral.py が同一ディレクトリまたはPythonのモジュール検索パス上に存在している必要があります。

python fe_test.py