コード品質と用途適性評価: 1次元Kronig-Penneyモデル計算スクリプト

このコードは誰向けか

  • 研究室内の個人用解析コード向け

  • 教育用サンプル

  • 試作コード

  • 公開ライブラリ利用者向けではない

用途に対する適性評価

教育用途・研究用途(個人用)としての適性

数式モデル(Kronig-Penneyモデル)の境界条件が cal_delta や cal_wavefunction に比較的そのまま表現されており、物理学や数値計算を学ぶ際の教材、または個人が特定の物理現象を確認するための試作コードとして適しています。グラフ描画処理が内包されているため、実行してすぐに挙動を確認できる点もこの用途に向いています。

ライブラリ用途・長期保守用途としての適性

他のPythonスクリプトからインポートして再利用する(ライブラリとして活用する)用途や、複数人で長期的に保守する用途には向いていません。関数がグローバル変数に強く依存しており、計算ロジックとGUI/CLI(標準出力やグラフ描画、入力待機)が密結合しているため、外部から計算だけを呼び出すことが困難な構造になっています。

コードの長所

  • コメントとdocstring: 各関数に概要、詳細説明、引数、戻り値の型が統一されたフォーマット(docstring)で記述されており、関数の意図を読み取る際の可読性を高めています。

  • 異常系対策への配慮: コマンドライン引数の取得や型変換 (pfloat, pint, getarg) において try-except が用いられており、パースエラーによる意図しない異常終了を防ぎ、デフォルト値へフォールバックする構造が確認できます。

  • 可視化の実装: matplotlib の twinx を用いたポテンシャルと波動関数の重ね合わせ表示など、結果を直感的に評価できる可視化処理が組み込まれています。

構造と実装上の制限・課題

  • global state: 物理定数、計算パラメータ、動作モードなどがグローバル変数として定義され、pot, wf, band, graphview, main 等の関数内で global 宣言を通じて参照・更新されています。これにより状態管理が複雑化し、再利用性が制限されています。

  • GUIと計算の密結合: wf, band, graphview 関数内で、計算処理と plt.show() / plt.pause() / input() などの画面表示・入力待ちが同時に行われています(責務分離の未達)。

  • 引数パースの依存性: 標準の argparse モジュールを使用せず、sys.argv のインデックス位置に強く依存した引数取得を行っています。

  • broad except: pfloat, pint, getarg 関数における例外処理が except: となっており、あらゆる例外(KeyboardInterrupt などを含む)をサイレントに捕捉して None を返すため、バグの発見を遅らせる silent failure の要因となる可能性があります。

数値計算としての評価(安定性と極限条件)

  • 極限条件と特異点の回避: find_Elist において E == 0.0 の場合を明示的に continue でスキップし、V0 <= E の場合に break で探索を打ち切る条件分岐が確認できます。これにより、cal_delta や波動関数計算におけるゼロ割りや平方根内の負値(\(E > V_0\) 時の複素数化)を意図的に回避していることが分かります。一方で、この物理モデル依存性により、散乱状態(\(E > V_0\))の計算には対応していません。

  • 条件分岐と数値安定性: refine_E におけるSecant法の実装では、分母となる diff が0または負になる場合に dump を加減算してゼロ割り例外を防ぐ分岐が存在します。ただし、グローバル定義において dump = 0.0 と設定されているため、実際の極限条件においてこの仕組みが意図通りに機能するかは検証が必要です。

  • 収束性と解の探索: find_Elist では固定ステップ(Estep)で誤差関数の符号反転を検出しています。このアプローチは実装がシンプルである反面、指定したステップ幅内に複数のエネルギー準位が存在した場合(縮退や極端に近い解がある場合)、符号変化を検出できず解を見落とす可能性があります。

  • オーバーフローへの配慮: 行列要素の計算 (Mij, M3ij 等) にて exp(beta * x0) などの指数関数が含まれます。beta や x0 がスケール変換(1.0e-10の乗算)を伴って計算されていますが、障壁幅 b や高さ V0 が極端に大きい場合、指数関数のオーバーフローが発生する可能性があります。

優先順位が高い改善点

  1. グローバル状態の排除と引数渡し化: global 変数を廃止し、計算に必要なパラメータは関数への引数として渡すか、パラメータをまとめた構造体(例: dataclass や辞書)として管理する。

  2. 計算と可視化の責務分離 (API分離): 計算関数と描画関数を分割する。(例: find_Elist の結果を受け取って描画のみを行う plot_band(E_list, k_list) などを定義する。)

  3. 具体的な例外捕捉への変更: except: を except ValueError: や except IndexError: に修正し、想定外のエラーによる silent failure を防ぐ。

  4. コマンドライン引数解析の標準化: sys.argv のインデックス直打ちを避け、argparse モジュールを用いた堅牢なCLIツール化を行う。

  5. 解探索(収束性)の安定化: Secant法 (refine_E) の dump パラメータに適切な初期微小値を与えるか、標準ライブラリ等のより堅牢な求根アルゴリズムへの置き換えを検討する。