From 0d3f0fb7cc00456f922451e9fb2cdb059162a479 Mon Sep 17 00:00:00 2001 From: Codex Date: Sun, 5 Jul 2026 17:21:51 +0800 Subject: [PATCH] Finalize CCLite 0.1.8 release candidate --- .gitignore | 3 +- CMakeLists.txt | 6 ++ Python/checkers/check_utf8_no_bom.py | 54 +++++++++++++++++ README.md | 10 +++- docs/0.1.x_interface_constants.md | 86 +++++++++++++++++++++++++++ docs/0.1.x_release_notes.md | 47 +++++++++++++++ docs/05_interface_control_document.md | 10 ++-- src/common/ccl_version.f90 | 4 +- todo.md | 48 +++++++-------- 9 files changed, 234 insertions(+), 34 deletions(-) create mode 100644 Python/checkers/check_utf8_no_bom.py create mode 100644 docs/0.1.x_interface_constants.md create mode 100644 docs/0.1.x_release_notes.md diff --git a/.gitignore b/.gitignore index 9af1ce7..c284e91 100644 --- a/.gitignore +++ b/.gitignore @@ -19,4 +19,5 @@ __pycache__/ *.vtu *.vtp *.restart -verification_report.json +verification_report*.json +real_worker_gap_report.json diff --git a/CMakeLists.txt b/CMakeLists.txt index 4a1ca88..07a254d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -134,6 +134,12 @@ if(Python3_Interpreter_FOUND) ) set_tests_properties(diagnostics_regression_headers PROPERTIES DEPENDS dry_run_100_step) + add_test(NAME utf8_no_bom_check + COMMAND ${Python3_EXECUTABLE} + ${CMAKE_SOURCE_DIR}/Python/checkers/check_utf8_no_bom.py + --root ${CMAKE_SOURCE_DIR} + ) + set(CCLITE_SPHLITE_EXE "${CMAKE_SOURCE_DIR}/SPHLite/cpu_release/sphlite.exe" CACHE FILEPATH "Optional SPHLite executable for real-worker gap audit") set(CCLITE_FEMLITE_EXE "${CMAKE_SOURCE_DIR}/FEMLite/cpu_release/bin/femlite.exe" CACHE FILEPATH diff --git a/Python/checkers/check_utf8_no_bom.py b/Python/checkers/check_utf8_no_bom.py new file mode 100644 index 0000000..9512eda --- /dev/null +++ b/Python/checkers/check_utf8_no_bom.py @@ -0,0 +1,54 @@ +from __future__ import annotations + +import argparse +from pathlib import Path + + +SUFFIXES = {".md", ".inp", ".py", ".json"} +SKIP_PARTS = { + ".git", + ".venv", + "__pycache__", + "build-codex-gcc", + "build-codex-gcc-clean", + "output", + "FEMLite", + "SPHLite", +} + + +def should_check(path: Path, root: Path) -> bool: + relative = path.relative_to(root) + if any(part in SKIP_PARTS for part in relative.parts): + return False + if path.suffix not in SUFFIXES: + return False + return True + + +def main() -> int: + parser = argparse.ArgumentParser() + parser.add_argument("--root", required=True) + args = parser.parse_args() + root = Path(args.root).resolve() + failures: list[str] = [] + + for path in sorted(root.rglob("*")): + if not path.is_file() or not should_check(path, root): + continue + data = path.read_bytes() + if data.startswith(b"\xef\xbb\xbf"): + failures.append(str(path.relative_to(root))) + + if failures: + print("UTF-8 BOM found:") + for item in failures: + print(f" {item}") + return 1 + + print("UTF-8 without BOM check passed") + return 0 + + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/README.md b/README.md index bb70c4d..c12ed8a 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,14 @@ Linux 共享内存、MPI、显隐耦合、强耦合、tied coupling 和 FSI 高 1. `01_requirements.md`:软件需求规格说明书; 2. `02_architectural_design_specification.md`:概要设计说明书; -3. `03_detailed_design.md`:详细设计说明书。 +3. `03_detailed_design.md`:详细设计说明书; +4. `04_mathematical_model_and_algorithms.md`:数学模型与算法说明; +5. `05_interface_control_document.md`:接口控制文档; +6. `06_test_and_verification_plan.md`:测试与验证计划; +7. `07_real_worker_access_audit.md`:真实 worker 最小接入审计; +8. `v1.x_development_plan.md`:0.1.x 开发计划; +9. `0.1.x_interface_constants.md`:0.1.x 接口常量冻结记录; +10. `0.1.x_release_notes.md`:0.1.x 发布说明。 辅助讨论文档: @@ -47,4 +54,3 @@ Linux 共享内存、MPI、显隐耦合、强耦合、tied coupling 和 FSI 高 ## 编码要求 本仓库文档均使用中文,文件编码为 UTF-8 without BOM。 - diff --git a/docs/0.1.x_interface_constants.md b/docs/0.1.x_interface_constants.md new file mode 100644 index 0000000..0e4265d --- /dev/null +++ b/docs/0.1.x_interface_constants.md @@ -0,0 +1,86 @@ +# CCLite 0.1.x 接口常量冻结记录 + +本文记录 0.1.x 已用于测试和 mock worker 闭环的接口常量。0.2.x 起若修改这些常量,必须同步升级 ABI/layout 并补兼容说明。 + +## 1. Worker 启动参数 + +正式参数: + +```text +--cclite-worker --solver-id --case --ipc-name --timeout-ms +``` + +兼容别名: + +1. `--ipc-prefix`:0.1.5 早期 mock worker 参数,0.1.7 起仅作为兼容; +2. `--solver-input`:0.1.5 早期 mock worker 参数,0.1.7 起仅作为兼容。 + +## 2. Solver Id + +| id | 名称 | +| --- | --- | +| 1 | `SPH` | +| 2 | `FEM` | +| 3 | `CCL` | + +## 3. Command Id + +| id | 名称 | +| --- | --- | +| 1 | `INIT` | +| 2 | `READ_INPUT` | +| 3 | `BUILD_MODEL` | +| 4 | `EXPORT_INTERFACE` | +| 5 | `IMPORT_LOADS` | +| 6 | `ADVANCE` | +| 7 | `WRITE_OUTPUT` | +| 99 | `STOP` | + +## 4. Worker State + +| id | 名称 | +| --- | --- | +| 1 | `STARTING` | +| 2 | `READY` | +| 3 | `BUSY` | +| 4 | `DONE` | +| 5 | `ERROR` | +| 6 | `STOPPED` | + +## 5. Data Layout + +| id | 名称 | 0.1.x 状态 | +| --- | --- | --- | +| 1 | `AOR_V1` | 已实现 | +| 2 | `SOA_V2` | 0.8.x 预留,0.1.x 拒绝 | + +## 6. Block Role + +| role | 名称 | 0.1.x 状态 | +| --- | --- | --- | +| 101 | `SPH_TO_CCL_PARTICLE` | 已实现,mock 可写空 block | +| 102 | `SPH_TO_CCL_FACET` | 预留 | +| 201 | `FEM_TO_CCL_FACET` | 已实现,mock 可写空 block | +| 301 | `CCL_TO_SPH_FORCE` | 已定义,0.1.x 写空 block | +| 302 | `CCL_TO_FEM_LOAD` | 已定义,0.1.x 写空 block | +| 401 | `CCL_DIAGNOSTIC` | 已定义 | +| 901 | `CCL_COMMAND_SPH` | 已定义 | +| 902 | `CCL_COMMAND_FEM` | 已定义 | + +## 7. Buffer State + +| id | 名称 | +| --- | --- | +| 0 | `EMPTY` | +| 1 | `WRITING` | +| 2 | `READY` | +| 3 | `READING` | +| 4 | `CONSUMED` | +| 5 | `ERROR` | + +## 8. 0.1.x 验收算例 + +| 算例 | 状态 | +| --- | --- | +| `V010_EMPTY_COUPLING` | 通过,mock SPH/FEM worker 完成 100 step 空耦合 | +| 真实 worker gap audit | 通过,输出受控缺口报告,不声明真实 worker 已接入 | diff --git a/docs/0.1.x_release_notes.md b/docs/0.1.x_release_notes.md new file mode 100644 index 0000000..becc26b --- /dev/null +++ b/docs/0.1.x_release_notes.md @@ -0,0 +1,47 @@ +# CCLite 0.1.x 发布说明 + +## 1. 发布定位 + +0.1.x 是 CCLite 的主控、通信、mock worker 和验证闭环版本。该版本完成 Windows/gfortran/本机共享内存下的工程骨架和空耦合闭环,不包含真实 SPH-FEM 接触力、摩擦、tied coupling、FSI 或 Linux/MPI 生产实现。 + +## 2. 已完成功能 + +1. `cclite` 独立主控程序; +2. Abaqus 风格 `.inp` 解析和 `check/dry-run/run` 入口; +3. Windows shared memory 与 named event 薄封装; +4. command block、seq/ack、heartbeat 和 timeout; +5. data block header、AoR v1 record 和空载荷 block; +6. mock SPH/FEM worker service 模式; +7. 1 step 与 100 step 空耦合集成测试; +8. `run.log`、`ipc_report.csv`、`force_balance.csv`; +9. Python checker 生成 `verification_report.json`; +10. 真实 SPHLite/FEMLite worker 接入审计和受控缺口报告。 + +## 3. 验证结果 + +本地 0.1.8 验证项: + +1. 全量 CTest 通过; +2. `V010_EMPTY_COUPLING` checker 输出 `PASS`; +3. UTF-8 without BOM 检查通过; +4. 干净构建目录重建和测试通过; +5. 真实 worker audit 输出 `CONTROLLED_GAP`。 + +## 4. 真实 worker 状态 + +当前本地审计结果: + +1. SPHLite 0.8.2 能识别 worker CLI,但真实 Windows IPC 返回受控 unsupported; +2. FEMLite 0.6.3 尚未识别 CCLite worker 参数; +3. 0.1.x 的可执行验收路径仍是 CCLite mock worker; +4. 0.2.x 前必须先在 SPHLite/FEMLite 侧补齐 worker adapter。 + +## 5. 进入 0.2.x 的条件 + +0.2.x 可以在以下基础上开发基础 penalty contact: + +1. SPH particle 与 FEM facet AoR v1 数据布局已冻结; +2. CCLite 可按 step 调度两个 worker; +3. 空 force/load 写回路径已存在; +4. checker 可自动判定通信闭环; +5. 真实 worker 缺口已记录,不会误判为物理算法完成。 diff --git a/docs/05_interface_control_document.md b/docs/05_interface_control_document.md index 435aad7..2924e36 100644 --- a/docs/05_interface_control_document.md +++ b/docs/05_interface_control_document.md @@ -134,8 +134,8 @@ SPHLite 和 FEMLite 必须增加 CCLite worker/service 模式。 推荐命令行: ```powershell -sphlite.exe --cclite-worker sphlite.inp --ipc-prefix CCLITE_CASE001 --solver-name SPH -femlite.exe --cclite-worker femlite.inp --ipc-prefix CCLITE_CASE001 --solver-name FEM +sphlite.exe --cclite-worker --solver-id SPH --case sphlite.inp --ipc-name CCLITE_CASE001 --timeout-ms 5000 +femlite.exe --cclite-worker --solver-id FEM --case femlite.inp --ipc-name CCLITE_CASE001 --timeout-ms 5000 ``` 最小参数: @@ -143,9 +143,9 @@ femlite.exe --cclite-worker femlite.inp --ipc-prefix CCLITE_CASE001 --solver-nam | 参数 | 必填 | 含义 | | --- | --- | --- | | `--cclite-worker` | 是 | 进入 CCLite worker/service 模式 | -| input file | 是 | 求解器自己的 `.inp` 文件 | -| `--ipc-prefix` | 是 | CCLite 创建的共享对象前缀 | -| `--solver-name` | 是 | `SPH` 或 `FEM` | +| `--solver-id` | 是 | `SPH` 或 `FEM` | +| `--case` | 是 | 求解器自己的 `.inp` 文件 | +| `--ipc-name` | 是 | CCLite 创建的共享对象前缀 | | `--workdir` | 否 | worker 工作目录 | | `--timeout-ms` | 否 | worker 默认等待超时 | diff --git a/src/common/ccl_version.f90 b/src/common/ccl_version.f90 index 100c50d..8c9adc1 100644 --- a/src/common/ccl_version.f90 +++ b/src/common/ccl_version.f90 @@ -3,8 +3,8 @@ module ccl_version integer, parameter :: CCL_VERSION_MAJOR = 0 integer, parameter :: CCL_VERSION_MINOR = 1 - integer, parameter :: CCL_VERSION_PATCH = 7 - character(len=*), parameter :: CCL_VERSION_LABEL = "0.1.7" + integer, parameter :: CCL_VERSION_PATCH = 8 + character(len=*), parameter :: CCL_VERSION_LABEL = "0.1.8" contains diff --git a/todo.md b/todo.md index 06b37a7..79b42a2 100644 --- a/todo.md +++ b/todo.md @@ -281,50 +281,50 @@ 目标:冻结 0.1.x 通信闭环,准备进入 0.2.x 接触算法开发。 -- [ ] T0181 执行全量 0.1.x 单元测试。 +- [x] T0181 执行全量 0.1.x 单元测试。 完成判据:`.inp`、command block、data block、错误码和 CSV writer 测试通过。 -- [ ] T0182 执行全量 0.1.x 接口测试。 +- [x] T0182 执行全量 0.1.x 接口测试。 完成判据:shared memory、named event、timeout、bad header 和 bad layout 测试通过。 -- [ ] T0183 执行全量 0.1.x 集成测试。 +- [x] T0183 执行全量 0.1.x 集成测试。 完成判据:双 mock workers 1 step 和 100 step 空耦合通过。 -- [ ] T0184 执行 `V010_EMPTY_COUPLING` 验证算例。 +- [x] T0184 执行 `V010_EMPTY_COUPLING` 验证算例。 完成判据:Python checker 生成通过报告。 -- [ ] T0185 执行干净环境重建。 +- [x] T0185 执行干净环境重建。 完成判据:从干净目录构建、运行 smoke 和 V010 均通过。 -- [ ] T0186 检查 UTF-8 without BOM。 +- [x] T0186 检查 UTF-8 without BOM。 完成判据:新增文档和 `.inp` 样例均无 BOM。 -- [ ] T0187 检查文档一致性。 +- [x] T0187 检查文档一致性。 完成判据:README、03、05、06 和开发计划与实现字段、命令、输出一致。 -- [ ] T0188 冻结 0.1.x 接口常量。 +- [x] T0188 冻结 0.1.x 接口常量。 完成判据:command id、worker state、block role、layout id、CSV 表头有记录。 -- [ ] T0189 整理 0.1.x release notes。 +- [x] T0189 整理 0.1.x release notes。 完成判据:列出已完成能力、未完成能力、真实 worker 接入状态和 0.2.x 入口条件。 # 11. 0.1.x 总体验收清单 -- [ ] A001 `cclite.exe` 可作为独立主控程序启动。 -- [ ] A002 `mock_sph_worker` 和 `mock_fem_worker` 可由 CCLite 启动。 -- [ ] A003 CCLite 可创建和释放 Windows shared memory。 -- [ ] A004 CCLite 可创建和释放 Windows manual-reset named event。 -- [ ] A005 Command block seq/ack 在 100 step 中全部匹配。 -- [ ] A006 Data block header 校验覆盖正常和异常路径。 -- [ ] A007 AoR v1 空 payload 和固定 payload 均可处理。 -- [ ] A008 `cclite check` 可检查合法和非法 `.inp`。 -- [ ] A009 `cclite dry-run` 可完成双 mock 空耦合。 -- [ ] A010 `run.log`、`ipc_report.csv`、`force_balance.csv` 均生成。 -- [ ] A011 Python checker 可生成 `verification_report.json`。 -- [ ] A012 `V010_EMPTY_COUPLING` 自动检查通过。 -- [ ] A013 Linux/MPI 配置只给出预留或不支持提示。 -- [ ] A014 0.1.x 不宣称真实 SPH-FEM 接触力已完成。 -- [ ] A015 0.2.x 可在该基础上进入基础 penalty contact 开发。 +- [x] A001 `cclite.exe` 可作为独立主控程序启动。 +- [x] A002 `mock_sph_worker` 和 `mock_fem_worker` 可由 CCLite 启动。 +- [x] A003 CCLite 可创建和释放 Windows shared memory。 +- [x] A004 CCLite 可创建和释放 Windows manual-reset named event。 +- [x] A005 Command block seq/ack 在 100 step 中全部匹配。 +- [x] A006 Data block header 校验覆盖正常和异常路径。 +- [x] A007 AoR v1 空 payload 和固定 payload 均可处理。 +- [x] A008 `cclite check` 可检查合法和非法 `.inp`。 +- [x] A009 `cclite dry-run` 可完成双 mock 空耦合。 +- [x] A010 `run.log`、`ipc_report.csv`、`force_balance.csv` 均生成。 +- [x] A011 Python checker 可生成 `verification_report.json`。 +- [x] A012 `V010_EMPTY_COUPLING` 自动检查通过。 +- [x] A013 Linux/MPI 配置只给出预留或不支持提示。 +- [x] A014 0.1.x 不宣称真实 SPH-FEM 接触力已完成。 +- [x] A015 0.2.x 可在该基础上进入基础 penalty contact 开发。 # 12. 暂不进入 0.1.x 的事项