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

refineE_schrodinger1d.py をダウンロード

refineE_schrodinger1d.py
refineE_schrodinger1d.py
  1"""
  2概要:
  3    Brent法を使用して1次元シュレディンガー方程式の固有値を精密化するスクリプトです。
  4
  5詳細説明:
  6    シュレディンガー方程式の解から境界条件を満たすかどうかを評価し、
  7    Brent法を用いて目的の固有値を高精度に探索します。
  8
  9関連リンク:
 10    refineE_schrodinger1d_usage
 11"""
 12
 13import os
 14import argparse
 15import numpy as np
 16from scipy.optimize import brentq
 17from schrodinger1d import solve_schrodinger
 18
 19# ----------------------------------------
 20# residual(E): ψ(L) を返す関数
 21# ----------------------------------------
 22def residual(E, args, print_level = 0):
 23    """
 24    概要:
 25        指定されたエネルギーEに対する終端位置での波動関数の値 psi(L) を計算して返します。
 26
 27    詳細説明:
 28        schrodinger1d.solve_schrodinger を呼び出して計算を実行します。
 29        print_level がゼロより大きい場合は進行状況を標準出力に出力します。
 30
 31    引数:
 32        :param E: 評価するエネルギー値
 33        :type E: float
 34        :param args: コマンドライン引数を格納したNamespace
 35        :type args: argparse.Namespace
 36        :param print_level: ログ出力のレベル、デフォルトは 0
 37        :type print_level: int
 38
 39    戻り値:
 40        :returns: 位置 L における波動関数の値
 41        :rtype: float
 42    """
 43    x, psi, info = solve_schrodinger(
 44        E=E,
 45        L=args.L,
 46        nx=args.nx,
 47        psi_max=args.psi_max,
 48        report_step=0,
 49        bc=args.bc,
 50        eps=args.eps
 51    )
 52    
 53    if print_level:
 54        print(f"E={E:12.8g}  psi(L)={psi[-1]:14.6e}")
 55
 56    return psi[-1]  # ψ(L)
 57
 58
 59# ----------------------------------------
 60# 初期値 E0 から符号反転区間を自動探索
 61# ----------------------------------------
 62def find_bracket(E0, args, max_expand=20, direction='both'):
 63    """
 64    概要:
 65        初期のエネルギー値付近で波動関数の終端値の符号が反転する区間を探索します。
 66
 67    詳細説明:
 68        探索方向の指定に基づき、徐々に探索幅を広げながら符号反転区間を探します。
 69
 70    引数:
 71        :param E0: 探索を開始する初期エネルギー値
 72        :type E0: float
 73        :param args: コマンドライン引数を格納したNamespace
 74        :type args: argparse.Namespace
 75        :param max_expand: 区間を拡大する最大回数、デフォルトは 20
 76        :type max_expand: int
 77        :param direction: 探索方向を upper、lower、both のいずれかで指定、デフォルトは both
 78        :type direction: str
 79
 80    戻り値:
 81        :returns: 符号反転が確認されたエネルギーの下限と上限のタプル
 82        :rtype: tuple
 83
 84    例外:
 85        :raises ValueError: directionに不正な値が指定された場合
 86        :raises RuntimeError: 符号反転区間が見つからなかった場合
 87    """
 88    delta = 0.05 * abs(E0) + 0.01
 89
 90    # 初期値の符号
 91    f0 = residual(E0, args)
 92
 93    for _ in range(max_expand):
 94
 95        if direction == 'upper':
 96            E_low  = E0
 97            E_high = E0 + delta
 98
 99        elif direction == 'lower':
