PASS Logo

Content

  • PASS 文档（中文）
    • 输入文件生成（命令行模式）
      • 简介
      • 架构概览
      • 快速开始
        • 最简示例
      • JSON 文件结构
      • 核心组件
        • MainConfig（全局参数）
        • InjectionItem（注入与分组）
        • BunchConfig（束团参数）
        • Sequence（序列容器）
      • Lattice来源
        • 方式一：从 MADX twiss 文件读取
        • 方式二：从 MADX twiss 文件读取为元件
        • 方式三：平滑近似 twiss
        • 混合模式
      • 外部数据文件转换
        • 四步流水线
        • 一步到位
        • 预置封装
        • 分步调用
      • API 参考
      • 完整示例
    • 图形界面配置流程
      • 空间电荷
      • Twiss 与光学
        • MAD-X 采样方式
        • 单圈传输
        • 平滑近似
        • 手动传输点与后续编辑
    • 注入粒子生成（Injection）
      • 接口参数
      • 束团参数
        • 横向参数
        • 纵向参数
        • 束流参数
        • 分布参数
        • 偏移参数
      • 粒子分布类型简介
      • 横向粒子分布
      • 纵向粒子分布
        • 多束团纵向坐标
        • 束团填充方案
        • 色散耦合
        • 动量偏差
      • 输入文件
      • 运行命令
      • 1D 投影理论曲线
      • 模拟结果
    • 元件（Element）
      • 标记（Marker）
        • 物理说明
        • 接口参数
        • 使用示例
        • 应用场景
      • 漂移节（Drift）
        • 物理推导
        • 接口参数
        • 使用示例
        • 应用场景
      • 二极铁（Dipole / SBend）
        • 坐标约定
        • 整体追踪流程
        • 主体：DKD-exact 模型
        • 主体模型对比
        • 入口边缘：YRotation
        • 入口边缘：边缘场（Fringe Field）
        • 入口边缘：Wedge（边缘角）
        • 边缘角正负号定义
        • 参数列表
        • 使用示例
        • 参考文献
      • 四极铁（Quadrupole）
        • 坐标约定
        • 四极磁场与归一化强度
        • 整体追踪流程
        • 物理推导
        • 色品效应
        • 追踪模型对比
        • 接口参数
        • 使用示例
        • 应用场景
        • 参考文献
      • 六极铁（Sextupole）
        • 坐标约定
        • 六极磁场与归一化强度
        • 整体追踪流程
        • 物理推导
        • 色品校正
        • 自然包含的高阶效应
        • 接口参数
        • 使用示例
        • 应用场景
        • 参考文献
      • 八极铁（Octupole）
        • 坐标约定
        • 八极磁场与归一化强度
        • 整体追踪流程
        • 物理推导
        • 振幅依赖 tune 移
        • 自然包含的高阶效应
        • 接口参数
        • 使用示例
        • 应用场景
        • 参考文献
      • 多极铁（Multipole）
        • 坐标约定
        • 多极磁场与归一化强度
        • 整体追踪流程
        • 物理推导
        • Horner 嵌套求值
        • 精确漂移映射
        • 辛积分器
        • 自然包含的效应
        • 与 Xsuite 的差异：hxl 曲率修正
        • 接口参数
        • 使用示例
        • 应用场景
        • 参考文献
      • 螺线管（Solenoid）
        • 坐标约定
        • 螺线管磁场与归一化强度
        • 物理推导
        • 为什么螺线管没有薄透镜模式
        • 多极场叠加与 SKS 积分器
        • 整体追踪流程
        • 色品效应
        • 接口参数
        • 使用示例
        • 应用场景
      • 冲击磁铁（Kicker）
        • 坐标约定
        • 物理推导
        • 整体追踪流程
        • 精确漂移映射
        • 辛积分器
        • 接口参数
        • 使用示例
        • 应用场景
        • 参考文献
      • 静电偏转板（ElSeparator）
        • 坐标约定
        • 物理推导
        • 薄透镜模式
        • 厚透镜模式（DKD）
        • 薄透镜与厚透镜的 kick 一致性
        • Septum 逻辑
        • Tilt 旋转
        • 整体追踪流程
        • 接口参数
        • 使用示例
        • 应用场景
        • 参考文献
      • 激励器（Exciter）
        • 物理推导
        • 粒子到达时间
        • 频率输入模式
        • 激励模式
        • 各模式完整公式
        • Kick 的施加
        • 参数列表
        • 使用示例
      • 高频加速腔（RFCavity）
        • 坐标约定
        • 物理推导
        • 跟踪流程
        • 接口参数
        • Ramping 数据文件
        • 使用示例
        • 应用场景
        • 验证测试
    • 监视器（Monitor）
      • 统计监视器（StatMonitor）
        • 简介
        • 工作原理
        • 接口参数
        • 输出文件
        • 使用示例
        • 应用场景
      • 分布监视器（DistMonitor）
        • 圈数选择
        • 接口参数
        • 输出内容
        • CPU 与 GPU
      • 相位推进监视器（PhaseAdvanceMonitor）
        • 配置
        • 输出
      • 粒子监视器（ParticleMonitor）
        • 简介
        • 粒子选择机制
        • 记录圈数范围
        • 预分配策略
        • 接口参数
        • 输出文件
        • 使用示例
        • 应用场景
    • 束团重分组（ReorganizeBunch）
      • 功能说明
      • 分组边界
      • 接口参数
      • 使用示例
      • 应用场景
    • 孔径（Aperture）
      • 接口参数
      • 丢失粒子处理
      • 各孔径类型详解
        • off（关闭）
        • default（默认矩形）
        • circle（圆形）
        • rectangle（矩形）
        • ellipse（椭圆）
        • rectcircle（矩形内切圆）
        • rectellipse（矩形内切椭圆）
        • racetrack（跑道形）
        • octagon（八角形）
        • polygon（多边形）
      • 参数总览表
      • 使用示例
    • Twiss 传输（Twiss）
      • 简介
      • 物理推导
        • 纵向传输
        • 色散处理
        • 横向传输矩阵
        • 色品修正
        • 纵向坐标连续性
        • t0 更新
      • 接口参数
        • 位置参数
        • 横向参数
        • 纵向参数
        • 色散与色品
        • 孔径参数
      • 使用示例
      • 应用场景
    • 切片器（Slicer）
      • 职责边界
      • 配置格式
      • 切片模型
      • SliceSet 数据
      • 快照输出
      • 接口参数
        • 通用命令参数
        • 范围模式参数
        • SliceSet 运行时接口
        • 配置校验
    • 空间电荷效应（SpaceCharge）
      • 概念介绍
      • 物理模型
        • 宏粒子电荷与横向源项
        • 积分电势与积分场
        • 相对论横向踢
      • 执行流程
      • 跟踪方法与解析分布
      • 配置示例
      • 接口参数
        • 顶层 Space charge 配置块
        • 命名资源配置
        • SpaceCharge 序列命令
      • 网格范围与孔径校验
      • 配置与校验规则
      • 诊断输出
      • 验证文件组织
      • 运行验证套件
      • 解析诊断与验证
    • 横向场求解器
      • 概念介绍
      • PIC 数据流
      • 网格与源项
        • 均匀节点网格
        • 电荷沉积
      • Poisson 方程与单位
      • 场求解器选择
        • 有限差分：fd
        • 正弦变换：dst_rectangle
        • 自由空间 Green 函数：fft_free_space
        • 场梯度
      • 孔径接口
      • Python 接口
        • 网格与 PIC 流水线
        • 求解器构建器与一次性封装
      • 结果对象
      • 解析跟踪与参考场
        • 源电荷、坐标与单位
        • 圆高斯：gaussian_round_free_space
        • 椭圆高斯：gaussian_ellipse_free_space
        • 均匀圆盘：uniform_round_free_space
        • 均匀椭圆：uniform_ellipse_free_space
        • frozen 与 quasi-frozen 的参数选择
        • 直接调用公式示例
        • Python 接口与数值稳定性
      • 高效网格数建议
      • 选择建议与限制
  • PASS Documentation (English)
    • Input File Generation (Command-Line Mode)
      • Introduction
      • Architecture Overview
      • Quick Start
        • Minimal Example
      • JSON File Structure
      • Core Components
        • MainConfig (Global Parameters)
        • InjectionItem (Injection and Grouping)
        • BunchConfig (Bunch Parameters)
        • Sequence (Sequence Container)
      • Lattice Sources
        • Method 1: Read from MADX twiss file
        • Method 2: Read from MADX twiss file as elements
        • Method 3: Smooth approximation twiss
        • Mixed Mode
      • External Data File Conversion
        • Four-Step Pipeline
        • One-Step Conversion
        • Pre-packaged Wrappers
        • Step-by-Step Invocation
      • API Reference
      • Complete Example
    • Graphical configuration workflow
      • Space charge
      • Twiss and optics
        • MAD-X sampling
        • One-turn transfer
        • Smooth approximation
        • Manual transport points and subsequent editing
    • Injection / Particle Generation
      • Interface parameters
      • Bunch parameters
        • Transverse parameters
        • Longitudinal parameters
        • Beam parameters
        • Distribution parameters
        • Offset parameters
      • Introduction to particle distribution types
      • Transverse particle distribution
      • Longitudinal particle distribution
        • Multi-bunch Longitudinal Coordinates
        • Bunch filling scheme
        • Dispersion coupling
        • Momentum deviation
      • Input file
      • Run command
      • 1D projection theoretical curves
      • Simulation results
    • Element
      • Marker
        • Physical Description
        • Interface Parameters
        • Usage Examples
        • Application Scenarios
      • Drift
        • Physical Derivation
        • Interface Parameters
        • Usage Examples
        • Application Scenarios
      • Dipole (SBend)
        • Coordinate Convention
        • Overall Tracking Flow
        • Body: DKD-exact Model
        • Body Model Comparison
        • Entrance Edge: YRotation
        • Entrance Edge: Fringe Field
        • Entrance Edge: Wedge (Edge Angle)
        • Edge Angle Sign Convention
        • Parameter List
        • Usage Examples
        • References
      • Quadrupole
        • Coordinate Convention
        • Quadrupole Field and Normalized Strength
        • Overall Tracking Flow
        • Physical Derivation
        • Chromaticity Effects
        • Tracking Model Comparison
        • Interface Parameters
        • Usage Examples
        • Application Scenarios
        • References
      • Sextupole
        • Coordinate Convention
        • Sextupole Field and Normalized Strength
        • Overall Tracking Flow
        • Physical Derivation
        • Chromaticity Correction
        • Naturally Included Higher-Order Effects
        • Interface Parameters
        • Usage Examples
        • Application Scenarios
        • References
      • Octupole
        • Coordinate Convention
        • Octupole Field and Normalized Strength
        • Overall Tracking Flow
        • Physical Derivation
        • Amplitude-Dependent Tune Shift
        • Naturally Included Higher-Order Effects
        • Interface Parameters
        • Usage Examples
        • Application Scenarios
        • References
      • Multipole
        • Coordinate Convention
        • Multipole Field and Normalized Strength
        • Overall Tracking Flow
        • Physical Derivation
        • Horner Nested Evaluation
        • Exact Drift Map
        • Symplectic Integrators
        • Naturally Included Effects
        • Difference from Xsuite: hxl Curvature Correction
        • Interface Parameters
        • Usage Examples
        • Application Scenarios
        • References
      • Solenoid
        • Coordinate Convention
        • Solenoid Field and Normalized Strength
        • Physical Derivation
        • Why the Solenoid Has No Thin Lens Mode
        • Multipole Field Overlay and SKS Integrator
        • Overall Tracking Flow
        • Chromaticity Effects
        • Interface Parameters
        • Usage Examples
        • Application Scenarios
      • Kicker
        • Coordinate Convention
        • Physical Derivation
        • Overall Tracking Flow
        • Exact Drift Map
        • Symplectic Integrators
        • Interface Parameters
        • Usage Examples
        • Application Scenarios
        • References
      • ElSeparator
        • Coordinate Convention
        • Physical Derivation
        • Thin Lens Mode
        • Thick Lens Mode (DKD)
        • Kick Consistency Between Thin Lens and Thick Lens
        • Septum Logic
        • Tilt Rotation
        • Overall Tracking Flow
        • Interface Parameters
        • Usage Examples
        • Application Scenarios
        • References
      • Exciter
        • Physical Derivation
        • Particle Arrival Time
        • Frequency Input Modes
        • Excitation Modes
        • Complete Formulas for Each Mode
        • Kick Application
        • Parameter List
        • Usage Examples
      • RFCavity
        • Coordinate Convention
        • Physical Derivation
        • Tracking Flow
        • Interface Parameters
        • Ramping Data File
        • Usage Examples
        • Application Scenarios
        • Verification Tests
    • Monitor
      • StatMonitor
        • Introduction
        • Working Principle
        • Interface Parameters
        • Output Files
        • Usage Example
        • Application Scenarios
      • DistMonitor
        • Turn selection
        • Interface
        • Output
        • CPU and GPU behavior
      • PhaseAdvanceMonitor
        • Configuration
        • Output
      • ParticleMonitor
        • Introduction
        • Particle Selection Mechanism
        • Recorded Turn Range
        • Pre-allocation Strategy
        • Interface Parameters
        • Output Files
        • Usage Example
        • Application Scenarios
    • Bunch Regrouping (ReorganizeBunch)
      • Operation
      • Group Boundaries
      • Interface Parameters
      • Usage Example
      • Applications
    • Aperture
      • Interface Parameters
      • Lost Particle Handling
      • Detailed Aperture Types
        • off (Disabled)
        • default (Default Rectangle)
        • circle (Circular)
        • rectangle (Rectangular)
        • ellipse (Elliptical)
        • rectcircle (Rectangle Inscribed Circle)
        • rectellipse (Rectangle Inscribed Ellipse)
        • racetrack (Racetrack)
        • octagon (Octagonal)
        • polygon (Polygon)
      • Parameter Summary Table
      • Usage Example
    • Twiss Transport (Twiss)
      • Introduction
      • Physics Derivation
        • Longitudinal Transport
        • Dispersion Handling
        • Transverse Transport Matrix
        • Chromaticity Correction
        • Longitudinal Coordinate Continuity
        • t0 Update
      • Interface Parameters
        • Position Parameters
        • Transverse Parameters
        • Longitudinal Parameters
        • Dispersion and Chromaticity
        • Aperture Parameters
      • Usage Example
      • Application Scenarios
    • Slicer
      • Responsibilities
      • Configuration
      • Slice models
      • SliceSet data
      • Snapshots
      • Interface Parameters
        • Common command parameters
        • Range-mode parameters
        • SliceSet runtime interface
        • Configuration validation
    • Space-Charge Effect (SpaceCharge)
      • Introduction
      • Physical Model
        • Macroparticle charge and transverse source
        • Integrated potential and field
        • Relativistic transverse kick
      • Execution Workflow
      • Tracking Methods and Analytic Profiles
      • Configuration Example
      • Interface Parameters
        • Top-level Space charge block
        • Named resource configuration
        • SpaceCharge sequence command
      • Grid Extent and Aperture Validation
      • Configuration Rules
      • Diagnostic Output
      • Validation Layout
      • Running the Validation Suite
      • Analytic Diagnostics and Validation
    • Transverse Field Solvers
      • Introduction
      • PIC Data Flow
      • Grid and Source Definition
        • Uniform nodal grid
        • Charge deposition
      • Poisson Equation and Units
      • Field-Solver Selection
        • Finite difference: fd
        • Sine transform: dst_rectangle
        • Free-space Green function: fft_free_space
        • Field gradients
      • Aperture Interface
      • Python Interfaces
        • Geometry and PIC pipeline
        • Solver builders and one-shot wrappers
      • Result Objects
      • Analytic Tracking and Reference Fields
        • Source charge, coordinates, and units
        • Round Gaussian: gaussian_round_free_space
        • Elliptic Gaussian: gaussian_ellipse_free_space
        • Uniform disk: uniform_round_free_space
        • Uniform ellipse: uniform_ellipse_free_space
        • Frozen and quasi-frozen parameter selection
        • Direct formula example
        • Python interfaces and numerical stability
      • Efficient Grid Sizes
      • Selection Guidance and Limitations
PASS
  • Search

© Copyright 2025-2026 Institute of Modern Physics, Chinese Academy of Sciences.

Built with Sphinx using a theme provided by Read the Docs.