AlgoPlasma

Open Algorithms for Plasma Modeling

AlgoPlasma

AlgoPlasma 致力于把等离子体建模中分散、重复实现的核心算法，沉淀为开放、可复用、可测试、可解释的算法库。

快速入门查看示例查看测试术语表 GitHub 源码 Gitee 源码

配图来自基于 AlgoPlasma 搭建的 AP-PIC-HET-3D 程序。
Physical Review E 114, 035211 (2026).

算法模块

API 索引

A_Pusher粒子推进 B_Scatter粒子到网格沉积 C_Gather网格到粒子插值 D_PoissonPoisson 求解 E_MaxwellMaxwell F_IO数据输入输出 G_Collision碰撞模型 H_MPI_ExchangeMPI 数据交换 I_Initializer初始化 J_Fluid流体算法 K_Diagnostics探针诊断与信号反演

测试文档

测试位于 tests/，包含编译、运行、清理脚本和验证说明。修改算法后建议先运行对应局部测试。

进入 Tests 总览

术语与维护

术语表统一网格、粒子和并行词汇；维护清单用于检查语言切换、API 包裹和 Sphinx warning。

打开维护清单

文档构建

文档基于 Sphinx、Doxygen 和 Breathe 构建，源文件位于 docs/source/。

cd docs
./make.sh

默认自动选择并行编译线程。

Open Algorithms for Plasma Modeling

AlgoPlasma

AlgoPlasma turns scattered and repeatedly reimplemented core algorithms for plasma modeling into an open, reusable, tested, and explainable algorithm library.

Quick Start View Examples View Tests Glossary GitHub Source Gitee Source

Image rendered from an AP-PIC-HET-3D program built on AlgoPlasma.
Physical Review E 114, 035211 (2026).

Algorithm Modules

API Index

A_PusherParticle pushers B_ScatterParticle-to-grid deposition C_GatherGrid-to-particle interpolation D_PoissonPoisson solvers E_MaxwellMaxwell F_IOData input and output G_CollisionCollision models H_MPI_ExchangeMPI data exchange I_InitializerInitialization J_FluidFluid algorithms K_DiagnosticsProbe diagnostics and signal inversion

Tests

Tests live under tests/ and include build, run, clean scripts, and validation notes. After changing an algorithm, start with its local tests.

Open Tests Overview

Terms and Maintenance

The glossary standardizes grid, particle, and parallel terms; the checklist covers language switches, API wrapping, and Sphinx warnings.

Open Checklist

Documentation

The docs are built with Sphinx, Doxygen, and Breathe. Source files live under docs/source/.

cd docs
./make.sh

Uses automatic parallel build jobs by default.