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

planet_integrator_comparison.py をダウンロード

planet_integrator_comparison.py
planet_integrator_comparison.py
  1#!/usr/bin/env python3
  2"""
  3概要:
  4    ニュートン力学による惑星の運動について、オイラー法、ホイン法、RK4法、および速度ベルレ法を比較します。
  5詳細説明:
  6    惑星のデータベースはSI単位系を使用しています。内部的には、このプログラムは天文単位(AU)、日、太陽質量を使用します。
  7    デフォルトの太陽と地球の計算は重心系で初期化されるため、全体の線形運動量はゼロになります。
  8    このプログラムの目的は数値積分の比較であり、高精度な太陽系の位置推算ではありません。
  9"""
 10
 11from __future__ import annotations
 12
 13import argparse
 14import csv
 15from dataclasses import dataclass
 16from pathlib import Path
 17
 18import matplotlib.pyplot as plt
 19import numpy as np
 20
 21
 22G_SI = 6.67259e-11
 23DAY = 24.0 * 60.0 * 60.0
 24AU = 1.49597870e11
 25M_SUN = 1.99e30
 26G = G_SI * DAY**2 * M_SUN / AU**3  # AU^3 / (solar mass day^2)
 27
 28
 29@dataclass(frozen=True)
 30class Body:
 31    """
 32    概要:
 33        天体の情報を保持するデータクラスです。
 34    詳細説明:
 35        データベースから読み込まれた天体の名前、質量、軌道半径、速度を格納します。
 36    引数:
 37        :param name: 天体の名前
 38        :type name: str
 39        :param mass: 太陽質量を単位とする天体の質量
 40        :type mass: float
 41        :param radius: 天文単位(AU)を単位とする初期の太陽との距離
 42        :type radius: float
 43        :param speed: AU/日を単位とする初期の相対的な接線速度
 44        :type speed: float
 45    """
 46    name: str
 47    mass: float  # solar masses
 48    radius: float  # AU, initial Sun-body separation
 49    speed: float  # AU/day, initial relative tangential speed
 50
 51
 52@dataclass
 53class Trajectory:
 54    """
 55    概要:
 56        計算された軌道データを保持するデータクラスです。
 57    詳細説明:
 58        数値積分によって得られた時間、位置、速度、エネルギー、角運動量の履歴を格納します。
 59    引数:
 60        :param name: 数値積分手法の名前
 61        :type name: str
 62        :param time: 経過時間の配列
 63        :type time: numpy.ndarray
 64        :param position: 各時刻における位置の配列
 65        :type position: numpy.ndarray
 66        :param velocity: 各時刻における速度の配列
 67        :type velocity: numpy.ndarray
 68        :param energy: 各時刻における総エネルギーの配列
 69        :type energy: numpy.ndarray
 70        :param angular_momentum: 各時刻におけるz軸周りの角運動量の配列
 71        :type angular_momentum: numpy.ndarray
 72    """
 73    name: str
 74    time: np.ndarray
 75    position: np.ndarray
 76    velocity: np.ndarray
 77    energy: np.ndarray
 78    angular_momentum: np.ndarray
 79
 80
 81def read_planet_db(filename: Path) -> dict[str, Body]:
 82    """
 83    概要:
 84        惑星のCSVデータベースを読み込みます。
 85    詳細説明:
 86        指定されたファイルから天体の情報を読み込み、内部単位系に変換してBodyオブジェクトの辞書を作成します。
 87    引数:
 88        :param filename: 読み込むCSVファイルのパス
 89        :type filename: pathlib.Path
 90    戻り値:
 91        :returns: 天体の名前をキーとし、Bodyオブジェクトを値とする辞書
 92        :rtype: dict
 93    """
 94    bodies: dict[str, Body] = {}
 95    with filename.open(newline="", encoding="utf-8") as stream:
 96        for row in csv.DictReader(stream):
 97            bodies[row["Name"]] = Body(
 98                row["Name"], float(row["Mass"]) / M_SUN,
 99                float(row["Revolution Radius"]) / AU,
100                float(row["Revolution Velocity"]) * DAY / AU,
101            )
102    return bodies
103
104
105def initial_state(database: dict[str, Body], selected_names: list[str]
106                  ) -> tuple[list[str], np.ndarray, np.ndarray, np.ndarray]:
107    """
108    概要:
109        指定された惑星と太陽の初期状態を設定します。
110    詳細説明:
111        意図的に単純化された初期条件を設定し、重心系に変換することで運動量と重心位置をゼロにします。
112    引数:
113        :param database: 読み込まれた天体データベース
114        :type database: dict
115        :param selected_names: シミュレーション対象として選択された惑星の名前のリスト
116        :type selected_names: list
117    戻り値:
118        :returns: 天体の名前のリスト、質量の配列、初期位置の配列、初期速度の配列のタプル
119        :rtype: tuple
120    例外:
121        :raises ValueError: 太陽がデータベースに存在しないか、未知の惑星名が指定された場合に発生します。
122    """
123    if "Sun" not in database:
124        raise ValueError("planet database must contain Sun")
125    missing = [name for name in selected_names if name not in database or name == "Sun"]
126    if missing:
127        raise ValueError(f"unknown planet name(s): {', '.join(missing)}")
128
129    names = ["Sun", *selected_names]
130    masses = np.asarray([database[name].mass for name in names])
131    position = np.zeros((len(names), 2))
132    velocity = np.zeros((len(names), 2))
133    # Each planet begins at +x with a +y tangential velocity.  This is a
134    # deliberately simple initial condition, not a real ephemeris.
135    for i, name in enumerate(selected_names, start=1):
136        body = database[name]
137        position[i, 0] = body.radius
138        velocity[i, 1] = body.speed
139    # Shift to the centre-of-mass frame so momentum and centre of mass vanish.
140    position -= np.average(position, axis=0, weights=masses)
141    velocity -= np.average(velocity, axis=0, weights=masses)
142    return names, masses, position, velocity
143
144
145def acceleration(position: np.ndarray, masses: np.ndarray) -> np.ndarray:
146    """
147    概要:
148        ニュートン力学に基づくN体の加速度を計算します。
149    詳細説明:
150        万有引力の法則を用いて各天体間の相互作用を計算し、加速度の配列を返します。単位はAU/day^2です。
151    引数:
152        :param position: 各天体の位置の配列
153        :type position: numpy.ndarray
154        :param masses: 各天体の質量の配列
155        :type masses: numpy.ndarray
156    戻り値:
157        :returns: 加速度の配列
158        :rtype: numpy.ndarray
159    例外:
160        :raises FloatingPointError: 2つの天体が同じ位置にあり衝突した場合に発生します。
161    """
162    nbody = len(masses)
163    acc = np.zeros_like(position)
164    for i in range(nbody - 1):
165        for j in range(i + 1, nbody):
166            dr = position[j] - position[i]
167            r2 = float(np.dot(dr, dr))
168            if r2 == 0.0:
169                raise FloatingPointError("collision: two bodies occupy the same position")
170            inv_r3 = r2 ** -1.5
171            acc[i] += G * masses[j] * dr * inv_r3
172            acc[j] -= G * masses[i] * dr * inv_r3
173    return acc
174
175
176def rhs(position: np.ndarray, velocity: np.ndarray, masses: np.ndarray
177        ) -> tuple[np.ndarray, np.ndarray]:
178    """
179    概要:
180        常微分方程式の右辺を計算します。
181    詳細説明:
182        位置の微分である速度と、速度の微分である加速度をまとめて返します。
183    引数:
184        :param position: 各天体の位置の配列
185        :type position: numpy.ndarray
186        :param velocity: 各天体の速度の配列
187        :type velocity: numpy.ndarray
188        :param masses: 各天体の質量の配列
189        :type masses: numpy.ndarray
190    戻り値:
191        :returns: 速度の配列と加速度の配列のタプル
192        :rtype: tuple
193    """
194    return velocity, acceleration(position, masses)
195
196
197def step_euler(position: np.ndarray, velocity: np.ndarray, dt: float,
198               masses: np.ndarray) -> tuple[np.ndarray, np.ndarray]:
199    """
200    概要:
201        オイラー法を用いて1ステップ分の時間積分を行います。
202    引数:
203        :param position: 現在の位置の配列
204        :type position: numpy.ndarray
205        :param velocity: 現在の速度の配列
206        :type velocity: numpy.ndarray
207        :param dt: 時間ステップ幅
208        :type dt: float
209        :param masses: 各天体の質量の配列
210        :type masses: numpy.ndarray
211    戻り値:
212        :returns: 次のステップの位置と速度のタプル
213        :rtype: tuple
214    """
215    _, acc = rhs(position, velocity, masses)
216    return position + dt * velocity, velocity + dt * acc
217
218
219def step_heun(position: np.ndarray, velocity: np.ndarray, dt: float,
220              masses: np.ndarray) -> tuple[np.ndarray, np.ndarray]:
221    """
222    概要:
223        ホイン法を用いて1ステップ分の時間積分を行います。
224    引数:
225        :param position: 現在の位置の配列
226        :type position: numpy.ndarray
227        :param velocity: 現在の速度の配列
228        :type velocity: numpy.ndarray
229        :param dt: 時間ステップ幅
230        :type dt: float
231        :param masses: 各天体の質量の配列
232        :type masses: numpy.ndarray
233    戻り値:
234        :returns: 次のステップの位置と速度のタプル
235        :rtype: tuple
236    """
237    k1_r, k1_v = rhs(position, velocity, masses)
238    k2_r, k2_v = rhs(position + dt * k1_r, velocity + dt * k1_v, masses)
239    return position + 0.5 * dt * (k1_r + k2_r), velocity + 0.5 * dt * (k1_v + k2_v)
240
241
242def step_rk4(position: np.ndarray, velocity: np.ndarray, dt: float,
243             masses: np.ndarray) -> tuple[np.ndarray, np.ndarray]:
244    """
245    概要:
246        4次のルンゲクッタ法を用いて1ステップ分の時間積分を行います。
247    引数:
248        :param position: 現在の位置の配列
249        :type position: numpy.ndarray
250        :param velocity: 現在の速度の配列
251        :type velocity: numpy.ndarray
252        :param dt: 時間ステップ幅
253        :type dt: float
254        :param masses: 各天体の質量の配列
255        :type masses: numpy.ndarray
256    戻り値:
257        :returns: 次のステップの位置と速度のタプル
258        :rtype: tuple
259    """
260    k1_r, k1_v = rhs(position, velocity, masses)
261    k2_r, k2_v = rhs(position + 0.5 * dt * k1_r, velocity + 0.5 * dt * k1_v, masses)
262    k3_r, k3_v = rhs(position + 0.5 * dt * k2_r, velocity + 0.5 * dt * k2_v, masses)
263    k4_r, k4_v = rhs(position + dt * k3_r, velocity + dt * k3_v, masses)
264    return (position + dt * (k1_r + 2.0 * k2_r + 2.0 * k3_r + k4_r) / 6.0,
265            velocity + dt * (k1_v + 2.0 * k2_v + 2.0 * k3_v + k4_v) / 6.0)
266
267
268def step_velocity_verlet(position: np.ndarray, velocity: np.ndarray, dt: float,
269                         masses: np.ndarray) -> tuple[np.ndarray, np.ndarray]:
270    """
271    概要:
272        速度ベルレ法を用いて1ステップ分の時間積分を行います。
273    引数:
274        :param position: 現在の位置の配列
275        :type position: numpy.ndarray
276        :param velocity: 現在の速度の配列
277        :type velocity: numpy.ndarray
278        :param dt: 時間ステップ幅
279        :type dt: float
280        :param masses: 各天体の質量の配列
281        :type masses: numpy.ndarray
282    戻り値:
283        :returns: 次のステップの位置と速度のタプル
284        :rtype: tuple
285    """
286    acc_old = acceleration(position, masses)
287    position_new = position + dt * velocity + 0.5 * dt**2 * acc_old
288    acc_new = acceleration(position_new, masses)
289    velocity_new = velocity + 0.5 * dt * (acc_old + acc_new)
290    return position_new, velocity_new
291
292
293STEPPERS = {
294    "Euler": step_euler,
295    "Heun (RK2)": step_heun,
296    "RK4": step_rk4,
297    "velocity Verlet": step_velocity_verlet,
298}
299
300
301def total_energy(position: np.ndarray, velocity: np.ndarray, masses: np.ndarray) -> float:
302    """
303    概要:
304        系の全エネルギーを計算します。
305    詳細説明:
306        運動エネルギーとポテンシャルエネルギーの合計を計算して返します。
307    引数:
308        :param position: 各天体の位置の配列
309        :type position: numpy.ndarray
310        :param velocity: 各天体の速度の配列
311        :type velocity: numpy.ndarray
312        :param masses: 各天体の質量の配列
313        :type masses: numpy.ndarray
314    戻り値:
315        :returns: 計算された全エネルギー
316        :rtype: float
317    """
318    kinetic = 0.5 * float(np.sum(masses[:, None] * velocity**2))
319    potential = 0.0
320    for i in range(len(masses) - 1):
321        for j in range(i + 1, len(masses)):
322            potential -= G * masses[i] * masses[j] / float(np.linalg.norm(position[j] - position[i]))
323    return kinetic + potential
324
325
326def angular_momentum_z(position: np.ndarray, velocity: np.ndarray, masses: np.ndarray) -> float:
327    """
328    概要:
329        z軸周りの系の全角運動量を計算します。
330    引数:
331        :param position: 各天体の位置の配列
332        :type position: numpy.ndarray
333        :param velocity: 各天体の速度の配列
334        :type velocity: numpy.ndarray
335        :param masses: 各天体の質量の配列
336        :type masses: numpy.ndarray
337    戻り値:
338        :returns: 計算されたz軸周りの角運動量
339        :rtype: float
340    """
341    return float(np.sum(masses * (position[:, 0] * velocity[:, 1] - position[:, 1] * velocity[:, 0])))
342
343
344def integrate(name: str, stepper, position0: np.ndarray, velocity0: np.ndarray,
345              masses: np.ndarray, dt: float, nsteps: int) -> Trajectory:
346    """
347    概要:
348        指定された積分手法を用いて系の時間発展を計算します。
349    詳細説明:
350        初期状態から指定されたステップ数だけシミュレーションを行い、結果をTrajectoryオブジェクトに格納します。
351    引数:
352        :param name: 積分手法の名称
353        :type name: str
354        :param stepper: 1ステップの積分を行う関数
355        :type stepper: callable
356        :param position0: 初期位置の配列
357        :type position0: numpy.ndarray
358        :param velocity0: 初期速度の配列
359        :type velocity0: numpy.ndarray
360        :param masses: 各天体の質量の配列
361        :type masses: numpy.ndarray
362        :param dt: 時間ステップ幅
363        :type dt: float
364        :param nsteps: 実行するステップ数
365        :type nsteps: int
366    戻り値:
367        :returns: 計算結果を含むTrajectoryオブジェクト
368        :rtype: Trajectory
369    """
370    nbody = len(masses)
371    time = dt * np.arange(nsteps + 1)
372    position = np.empty((nsteps + 1, nbody, 2))
373    velocity = np.empty_like(position)
374    energy = np.empty(nsteps + 1)
375    angular_momentum = np.empty(nsteps + 1)
376    position[0], velocity[0] = position0.copy(), velocity0.copy()
377    energy[0] = total_energy(position[0], velocity[0], masses)
378    angular_momentum[0] = angular_momentum_z(position[0], velocity[0], masses)
379    for step in range(nsteps):
380        position[step + 1], velocity[step + 1] = stepper(position[step], velocity[step], dt, masses)
381        energy[step + 1] = total_energy(position[step + 1], velocity[step + 1], masses)
382        angular_momentum[step + 1] = angular_momentum_z(position[step + 1], velocity[step + 1], masses)
383    return Trajectory(name, time, position, velocity, energy, angular_momentum)
384
385
386def print_summary(trajectories: list[Trajectory]) -> None:
387    """
388    概要:
389        シミュレーション結果の概要をコンソールに出力します。
390    詳細説明:
391        各積分手法におけるエネルギーおよび角運動量の相対誤差を出力します。
392    引数:
393        :param trajectories: 各積分手法のTrajectoryオブジェクトを格納したリスト
394        :type trajectories: list
395    戻り値:
396        :returns: なし
397        :rtype: None
398    """
399    print("\n=== Planet integrator comparison ===")
400    print(f"{'method':<18s} {'final dE/E0':>15s} {'max |dE/E0|':>16s} "
401          f"{'final dL/L0':>15s}")
402    print("-" * 70)
403    for trajectory in trajectories:
404        rel_e = (trajectory.energy - trajectory.energy[0]) / abs(trajectory.energy[0])
405        rel_l = (trajectory.angular_momentum[-1] - trajectory.angular_momentum[0]) / abs(trajectory.angular_momentum[0])
406        print(f"{trajectory.name:<18s} {rel_e[-1]:15.6e} {np.max(np.abs(rel_e)):16.6e} {rel_l:15.6e}")
407
408
409def plot_results(trajectories: list[Trajectory], names: list[str], planet_index: int,
410                 years: float, dt: float) -> plt.Figure:
411    """
412    概要:
413        シミュレーション結果をグラフにプロットします。
414    詳細説明:
415        相対軌道、エネルギー誤差、角運動量誤差の比較グラフを生成します。
416    引数:
417        :param trajectories: 各積分手法のTrajectoryオブジェクトを格納したリスト
418        :type trajectories: list
419        :param names: 天体の名前のリスト
420        :type names: list
421        :param planet_index: 軌道をプロットする対象惑星のインデックス
422        :type planet_index: int
423        :param years: シミュレーションの期間
424        :type years: float
425        :param dt: 時間ステップ幅
426        :type dt: float
427    戻り値:
428        :returns: 生成されたmatplotlibのFigureオブジェクト
429        :rtype: matplotlib.figure.Figure
430    """
431    colors = {"Euler": "tab:red", "Heun (RK2)": "tab:orange",
432              "RK4": "tab:green", "velocity Verlet": "tab:blue"}
433    figure, axes = plt.subplots(2, 2, figsize=(12.5, 9.0))
434    ax_orbit, ax_energy, ax_energy_abs, ax_momentum = axes.flat
435    sun_index = 0
436    for trajectory in trajectories:
437        color = colors[trajectory.name]
438        relative = trajectory.position[:, planet_index] - trajectory.position[:, sun_index]
439        time_years = trajectory.time / 365.25
440        rel_e = (trajectory.energy - trajectory.energy[0]) / abs(trajectory.energy[0])
441        rel_l = (trajectory.angular_momentum - trajectory.angular_momentum[0]) / abs(trajectory.angular_momentum[0])
442        ax_orbit.plot(relative[:, 0], relative[:, 1], label=trajectory.name, color=color, lw=1.5)
443        ax_energy.plot(time_years, rel_e, label=trajectory.name, color=color, lw=1.3)
444        ax_energy_abs.semilogy(time_years, np.maximum(np.abs(rel_e), 1e-18),
445                               label=trajectory.name, color=color, lw=1.3)
446        ax_momentum.plot(time_years, rel_l, label=trajectory.name, color=color, lw=1.3)
447
448    ax_orbit.scatter([0.0], [0.0], c="gold", edgecolors="black", s=80, label="Sun")
449    ax_orbit.set(aspect="equal", xlabel="relative x (AU)", ylabel="relative y (AU)",
450                 title=f"{names[planet_index]} orbit relative to the Sun")
451    ax_orbit.grid(alpha=0.25)
452    ax_orbit.legend(fontsize=8)
453
454    ax_energy.axhline(0.0, color="0.65", lw=0.8)
455    ax_energy.set(xlabel="time (years)", ylabel=r"$(E-E_0)/|E_0|$",
456                  title="Signed relative energy error")
457    ax_energy.grid(alpha=0.25)
458    ax_energy.legend(fontsize=8)
459
460    ax_energy_abs.set(xlabel="time (years)", ylabel=r"$|(E-E_0)/E_0|$",
461                      title="Absolute relative energy error (log scale)")
462    ax_energy_abs.grid(alpha=0.25, which="both")
463    ax_energy_abs.legend(fontsize=8)
464
465    ax_momentum.axhline(0.0, color="0.65", lw=0.8)
466    ax_momentum.set(xlabel="time (years)", ylabel=r"$(L_z-L_{z,0})/|L_{z,0}|$",
467                    title="Relative angular-momentum error")
468    ax_momentum.grid(alpha=0.25)
469    ax_momentum.legend(fontsize=8)
470
471    figure.suptitle(f"Newtonian planet integration: dt={dt:g} day, duration={years:g} year", fontsize=14)
472    figure.tight_layout(rect=(0, 0, 1, 0.95))
473    return figure
474
475
476def parse_args() -> argparse.Namespace:
477    """
478    概要:
479        コマンドライン引数を解析します。
480    戻り値:
481        :returns: 解析されたコマンドライン引数を格納したNamespaceオブジェクト
482        :rtype: argparse.Namespace
483    """
484    default_db = Path(__file__).with_name("planet_db.csv")
485    parser = argparse.ArgumentParser(description=__doc__)
486    parser.add_argument("--db", type=Path, default=default_db, help="planet CSV database")
487    parser.add_argument("--planets", type=str, default="Earth",
488                        help="comma-separated planets besides Sun, e.g. Mercury,Earth,Mars")
489    parser.add_argument("--plot-planet", type=str, default=None,
490                        help="planet shown in the orbit panel (default: first selected)")
491    parser.add_argument("--dt", type=float, default=5.0, help="common time step (days)")
492    parser.add_argument("--years", type=float, default=30.0, help="simulation duration (years)")
493    parser.add_argument("--output", type=Path, default=None, help="optional output figure")
494    parser.add_argument("--dpi", type=int, default=160)
495    parser.add_argument("--no-show", action="store_true")
496    return parser.parse_args()
497
498
499def main() -> None:
500    """
501    概要:
502        プログラムのメイン処理を実行します。
503    詳細説明:
504        コマンドライン引数の解析、データベースの読み込み、初期状態の設定、各手法での時間積分、
505        および結果のプロットを行います。
506    戻り値:
507        :returns: なし
508        :rtype: None
509    例外:
510        :raises SystemExit: 不正な引数やデータベースの読み込みエラーが発生した場合に終了します。
511    """
512    args = parse_args()
513    if args.dt <= 0.0 or args.years <= 0.0:
514        raise SystemExit("--dt and --years must be positive")
515    selected = [name.strip() for name in args.planets.split(",") if name.strip()]
516    if not selected:
517        raise SystemExit("select at least one planet")
518    database = read_planet_db(args.db)
519    try:
520        names, masses, position0, velocity0 = initial_state(database, selected)
521    except ValueError as exc:
522        raise SystemExit(str(exc)) from exc
523    plot_name = args.plot_planet or selected[0]
524    if plot_name not in names:
525        raise SystemExit(f"--plot-planet must be one of: {', '.join(selected)}")
526    planet_index = names.index(plot_name)
527    nsteps = int(round(args.years * 365.25 / args.dt))
528    years = nsteps * args.dt / 365.25
529    trajectories = [integrate(name, stepper, position0, velocity0, masses, args.dt, nsteps)
530                    for name, stepper in STEPPERS.items()]
531    print(f"Bodies: {', '.join(names)}; G={G:.10g} AU^3/(M_sun day^2)")
532    print_summary(trajectories)
533    figure = plot_results(trajectories, names, planet_index, years, args.dt)
534    if args.output:
535        figure.savefig(args.output, dpi=args.dpi, bbox_inches="tight")
536        print(f"Saved figure: {args.output}")
537    if args.no_show:
538        plt.close(figure)
539    else:
540        plt.show()
541
542
543if __name__ == "__main__":
544    main()