vdPauw_verbose.py ダウンロード/コピー

vdPauw_verbose.py をダウンロード

vdPauw_verbose.py
vdPauw_verbose.py
  1"""
  2概要:
  3    van der Pauw形状補正因子を計算・描画します。
  4詳細説明:
  5    依存ライブラリは numpy、scipy、matplotlib です。
  6    実行時は python vdPauw_verbose.py --max_R 100 のように指定します。
  7関連リンク:
  8    vdPauw_verbose_usage
  9"""
 10
 11import argparse
 12
 13import numpy as np
 14import matplotlib.pyplot as plt
 15from scipy.optimize import brentq
 16
 17
 18def vdp_factor(r: float) -> float:
 19    """
 20    概要:
 21        正の抵抗比rに対する補正因子fを返します。
 22    詳細説明:
 23        シート抵抗Rsは pi / ln(2) * (R_AB,CD + R_AD,BC) / 2 * f と定義します。
 24        x = pi * R_AD,BC / Rs としてvan der Pauw方程式を解きます。
 25    引数:
 26        :param r: 正の抵抗比 R_AB,CD / R_AD,BC
 27        :type r: float
 28    戻り値:
 29        :returns: 補正因子f
 30        :rtype: float
 31    例外:
 32        :raises ValueError: 抵抗比rが有限の正の値でない場合に発生します。
 33    """
 34    if not np.isfinite(r) or r <= 0:
 35        raise ValueError("抵抗比rは有限の正の値にしてください")
 36
 37    def equation(x):
 38        return np.exp(-x * r) + np.exp(-x) - 1
 39
 40    x = brentq(equation, 1e-10, 100)
 41    return 2 * np.log(2) / (x * (r + 1))
 42
 43
 44def calculate_factors(r_values: np.ndarray, *, show_progress=False) -> np.ndarray:
 45    """
 46    概要:
 47        複数の抵抗比に対する補正因子を計算します。
 48    詳細説明:
 49        表示が必要な場合だけ進捗を出力します。
 50    引数:
 51        :param r_values: 計算対象となる抵抗比の配列
 52        :type r_values: numpy.ndarray
 53        :param show_progress: 進捗を表示するかどうかのフラグ
 54        :type show_progress: bool
 55    戻り値:
 56        :returns: 計算された補正因子の配列
 57        :rtype: numpy.ndarray
 58    """
 59    f_values = np.empty(len(r_values))
 60    for i, r in enumerate(r_values):
 61        f_values[i] = vdp_factor(r)
 62        if show_progress and ((i + 1) % 100 == 0 or i + 1 == len(r_values)):
 63            print(f"計算中: {i + 1}/{len(r_values)} 点 (R={r:.6g})", flush=True)
 64    return f_values
 65
 66
 67def print_results(r_values: np.ndarray, f_values: np.ndarray):
 68    """
 69    概要:
 70        代表的な抵抗比の係数と、方程式の左辺・残差を表示します。
 71    詳細説明:
 72        指定された抵抗比の配列とその結果の補正因子を用いて、van der Pauw方程式が正しく解けているかを確認するための情報を出力します。
 73    引数:
 74        :param r_values: 計算に用いた抵抗比の配列
 75        :type r_values: numpy.ndarray
 76        :param f_values: 計算された補正因子の配列
 77        :type f_values: numpy.ndarray
 78    戻り値:
 79        :returns: なし
 80        :rtype: None
 81    """
 82    print("\n代表値(Rは抵抗比 R_AB,CD / R_AD,BC)")
 83    print(f"{'R':>12} {'f':>14} {'左辺 exp(-xR)+exp(-x)':>27} {'残差 (左辺-1)':>20}")
 84    # 両端と、その間の代表値を重複なく表示する。
 85    representatives = sorted({float(r_values[0]), float(r_values[-1])} |
 86                             {r for r in (0.01, 0.1, 1, 2, 10, 100)
 87                              if r_values[0] <= r <= r_values[-1]})
 88    for r in representatives:
 89        f = vdp_factor(r)
 90        x = 2 * np.log(2) / (f * (r + 1))
 91        lhs = np.exp(-x * r) + np.exp(-x)
 92        print(f"{r:12.6g} {f:14.10f} {lhs:27.15f} {lhs - 1:20.3e}")
 93    x_values = 2 * np.log(2) / (f_values * (r_values + 1))
 94    residuals = np.exp(-x_values * r_values) + np.exp(-x_values) - 1
 95    print(f"全{len(r_values)}点の最大絶対残差: {np.max(np.abs(residuals)):.3e}")
 96
 97
 98def plot_factors(r_values: np.ndarray, f_values: np.ndarray):
 99    """
100    概要:
101        結果を描画してFigureとAxesを返します。
102    詳細説明:
103        画面表示は呼び出し元で行います。横軸は抵抗比、縦軸は補正因子です。
104    引数:
105        :param r_values: 描画する抵抗比の配列
106        :type r_values: numpy.ndarray
107        :param f_values: 描画する補正因子の配列
108        :type f_values: numpy.ndarray
109    戻り値:
110        :returns: 生成されたFigureとAxesのタプル
111        :rtype: tuple
112    """
113    fig, ax = plt.subplots(figsize=(8, 6))
114    ax.semilogx(r_values, f_values, lw=2)
115    ax.set_xlabel(r"$R_{AB,CD}/R_{AD,BC}$", fontsize=14)
116    ax.set_ylabel("Correction factor f", fontsize=14)
117    ax.set_title("van der Pauw Correction Factor", fontsize=16)
118    ax.grid(True, which="both", alpha=0.3)
119    ax.set_ylim(0, 1.05)
120    fig.tight_layout()
121    return fig, ax
122
123
124def initialize(argv=None):
125    """
126    概要:
127        コマンドライン引数を読み込み、設定値を検査します。
128    詳細説明:
129        max_R引数をパースし、0.01以上の有限値であることを確認します。
130    引数:
131        :param argv: コマンドライン引数のリスト
132        :type argv: list or None
133    戻り値:
134        :returns: 解析されたコマンドライン引数を含むNamespaceオブジェクト
135        :rtype: argparse.Namespace
136    例外:
137        :raises SystemExit: 不正な引数が指定された場合に発生します。
138    """
139    parser = argparse.ArgumentParser(description="van der Pauw補正因子の計算")
140    parser.add_argument("--max_R", type=float, default=100.0,
141                        help="抵抗比Rの上限(下限0.01、既定値100)")
142    args = parser.parse_args(argv)
143    if not np.isfinite(args.max_R) or args.max_R < 0.01:
144        parser.error("max_Rは0.01以上の有限値にしてください")
145    return args
146
147
148def main(argv=None):
149    """
150    概要:
151        設定を表示し、計算・結果表示・描画を順に行います。
152    詳細説明:
153        コマンドライン引数を初期化した後、指定された範囲の抵抗比を生成し、補正因子の計算と結果の表示、グラフの描画を実行します。
154    引数:
155        :param argv: コマンドライン引数のリスト
156        :type argv: list or None
157    戻り値:
158        :returns: なし
159        :rtype: None
160    """
161    args = initialize(argv)
162    min_R, n_points = 0.01, 500
163    print(f"設定: max_R={args.max_R:g}, min_R={min_R:g}, n_points={n_points}",
164          flush=True)
165    r_values = np.geomspace(min_R, args.max_R, n_points)
166    f_values = calculate_factors(r_values, show_progress=True)
167    print_results(r_values, f_values)
168    print("計算完了。グラフを表示します。", flush=True)
169    plot_factors(r_values, f_values)
170    plt.show()
171
172
173if __name__ == "__main__":
174    main()