Files
SPHLite/todo.md
T
2026-07-02 18:47:38 +08:00

8.4 KiB
Raw Blame History

SPHLite TODO

当前目标版本:0.1.0

本文档依据 docs/v1.0_development_plan.md 拆分。0.1.0 只搭建软件框架,不实现生产级 Water、Gas、Explosive、Solid、Shell 物理算法。

阶段 A:工程骨架

  • 创建 0.1.0 规划目录结构。
  • 创建根目录 CMakeLists.txt。
  • 配置 CMake 项目版本为 0.1.0。
  • 配置项目语言为 C 和 Fortran。
  • 配置 Fortran 95 编译标准。
  • 配置 Fortran module 输出目录。
  • 配置 FortranCInterface 名字修饰头生成。
  • 创建 sphlite_core 静态库目标。
  • 创建 sphlite_c 静态库目标。
  • 创建 sphlite 命令行程序目标。
  • 启用 CTest。
  • 添加最小 test_smoke 测试目标占位。

阶段 B:Core 基础模块

  • 实现 src/core/sph_precision.f90。
  • 在 sph_precision 中定义 rk 精度。
  • 在 sph_precision 中定义版本号 0.1.0。
  • 在 sph_precision 中定义 3D 维度常量。
  • 实现 src/core/sph_error.f90。
  • 定义 SPHLite 基础错误码。
  • 实现最近错误码保存。
  • 实现最近错误消息保存。
  • 实现错误清理接口。
  • 实现 src/core/sph_log.f90。
  • 实现日志打开接口。
  • 实现日志关闭接口。
  • 实现基础 info 日志接口。
  • 实现 src/core/sph_control.f90。
  • 定义默认时间控制参数。
  • 定义默认输出控制参数。
  • 实现控制参数默认初始化。

阶段 C:Database 最小状态

  • 实现 src/database/sph_database.f90。
  • 定义 npart 粒子数量。
  • 定义粒子 external id 数组。
  • 定义 phase/status/material/section 数组。
  • 定义 x0(3,npart) 和 x(3,npart)。
  • 定义 v(3,npart)、a(3,npart) 和 vhalf(3,npart)。
  • 定义 mass/rho/volume/pressure/internal_energy/temperature/h 数组。
  • 实现数据库分配接口。
  • 实现数据库默认初始化接口。
  • 实现数据库释放接口。
  • 实现粒子数量查询接口。
  • 定义 phase 常量。
  • 定义 status 常量占位。

阶段 D:API 状态和 Fortran API

  • 实现 src/interface/sph_api_state.f90。
  • 保存 API 初始化状态。
  • 实现 src/interface/sph_api.f90。
  • 实现 sph_initialize。
  • 实现 sph_finalize。
  • 实现 sph_get_version。
  • 实现 sph_get_last_error。
  • 实现 sph_get_particle_count。
  • 实现 sph_get_current_time。
  • 为未实现 API 返回明确错误或占位成功码。

阶段 E:Input 解析框架

  • 实现 src/input/sph_inp_defs.f90。
  • 定义输入关键词识别常量。
  • 实现 src/input/sph_inp_helpers.f90。
  • 实现行清理和大小写规范化工具。
  • 实现逗号分隔字段解析工具。
  • 实现 src/input/sph_input_reader.f90。
  • 实现 .inp 文件打开和逐行读取。
  • 实现 *NODE 最小解析。
  • 实现 *ELEMENT 占位解析。
  • 实现 *NSET 占位解析。
  • 实现 *ELSET 占位解析。
  • 实现 *MATERIAL 占位解析。
  • 实现 *SECTION 占位解析。
  • 实现 *SPHLITE ... 扩展关键词入口。
  • 对不影响运行的未知关键词发出 warning。
  • 对缺失关键数据返回 error。
  • 在 Fortran API 中接入 sph_read_inp。
  • 在 Fortran API 中接入 sph_build_model。

阶段 F:Solver、Output 和 Restart 占位

  • 实现 src/solver/sph_solver_explicit.f90。
  • 实现稳定时间步估计占位。
  • 实现 Velocity-Verlet 最小步进。
  • 在步进中更新时间和步数。
  • 在 Fortran API 中接入 sph_estimate_stable_dt。
  • 在 Fortran API 中接入 sph_advance_explicit。
  • 在 Fortran API 中接入 sph_run_explicit。
  • 实现 src/output/sph_output_csv.f90。
  • 实现输出目录设置占位。
  • 实现输出间隔设置占位。
  • 实现最小 CSV 输出占位。
  • 实现 src/output/sph_restart.f90。
  • 实现 restart 写入占位。
  • 实现 restart 读取占位。

