Files
FemLite/docs/08_developer_manual.md
T
shenw 0440ed5a64
FemLite CI / build-test (push) Has been cancelled
Release FemLite 0.6.4
2026-07-05 17:23:34 +08:00

84 lines
3.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 08 开发者手册
文档状态:0.6.4 版整理稿
## 1. 基本原则
- 默认使用现有模块和风格,不为小改动引入新架构。
- 新功能必须有小型可重复测试。
- 不支持的物理或输入必须明确报错,不得静默回退。
- 不提交 build、results、CSV/VTU/PVD 全量结果、restart 和临时文件。
- 文档使用 UTF-8 without BOM。
## 2. 新增单元流程
1. 在 `fem_element_topology` 中增加 canonical 名称、类型、节点数、边/面和积分点计数。
2. 在输入读取和数据库校验中覆盖新名称。
3. 在形函数、积分、刚度、内力和质量路径中接入实现。
4. 增加 topology/database/module 测试。
5. 如果暴露给 C API,同步更新 bridge、header、C wrapper 和 `test_c_api`。
6. 更新算法、接口、用户手册和 benchmark matrix。
不得把未验证的 Abaqus 名称静默映射到已支持单元。
## 3. 新增积分规则流程
1. 在 `fem_quadrature` 中增加或复用 family/domain/order 描述符。
2. 保持现有 element-driven 默认规则不变,除非有明确测试覆盖。
3. 增加点数、坐标对称性和权重和测试。
4. 用户侧任意积分选择必须等后续版本单独规划。
## 4. 新增 API 流程
- 优先使用 dimension query + value-fill query。
- 写输出前验证 id、索引和缓冲区容量。
- C ABI 空指针或非正容量返回 `-1`。
- Fortran 错误通过 `ierr` 和 `fem_get_last_error` 传递。
- C 多维数组按 Fortran 顺序展开。
## 5. 测试建议
常用聚焦测试:
```powershell
ctest --test-dir build-codex-gcc -R "^(smoke|element_infrastructure|database_topology|element_stiffness|shell_internal|c_api)$" --output-on-failure
ctest --test-dir build-codex-gcc -R "^source_size$" --output-on-failure
ctest --test-dir build-codex-gcc -L v5_acceptance --output-on-failure
```
发布前运行:
```powershell
cmake --build build-codex-gcc --parallel
ctest --test-dir build-codex-gcc --output-on-failure
git diff --check
```
## 6. 文档维护
核心文档固定为:
- `01_requirements_specification.md`
- `02_software_architecture_design.md`
- `03_detailed_design.md`
- `04_mathematical_model_and_algorithms.md`
- `05_interface_control_document.md`
- `06_test_and_verification_plan.md`
- `07_user_manual.md`
- `08_developer_manual.md`
- `09_release_history.md`
- `10_development_roadmap.md`
- `11_benchmark_matrix.md`
历史版本计划、验收报告和 benchmark 矩阵不再拆成多个文件;统一维护在 09-11。
## 7. 0.6.4 开发注意事项
- `S4R` hourglass 修改必须保持 `S4` 回归绿色。
- `C3D8R` hourglass 修改必须保持 `C3D8` 回归绿色,并覆盖刚度、内力、质量和输出路径。
- B 矩阵约定变更必须同步接口文档和 C API 测试。
- 元素查询 API 不应暴露内部数组指针。
- 新增积分规则不等于开放用户侧积分选择。
- coupling external load 必须通过中立 API 导入和清理,不得让外部程序直接写 FemLite 全局力数组。
- worker/IPC 改动必须保持 FemLite 只 open CCLite 创建的 shared memory 和 named event,event reset 责任属于 CCLite。
- CCLite 诊断报告字段变更必须同步 C API 测试、worker mock 测试和接口文档。