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

nbody_docstring.py をダウンロード

nbody_docstring.py
nbody_docstring.py
  1ご提示いただいたプロンプトの末尾にソースコードが含まれていなかったため、ファイル名 `nbody_docstring.py` から推測したN体シミュレーションのサンプルコードをこちらで用意し、厳格な指定ルールに完全準拠したDocstringを付与しました。
  2
  3以下が完成版のコード全体です。
  4
  5```python
  6"""
  7概要:
  8    N体シミュレーションの計算を行うモジュールです。
  9
 10詳細説明:
 11    パーティクルの位置と速度を計算するための基本的なクラスと関数を提供します。
 12    2次元空間での単純な重力相互作用を計算するためのロジックを含みます。
 13
 14関連リンク:
 15    nbody_docstring_usage
 16"""
 17
 18import math
 19
 20class Particle:
 21    """
 22    概要:
 23        N体シミュレーション用のパーティクルを表すデータクラスです。
 24
 25    詳細説明:
 26        2次元空間上の位置、質量、および速度を保持します。
 27        インスタンス化された時点での速度の初期値は0.0に設定されます。
 28
 29    引数:
 30        :param x: X座標の初期位置
 31        :type x: float
 32        :param y: Y座標の初期位置
 33        :type y: float
 34        :param mass: パーティクルの質量
 35        :type mass: float
 36    """
 37    def __init__(self, x, y, mass):
 38        self.x = x
 39        self.y = y
 40        self.mass = mass
 41        self.vx = 0.0
 42        self.vy = 0.0
 43
 44
 45def compute_force(p1, p2, g_const):
 46    """
 47    概要:
 48        2つのパーティクル間に働く重力を計算します。
 49
 50    詳細説明:
 51        ニュートンの万有引力の法則を用いて、p1がp2から受ける力を計算します。
 52        2つのパーティクルの距離が完全に0の場合は、ゼロ割りを防ぐために力を0.0として返します。
 53
 54    引数:
 55        :param p1: 力を受ける対象のパーティクル
 56        :type p1: Particle
 57        :param p2: 力を及ぼす対象のパーティクル
 58        :type p2: Particle
 59        :param g_const: 重力定数
 60        :type g_const: float
 61
 62    戻り値:
 63        :returns: X方向の力とY方向の力のタプル
 64        :rtype: tuple
 65    """
 66    dx = p2.x - p1.x
 67    dy = p2.y - p1.y
 68    dist_sq = dx * dx + dy * dy
 69    
 70    if dist_sq == 0.0:
 71        return 0.0, 0.0
 72        
 73    dist = math.sqrt(dist_sq)
 74    force = (g_const * p1.mass * p2.mass) / dist_sq
 75    fx = force * (dx / dist)
 76    fy = force * (dy / dist)
 77    
 78    return fx, fy
 79
 80
 81def update_velocity(particle, fx, fy, dt):
 82    """
 83    概要:
 84        パーティクルに加わる力と微小時間を用いて速度を更新します。
 85
 86    詳細説明:
 87        運動方程式に基づいて、パーティクルの現在の速度に対して加速度と時間dtを掛けた値を加算します。
 88        計算結果は引数のparticleオブジェクトに直接反映されます。
 89
 90    引数:
 91        :param particle: 速度を更新する対象のパーティクル
 92        :type particle: Particle
 93        :param fx: X方向の力
 94        :type fx: float
 95        :param fy: Y方向の力
 96        :type fy: float
 97        :param dt: タイムステップ
 98        :type dt: float
 99
100    戻り値:
101        :returns: なし
102        :rtype: None
103    """
104    ax = fx / particle.mass
105    ay = fy / particle.mass
106    particle.vx += ax * dt
107    particle.vy += ay * dt
108```