Files
SystemSimulationApp/docs/standard/README.md
T

7.3 KiB
Raw Blame History

现行规范索引

索引版本:1.1.0;整理/复核日期:2026-09-12。

新增组件从注册流程开始,再按涉及的能力读取专项规范。注册示例包含实际失败阶段、修订对照和复现方法。本目录保存现行版本,修订时更新正文版本、日期及变更说明;历史实现报告仍在 docs/other/,不覆盖其历史结论。

文件 文档版本 / 本次修订日期 用途
component-registration-workflow-v1.md 1.1.0 / 2026-09-12 总流程、条件修改范围、交付资料与完成状态
component-registration-example-v1.md 1.0.0 / 2026-09-12 斜坡信号源完整注册演练、规范差异、复现与验证记录
component-library-spec-v1.md 1.2.0 / 2026-09-12 库清单、身份版本、注册与目录/工程读取
component-model-authoring-spec-v1.md 1.2.0 / 2026-09-12 参数、端口、状态、结果、C 模块和代码生成要求
port-computation-contract.md 1.1.1 / 2026-09-12 端口逐变量供需、固定参考关系与连接合法性
native-evaluation-schedule.md 1.1.1 / 2026-09-12 计算依赖、局部求解,以及新模型的依赖检查
跨平台交付约定.md 1.1.1 / 2026-09-12 Windows/Linux 构建、缓存、文件系统和实际验收
backend-interface-version-spec-v1.md 1.2.0 / 2026-09-12 接口、模型与工程格式各自的版本边界

文档文件名中的 v1 是文档主版本,正文另标修订版本。当前协议为目录 schema 1、工程 JSON 2(兼容读 1)、System XML 3;本次工程格式升级没有改变各组件 MODEL_VERSION。

其他配套规范本轮也完成核对并补上文档版本:

文件 文档版本 / 核对日期 本轮调整
System XML v3 1.1.0 / 2026-09-12 求解方法、示例可执行边界、参数输入及连接检查层次
优化基准模型 1.0.0 / 2026-09-12 真实计时字段、预热、网页保存/CSV 与原始数据口径

以上版本仅表示文档,XML Schema 和用户指定的八路基准未改变。

文件迁移与后续删改

原位置 现位置 处理
docs/standard/新组件注册流程与规范草案.md docs/standard/component-registration-workflow-v1.md 校正后转为现行流程,移除草案副本
app/simulation/components/example.md docs/standard/component-registration-example-v1.md 迁入本目录并替换为可复现的新组件示例,删除旧入口
既有组件、端口、求值与跨平台规范 原有 docs/standard/ 路径 原位更新,保持稳定链接

后续调整流程先改总流程;字段或行为规则改对应专项规范;演练方法和证据改示例。移动或删除文件时同步本索引、仓库 README 与其他规范中的链接。可执行演练工具保留在 tests/manual/;本地生成项目、源码副本和缓存位于被 Git 忽略的 test/component-registration-20260912*,停掉其临时服务后可删除,并可按示例重新生成。

2026-09-12 全目录代码一致性复核

本轮核对本目录全部 11 份文档(含本索引)。修改现行规范以描述当前代码;Windows 实际验收、八路优先、固定精度和独立参考等用户约束继续保留,不能因代码尚未自动完成就删去要求。注册示例的历史实测记录保持原版本,没有把本轮静态核对写成重新执行整套网页演练。

核对项 确认的代码行为及本轮修订 主要代码依据
XML 积分方法 XSD 列六种,语义层只接受 RK45/BDF;其余返回 SIMULATION_METHOD_UNSUPPORTED XML 校验、XSD、原生 runner
XML 示例和编译 API 文档示例是结构有效但机械无惯性锚点的系统;compile-model 只构造网络,C 生成仍可能失败 HTTP/网络入口、扩展生成
存储与执行 版本不同在输入层警告后使用当前模型;类型/端口/参数仍严查,XML 精确版本不变 请求与存储、前端解析
参数表达式与单位 已统一:外部 v2 数值与表达式按所选单位,v1 保持旧 SI 数字;预处理后才进入数值内核 网页表达式、CLI 输入、HTTP 转换
组件元数据 DISPLAY 的介质 role 参与识别;数值基类需配套;输出过滤 visible/活动端口,editor 为受控枚举 注册器、组件基类、元数据
连接入口 XML/网络允许信号扇出,网页检查限制显示端口一条边;存储不做供需校验 网络、XML、前端
雅可比与误差尺度 有收益时着色差分,矩阵/LU 仍稠密;扩展路径使用统一的物性差分求值;核对选项传给 EXE 雅可比结构、CVODE、容差
缓存和平台 缓存命中仍预处理;按模块复用,有清理预算及超限例外;Windows 使用 GCC/MinGW 接口 构建、缓存、CI
结果与耗时 C JSON 字节直传、IndexedDB 保存、Worker CSV 是不同阶段;任务内存保留与终态清理有明确边界 结果传输、结果持久化、CSV、C 计时

验证:64 项注册、目录、元数据、工程格式、XML、端口供需、雅可比结构和原生结果传输测试通过。另外直接核对六种积分方法、示例原生拒绝原因、存储/执行版本差异、数字/表达式单位和网页函数表达式行为。原始结果在被 Git 忽略的 test/standard-code-audit-20260912/:regression.log、probe.json、frontend-expression.json。该次审计未改业务实现。后续已按用户决定实现两项输入合同改动,另见下方新验收记录。

输入合同实现 / 2026-09-12

旧组件版本警告、工程 JSON v2 参数单位与表达式统一的现行规则见接口规范 1.2.0。测试与独立版本检查计时见验收报告。端口快照精简及其他求解优化未纳入此改动。