test_vdPauw_compare.py ドキュメント
概要
test_vdPauw_compare.py は、ファン・デル・パウ法における補正係数計算プログラムの正確性を検証・比較するためのテストスクリプトです。基準となるプログラム(vdPauw_refactored.py)と、ユーザーが指定した任意の比較対象プログラムを動的に読み込み、指定された抵抗比(\(r\))の範囲にわたって計算結果を許容誤差内で比較します。
背景理論・数式
ファン・デル・パウ法(Van der Pauw method)は、任意の形状を持つ薄膜試料のシート抵抗やホール係数を測定するための手法です。シート抵抗 \(R_S\) は、試料の周囲に配置された4端子を用いて直交する2つの測定で得られた抵抗値 \(R_A\) および \(R_B\) を用いて、以下の超越方程式を満たします。
測定された抵抗の比 \(r = R_A / R_B\) を用いると、シート抵抗は次のように表すことができます。
ここで、\(f(r)\) はファン・デル・パウの補正係数(Van der Pauw factor)と呼ばれ、\(r\) の関数として次の方程式を満たします。
本プログラムは、この超越方程式を解いて補正係数 \(f\) を計算する関数 vdp_factor およびその配列処理版である calculate_factors の出力を、広範な \(r\) の値について比較・検証します。
動作環境・依存ライブラリ
本スクリプトは以下のライブラリに依存しています。
標準ライブラリ:
argparse,importlib.util,pathlib,sys非標準ライブラリ:
numpy(配列計算、対数スケールによるテスト点生成、およびnp.testing.assert_allcloseを用いた許容誤差の検証に使用)
入出力仕様
入力
コマンドライン引数として以下の情報を受け取ります。
位置引数:
program: 比較対象のPythonプログラムのファイルパス。この対象プログラムにはvdp_factor(r)およびcalculate_factors(r_values)の2つの関数が実装されている必要があります。
オプション引数:
--min_R: 評価する抵抗比 \(r\) の最小値(デフォルト: \(10^{-8}\))--max_R: 評価する抵抗比 \(r\) の最大値(デフォルト: \(10^{8}\))--npoints: 評価する点の数(デフォルト: \(161\))。対数スケールで等間隔に生成されます。--rtol: 比較時の相対許容誤差(デフォルト: \(10^{-8}\))--atol: 比較時の絶対許容誤差(デフォルト: \(10^{-12}\))
また、スクリプトの実行ディレクトリ内に、基準となるプログラム vdPauw_refactored.py が存在している必要があります。
出力
標準出力に比較結果が出力されます。基準と対象の間で計算結果の不一致がない場合は、以下の情報が順に表示されます。
基準ファイルと対象ファイルのパス情報
テストに用いられたパラメータ設定値
vdp_factorおよびcalculate_factorsそれぞれに対する、最大絶対差と最大相対差、およびそれが生じた \(r\) の値個別のテスト合格メッセージ(例:
PASS: 161点が許容誤差内で一致)最終的な合格メッセージ:
全比較に合格しました。
設定した許容誤差を超えた場合、関数の戻り値の配列形状が異なる場合、または NaN や無限大が検出された場合は、AssertionError が送出されて異常終了します。
実行例
基本的な実行方法(vdPauw_verbose.py を比較対象とする場合):
python test_vdPauw_compare.py vdPauw_verbose.py
相対許容誤差(--rtol)を厳しくして実行する方法:
python test_vdPauw_compare.py vdPauw_verbose.py --rtol 1e-8
評価する \(r\) の範囲(最小値と最大値)と評価点数を変更して実行する方法:
python test_vdPauw_compare.py vdPauw_verbose.py --min_R 1e-3 --max_R 1e3 --npoints 50