make_kpoints.py ドキュメント

概要

make_kpoints.py は、結晶構造データであるCIFファイルから、VASPを用いたバンド構造計算用の KPOINTS ファイルを生成するスクリプトです。結晶の空間群の対称性を自動的に解析し、ブリュアンゾーン内の適切な高対称K点パスを特定します。

詳細説明

第一原理計算コードであるVASPにおいて、バンド構造を計算するためには、逆格子空間(ブリュアンゾーン)内の適切な波数ベクトル \(\vec{k}\) のパスを指定した KPOINTS ファイルが必要です。逆格子ベクトル \(\vec{b}_1, \vec{b}_2, \vec{b}_3\) によって張られる空間における波数ベクトルは、以下のように表現されます。

\[\vec{k} = u \vec{b}_1 + v \vec{b}_2 + w \vec{b}_3\]

バンド構造計算では、対称性が高い点(例えば \(\Gamma, X, L\) など)を結ぶ線分に沿って計算を行います。これらの高対称点の座標 \(u, v, w\) は結晶の対称性に由来するため、厳密には \(0, 1/2, 1/3, 1/4\) などの有理数となります。

本スクリプトは、pymatgen の機能を利用してCIFファイルから結晶構造を読み込み、標準化された原始セルを抽出した上で、高対称K点パスを計算します。さらに、浮動小数点数として得られたK点座標 \(x\) に含まれる数値計算誤差を排除するため、指定された最大分母 \(N_{\max}\) (デフォルトでは \(4\))を用いて、最も近い分数 \(p/q\) に丸めるスナップ処理を行います。

\[x_{\mathrm{approx}} = \frac{p}{q} \quad \left( q \le N_{\max}, \ p, q \in \mathbb{Z} \right)\]

この処理を経て、ラインモード (line-mode) に準拠した VASP 形式の KPOINTS ファイルを出力します。

依存ライブラリ

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

  • pymatgen

入出力仕様

  • 入力ファイル: 結晶構造が記述された .cif ファイル

  • 出力ファイル: VASPのラインモード形式で記述された KPOINTS ファイル(デフォルトのファイル名は KPOINTS)

オプション

スクリプト実行時に指定可能なコマンドライン引数およびオプションは以下の通りです。

  • ciffile 入力CIFファイルのパスを指定します(必須の第一引数)。

  • --primitive_on_read CIFファイルからの読み込み直後に、構造を原始セルに変換します。

  • -c, --conventional CIFファイルから読み込んだセルをそのまま維持し、原始セルへの還元処理をスキップします。

  • --international-monoclinic 構造を標準化する際に、国際単斜晶系規約を使用します。

  • --keep-site-properties 原始標準構造に還元する際に、元のサイト(原子位置)属性を保持します。

  • -f, --frac_tolerance 構造パラメータにおける分数座標の許容誤差を指定します(デフォルト: \(1 \times 10^{-4}\))。

  • -d, --max_den 逆格子空間の分数座標を丸めるための最大分母を指定します(デフォルト: \(4\))。

  • -s, --symprec 対称性検出のための位置許容誤差を指定します(デフォルト: \(1 \times 10^{-4}\))。

  • -a, --angle-tol 対称性検出のための角度許容誤差(度単位)を指定します(デフォルト: \(0.1\))。

  • --atol ブリュアンゾーン上の点や線の対称的な等価性を判定するための絶対許容誤差を指定します(デフォルト: \(0.1\))。

  • -n, --ndivisions 各K点パスセグメントに沿ったK点の分割数を指定します(デフォルト: \(20\))。

  • -p, --path-type 使用する高対称パスの規約を指定します。setyawan_curtarolo, latimer_munro, hinuma, all から選択可能です(デフォルト: setyawan_curtarolo)。

  • -o, --output 出力されるKPOINTSファイルのファイル名を設定します(デフォルト: KPOINTS)。

実行例

デフォルトの設定で、指定したCIFファイルから KPOINTS ファイルを生成する基本的な実行例です。

python make_kpoints.py structure.cif

セグメントあたりのK点分割数を \(40\) に変更し、出力ファイル名を KPOINTS_band として生成する実行例です。

python make_kpoints.py structure.cif -n 40 -o KPOINTS_band

対称性の判定条件を緩め(許容誤差 \(1 \times 10^{-3}\))、かつ読み込み時に原始セルへ変換するオプションを有効にする実行例です。

python make_kpoints.py structure.cif -s 1e-3 --primitive_on_read