pw3d.py ドキュメント
概要
3次元の周期境界条件を持つ立方格子中の井戸型ポテンシャルを対象とした、平面波基底によるシュレディンガー方程式の密行列対角化プログラム。
バンド構造の計算をCPU ( numpy ) または GPU ( cupy ) を用いて実行し、エネルギー固有値(バンド)の計算結果や、計算時間のプロファイリングを出力する。
理論的背景と計算アルゴリズム
本プログラムは、結晶などの周期的な系における1電子シュレディンガー方程式を解くための平面波展開法 (Plane-wave method) を実装している。 対象となるハミルトニアン \(H\) は、運動エネルギー \(T\) とポテンシャルエネルギー \(V\) の和で表される。
ブロッホの定理に基づき、波動関数を波数ベクトル \(\mathbf{k}\) を用いて平面波基底で展開する。
ここで \(\mathbf{G}\) は逆格子ベクトルである。本プログラムでは立方格子(格子定数 \(a\) )を仮定しており、 \(\mathbf{G} = \frac{2\pi}{a} \mathbf{n}\) で与えられる( \(\mathbf{n}\) は整数の組)。
ハミルトニアンの行列要素は以下のように計算される。
運動エネルギー項 運動エネルギー項は対角成分のみを持ち、以下で与えられる。
コード内の KE は、係数 \(\frac{\hbar^2}{2m}\) を単位 \(\text{eV} \cdot \text{\AA}^2\) に変換するための定数である。
ポテンシャル項
立方体セルの原点に配置された、幅 \(w\) (プログラム内では width )、深さ \(V_0\) (プログラム内では depth )の井戸型ポテンシャルを仮定する。このポテンシャルのフーリエ係数 \(V_{\mathbf{q}}\) (ただし \(\mathbf{q} = \mathbf{G} - \mathbf{G'}\) )は解析的に計算可能であり、以下の数式によって求められる。
プログラム中の \(\text{sinc}\) 関数は、 \(\text{sinc}(z) = \frac{\sin(\pi z)}{\pi z}\) の定義に従う。
ハミルトニアン行列 \(H_{\mathbf{G}, \mathbf{G'}}\) はサイズ \(M \times M\) ( \(M = \text{ng}^3\) )の密行列として構築され、 numpy.linalg.eigvalsh または cupy.linalg.eigvalsh を用いて完全対角化される。指定された特定の \(\mathbf{k}\) 点経路( \(\Gamma \to \text{X} \to \text{M} \to \Gamma \to \text{R}\) )に沿って対角化を繰り返し、エネルギー固有値(バンド)を計算する。
依存ライブラリ
標準ライブラリ
argparsecsvpathlibtime
非標準ライブラリ
numpyscipy(物理定数の取得に使用)cupy(オプション--backendでgpuまたはbothを指定した場合のみ要求される)matplotlib(オプション--no-plotを指定しなかった場合のバンド図描画に使用)
入出力仕様
入力
特定の入力ファイルは必要とせず、コマンドライン引数(CLIオプション)によって計算パラメータを指定する。
出力
出力ファイルのプレフィックスはオプション --output で指定される(デフォルトは pw3d )。
[output]_timing.csv計算時間に関するプロファイル結果を保存するCSVファイル。
含まれる列名:
backend,trial,k_index,build_seconds,eig_seconds,result_copy_seconds,total_seconds,input_seconds,potential_seconds,startup_seconds
[output]_bands.csv計算されたバンド構造(各 \(\mathbf{k}\) 点に対するエネルギー固有値)を保存するCSVファイル。
含まれる列名:
backend,k_index,kx,ky,kz,distance, および各バンドのエネルギー値(E0_eV,E1_eVなど)。
[output]_bands.png計算されたバンド図を可視化した画像ファイル(PNG形式)。
--no-plotを指定した場合は出力されない。
コマンドライン引数 (CLIオプション)
--backend: 実行に使用するバックエンドを指定する。numpy,gpu,bothから選択可能(デフォルト:numpy)。--a: 立方格子の格子定数を \(\text{\AA}\) 単位で指定する(デフォルト: \(5.4064\) )。--width: 井戸型ポテンシャルの幅を \(\text{\AA}\) 単位で指定する(デフォルト: \(2.0\) )。--depth: 井戸型ポテンシャルの深さを \(\text{eV}\) 単位で指定する。井戸の内部は負の値になり、外部は \(0\) となる(デフォルト: \(10.0\) )。--ng: 各軸あたりの平面波の数を奇数で指定する。総基底数 \(M\) は \(\text{ng}^3\) となる(デフォルト: \(5\) )。--nk: \(\mathbf{k}\) 空間の経路の各セグメントにおける分割数(始点・終点を含む)を指定する(デフォルト: \(9\) )。--bands: 保存およびプロットするエネルギーバンドの数を指定する(デフォルト: \(8\) )。--vectors: 固有ベクトルも計算する場合に指定するフラグ。計算結果は保存されない。--repeat: 計算全体を繰り返す回数を指定する。複数回実行した場合はプロファイルの中央値が計算される(デフォルト: \(1\) )。--no-plot: 結果の可視化(グラフの描画および画像ファイルの保存)を行わない場合に指定するフラグ。--output: 出力ファイルのプレフィックス名(パスを含む)を指定する(デフォルト:pw3d)。
実行例
CPU ( numpy ) を用いて、デフォルト設定で計算を実行する例。
python pw3d.py
GPU ( cupy ) を使用し、計算基底数(各軸の平面波の数)を \(7\) に増やし、プロットを行わずに実行する例。
python pw3d.py --backend gpu --ng 7 --no-plot
CPUとGPUの両方で実行してパフォーマンスと計算結果を比較し、結果を特定のディレクトリに出力する例。
python pw3d.py --backend both --output result/test_run