Files
SPHLite/docs/cclite_worker_api_mapping.md
T
2026-07-05 21:41:34 +08:00

44 lines
2.0 KiB
Markdown

# CCLite Worker API Mapping
文档状态:0.8.x mock 设计稿
本文记录 worker 命令到 SPHLite 现有 API 的映射。当前实现包含动作映射表和真实 IPC 主循环骨架;主循环已接入 `INIT`、`READ_INPUT`、`BUILD_MODEL`、`EXPORT_INTERFACE` 粒子数据块、`IMPORT_LOADS` 粒子力与 contact state 数据块、`ADVANCE`、`WRITE_OUTPUT` 和 `STOP` 的基础路径。
## 1. 命令映射
| Worker 命令 | SPHLite 动作 |
|---|---|
| `INIT` | `INIT_STATE` |
| `READ_INPUT` | `sphlite_read_inp` |
| `BUILD_MODEL` | `sphlite_build_model` |
| `EXPORT_INTERFACE` | `sphlite_coupling_get_region_count` |
| `EXPORT_INTERFACE` | `sphlite_coupling_get_region_info` |
| `EXPORT_INTERFACE` | `sphlite_coupling_export_particles` |
| `EXPORT_INTERFACE` | `sphlite_coupling_export_facets` |
| `IMPORT_LOADS` | `sphlite_coupling_apply_particle_forces` |
| `IMPORT_LOADS` | `sphlite_coupling_apply_facet_pressures` |
| `IMPORT_LOADS` | `sphlite_coupling_apply_facet_tractions` |
| `IMPORT_LOADS` | `sphlite_coupling_apply_facet_resultants` |
| `IMPORT_LOADS` | `sphlite_coupling_apply_contact_state` |
| `IMPORT_LOADS` | `sphlite_coupling_apply_motion_boundary` |
| `ADVANCE` | `sphlite_advance_explicit` |
| `WRITE_OUTPUT` | `sphlite_write_output` |
| `STOP` | `STOP` |
## 2. 错误映射
当前策略:
```text
SPHLite API status 0 -> worker OK
SPHLite API status 非 0 -> worker INTERNAL
```
后续应在返回 `INTERNAL` 前读取 `sphlite_get_last_error`,并把 last error 写入 worker log 和 command block error message。
## 3. 验收边界
本阶段保证命令到动作的映射完整,并提供 mock 测试和真实 IPC attach 骨架。它不保证真实 CCLite 跨进程联调、facet load/contact/motion 完整导入或生产级接触/FSI 已完成。
v2 预留字段、valid flags、contact state 扩展、拒绝原因和 boundary/ghost 缓存语义记录在 [CCLite Coupling Manifest](cclite_coupling_manifest.md),并由 `sph_worker_contract` 的 smoke 测试守住命名和清零策略。