100            E_low  = E0 - delta
101            E_high = E0
102
103        elif direction == 'both':
104            E_low  = E0 - delta
105            E_high = E0 + delta
106
107        else:
108            raise ValueError("direction must be 'upper', 'lower', or 'both'")
109
110        f_low  = residual(E_low, args)
111        f_high = residual(E_high, args)
112
113        if f_low * f_high < 0:
114            print(f"[INFO] Found bracket: [{E_low}, {E_high}]")
115            return E_low, E_high
116
117        delta *= 2
118
119    raise RuntimeError("Could not find sign change interval.")
120
121# ----------------------------------------
122# Brent 法の maxiter を自動計算
123# ----------------------------------------
124def compute_maxiter(E_low, E_high, E_tol):
125    """
126    概要:
127        Brent法の最大反復回数を区間幅と許容誤差から自動的に計算します。
128
129    引数:
130        :param E_low: 探索区間の下限エネルギー値
131        :type E_low: float
132        :param E_high: 探索区間の上限エネルギー値
133        :type E_high: float
134        :param E_tol: 目標とするエネルギー値の許容誤差
135        :type E_tol: float
136
137    戻り値:
138        :returns: 計算された最大反復回数
139        :rtype: int
140    """
141    width = abs(E_high - E_low)
142    return int(np.ceil(np.log2(width / E_tol))) + 5
143
144
145# ----------------------------------------
146# main
147# ----------------------------------------
148def main():
149    """
150    概要:
151        コマンドライン引数を解析し、Brent法による固有値の精密化処理を実行します。
152
153    詳細説明:
154        初期値から符号反転区間を探索し、Brent法を用いて固有値を計算します。
155        計算結果は標準出力に表示されるとともに、refineE.csv ファイルに追記されます。
156    """
157    parser = argparse.ArgumentParser(
158        description="Refine eigenvalue using Brent method"
159    )
160
161    parser.add_argument("--E", type=float, required=True,
162                        help="Initial guess for eigenvalue")
163    parser.add_argument("--E_tol", type=float, default=1e-6,
164                        help="Target precision for eigenvalue")
165    parser.add_argument("--maxiter", type=int, default=None,
166                        help="Max iterations for Brent method (optional)")
167
168    # schrodinger1d.py と同じ引数を流用
169    parser.add_argument("--L", type=float, default=10.0)
170    parser.add_argument("--nx", type=int, default=2000)
171    parser.add_argument("--psi_max", type=float, default=1e10)
172    parser.add_argument("--bc", choices=["asymptotic", "zero"], default="asymptotic")
173    parser.add_argument("--eps", type=float, default=1e-6)
174
175    args = parser.parse_args()
176
177    # 1. 初期値 E0 から符号反転区間を探す
178    E_low, E_high = find_bracket(args.E, args, direction = 'upper')
179
180    # 2. maxiter を自動設定
181    if args.maxiter is None:
182        args.maxiter = compute_maxiter(E_low, E_high, args.E_tol)
183        print(f"[INFO] maxiter set to {args.maxiter}")
184
185    # 3. Brent 法で固有値を精密化
186    E_root, result = brentq(
187        lambda E: residual(E, args, print_level=1),
188        E_low, E_high,
189        xtol=args.E_tol,
190        maxiter=args.maxiter,
191        full_output=True
192    )
193
194    print("====================================")
195    print(" Refined eigenvalue:")
196    print(f"   E = {E_root:.12f}")
197    print("====================================")
198    
199    # f_low, f_high を計算
200    f_low  = residual(E_low, args)
201    f_high = residual(E_high, args)
202
203    log_csv = "refineE.csv"
204    print()
205    if not os.path.exists(log_csv):
206        print(f"{log_csv} does not exist. Add header labels.")
207        with open(log_csv, "a") as fp:
208            fp.write("E0, E_low, E_high, E_root, f_low, f_high, iterations, funcalls\n")
209
210    print(f"Append the result to {log_csv}")
211    with open(log_csv, "a") as fp:
212        fp.write(
213            f"{args.E},"
214            f"{E_low},{E_high},"
215            f"{E_root},"
216            f"{f_low},{f_high},"
217            f"{result.iterations},{result.function_calls}\n"
218        )
219
220
221if __name__ == "__main__":
222    main()