Files
SPHLite/docs/08_developer_manual.md
T

56 lines
1.7 KiB
Markdown
Raw Normal View History

2026-07-02 18:47:38 +08:00
# 08 开发者手册
文档状态:规划初稿
## 1. 基本原则
- 只修改 SPHLite 仓库内文件;FEMLite 只作为参考和外部耦合对象。
- 默认采用小步、可测试、可闭环的开发方式。
- 新物理模型必须配套最小测试或 checker。
- 不支持的输入和物理能力必须明确报错。
- 不提交 build、临时结果、大型 CSV/VTK/restart。
- 文档使用 UTF-8 without BOM。
## 2. 构建建议
SPHLite 构建体系应仿照 FEMLite:
- CMake 作为主构建系统。
- CTest 作为测试入口。
- C ABI 作为稳定接口。
- Python3 用于测试脚本和调试入口。
- 可选 OpenMP 用于邻域搜索或接触搜索加速。
## 3. 新增模块流程
新增模块建议遵循:
1. 明确模块边界和数据所有权。
2. 增加最小数据结构和生命周期。
3. 增加单元测试。
4. 增加 C ABI 或内部接口。
5. 增加模块级 smoke。
6. 更新相关文档和 benchmark 矩阵。
## 4. 新增 API 流程
- 优先使用 dimension query + value-fill query。
- 写输出前验证 id、索引和缓冲区容量。
- C ABI 空指针或非正容量返回 `-1`。
- 多维数组展开顺序必须写入接口文档。
- API 不应暴露内部容器指针。
## 5. 耦合开发规则
- 接触耦合和连续体耦合必须分开实现、分开测试。
- FEMLite 适配层不得侵入 SPHLite 核心物理模块。
- 耦合接口应记录质量、动量、能量或功的交换量。
- 第一版不追求复杂强耦合,优先建立可验证的数据契约。
## 6. 待讨论问题
- C++ 标准版本。
- 命名风格和目录风格。
- 单文件和单函数大小限制。
- 是否与 FEMLite 使用相同 release gate 命名。