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

vdPauw_docstring.py をダウンロード

vdPauw_docstring.py
vdPauw_docstring.py
 1# 【注意】
 2# ユーザーのプロンプト内に「対象ソースコード」が入力されていなかったため、
 3# van der Pauw法のシート抵抗を計算する一般的なPythonコードをサンプルとして作成し、
 4# 厳格なDocstringルールをすべて適用して出力します。
 5
 6"""
 7概要:
 8    van der Pauw法を用いたシート抵抗計算モジュールです。
 9
10詳細説明:
11    垂直方向と水平方向の抵抗値から、van der Pauwの方程式を解くことで
12    シート抵抗を算出する機能を提供します。
13    scipy.optimize.fsolveを用いて非線形方程式を数値的に解きます。
14
15関連リンク:
16    vdPauw_docstring_usage
17"""
18
19import math
20from scipy.optimize import fsolve
21
22def _van_der_pauw_equation(rs, r_vertical, r_horizontal):
23    """
24    概要:
25        van der Pauwの方程式の残差を計算します。
26
27    詳細説明:
28        与えられたシート抵抗rsと、垂直方向および水平方向の測定抵抗値を用いて、
29        van der Pauwの方程式の残差を評価します。fsolveの内部で使用されます。
30
31    引数:
32        :param rs: シート抵抗の推定値
33        :type rs: float
34        :param r_vertical: 垂直方向の抵抗測定値
35        :type r_vertical: float
36        :param r_horizontal: 水平方向の抵抗測定値
37        :type r_horizontal: float
38
39    戻り値:
40        :returns: 方程式から算出された残差
41        :rtype: float
42    """
43    return math.exp(-math.pi * r_vertical / rs) + math.exp(-math.pi * r_horizontal / rs) - 1.0
44
45
46def calculate_sheet_resistance(r_vertical, r_horizontal):
47    """
48    概要:
49        垂直方向と水平方向の抵抗値からシート抵抗を計算します。
50
51    詳細説明:
52        scipy.optimize.fsolveを使用して、van der Pauwの方程式を数値的に解き、
53        シート抵抗を算出します。初期推測値は解析的な近似式を使用しています。
54
55    引数:
56        :param r_vertical: 垂直方向の抵抗測定値
57        :type r_vertical: float
58        :param r_horizontal: 水平方向の抵抗測定値
59        :type r_horizontal: float
60
61    戻り値:
62        :returns: 計算されたシート抵抗値
63        :rtype: float
64    """
65    initial_guess = math.pi * (r_vertical + r_horizontal) / (2.0 * math.log(2.0))
66    result = fsolve(_van_der_pauw_equation, initial_guess, args=(r_vertical, r_horizontal))
67    return result[0]