阶段 G:物理模块占位

  • 创建 src/water/sph_water.f90 占位模块。
  • 创建 src/gas/sph_gas.f90 占位模块。
  • 创建 src/explosive/sph_explosive.f90 占位模块。
  • 创建 src/solid/sph_solid.f90 占位模块。
  • 创建 src/shell/sph_shell.f90 占位模块。
  • 创建 src/particle/sph_particle.f90 占位模块。
  • 创建 src/material/sph_material.f90 占位模块。
  • 每个占位模块提供 reset 或 initialize 入口。
  • 确保占位模块不声明生产级物理能力。

阶段 H:CouplingInterface 占位

  • 实现 src/coupling_interface/sph_coupling_interface.f90。
  • 定义 coupling region 占位数据。
  • 实现 coupling particle count 占位接口。
  • 实现 coupling particle 导出占位接口。
  • 实现 coupling facet count 占位接口。
  • 实现 coupling facet 导出占位接口。
  • 实现 coupling particle force 导入占位接口。
  • 实现 coupling facet load 导入占位接口。
  • 添加耦合功和能量诊断占位字段。
  • 保持接口命名中立,不出现 FEMLite 依赖。

阶段 I:C ABI

  • 创建 include/sphlite_c_api.h。
  • 在 C 头文件中定义 phase 常量。
  • 声明生命周期 C API。
  • 声明输入和显式求解 C API。
  • 声明粒子数量查询 C API。
  • 声明输出和 restart C API 占位。
  • 实现 src/interface/sph_c_api.c。
  • 接入 Fortran-C 名字修饰头。
  • 实现 C 字符串到 Fortran 字符串桥接。
  • 实现 C 空指针参数检查。
  • 实现 C 非正容量参数检查。
  • 将 C 参数错误返回 -1。
  • 将 Fortran 错误码原样返回 C 调用方。
  • 创建 tests/interface/test_c_api.c。

阶段 J:CLI

  • 实现 src/app/sph_program.f90。
  • 支持 sphlite model.inp inspect 模式。
  • 支持 sphlite model.inp --run 运行模式。
  • CLI 调用公共生命周期 API。
  • CLI 打印版本号。
  • CLI 打印粒子数量。
  • CLI 打印当前时间和步数。
  • CLI 在错误时打印最近错误消息。
  • CLI 语法风格与 FEMLite 保持一致。

阶段 K:Python 调试入口

  • 创建 Python/sphlite_debug.py。
  • 使用 ctypes 加载 C ABI。
  • 包装生命周期接口。
  • 包装 read_inp。
  • 包装粒子数量查询。
  • 包装显式运行入口。
  • 创建 tools/testing/test_python_debug.py。
  • Python smoke 读取最小 .inp。
  • Python smoke 查询粒子数量。

阶段 L:测试数据和测试目标

  • 创建 tests/data/minimal_particles.inp。
  • 在最小输入中包含 *NODE。
  • 在最小输入中包含基础 material。
  • 在最小输入中包含基础 section。
  • 在最小输入中包含 *SPHLITE ... 时间控制占位。
  • 创建 tests/unit/test_smoke.f90。
  • test_smoke 覆盖 initialize/finalize。
  • test_smoke 覆盖数据库最小分配。
  • test_smoke 覆盖最小显式步。
  • 创建 tests/module/test_input.f90。
  • test_input 覆盖最小 .inp 解析。
  • test_input 覆盖 unknown keyword warning。
  • test_input 覆盖关键数据缺失 error。
  • 添加 CTest smoke。
  • 添加 CTest input。
  • 添加 CTest c_api。
  • 添加 CTest python_debug。

阶段 M:Source Size 和工具

  • 创建 tools/testing/check_source_size.py。
  • 创建 tests/source_size_exceptions.txt。
  • 设置 Fortran 过程大小检查。
  • 设置 Fortran 源文件大小检查。
  • 设置 C 源文件大小检查。
  • 设置 stale exception 检查。
  • 添加 CTest source_size。

阶段 N:文档同步

  • 更新 README 的当前版本为 0.1.0。
  • 更新 docs/09_release_history.md 的 0.1.0 计划项。
  • 更新 docs/11_benchmark_matrix.md 的 0.1.0 gate。
  • 确认 01-06 文档不声明 0.1.0 已实现物理算法。
  • 记录 0.1.0 不交付范围。

阶段 O:0.1.0 验收

  • 完整配置 CMake。
  • 完整编译 sphlite_core。
  • 完整编译 sphlite_c。
  • 完整编译 sphlite。
  • 运行 ctest -R "^(smoke|input|c_api|python_debug)$"。
  • 运行 ctest -R "^source_size$"。
  • 运行 git diff --check。
  • 确认没有提交 build 目录。
  • 确认没有提交 CSV/VTK/restart 临时结果。
  • 记录 0.1.0 release gate 结果。