Files
MDHelper/docs/project_structure.md
T
2026-05-25 17:12:00 +08:00

67 lines
1.8 KiB
Markdown

# 项目结构
## 顶层目录
```text
core/ 基础数学、字段、运行时数据结构
geometry/ CAD、网格划分、粒子划分
io/ XML/JSON/YAML 配置、VTU/PVD/CSV/log 输入输出
linear_algebra/ 稀疏矩阵、线性求解器
material/ 材料库、本构模型、状态方程
fem/ FEM 单元、离散、求解器、后处理、CUDA 路径
sph/ SPH 粒子、模型、边界、求解器、后处理
coupling/ FEM-SPH、刚体、DEM 等耦合接口
pipeline/ 统一任务流调度
examples/ 示例与 benchmark
docs/ 用户手册和开发规范
```
## 主入口
- `main.cpp`:命令行入口。
- `m3frame.h`:聚合式公共入口。
- `M3Frame.exe`:运行 `pipeline.xml` 或单个配置文件的主程序。
## examples 目录
推荐按物理类型组织:
```text
examples/
sph/
benchmarks/
fem/
geometry/
coupling/
```
每个案例建议包含:
```text
case/
pipeline.xml
config/
outputs/
README.md
benchmark_case.cpp 可选,只做结果对比
```
## docs 目录
`docs/` 面向用户;各模块目录下的 `.md` 面向更细的开发或配置说明。
## 模块边界
建议保持以下职责边界:
| 模块 | 主要职责 | 不建议承担 |
|---|---|---|
| `geometry/` | CAD、网格、粒子划分 | FEM/SPH 求解控制 |
| `sph/` | SPH 数据结构、模型、边界、求解器 | CAD 建模逻辑 |
| `fem/` | 单元、装配、求解、后处理 | 通用配置文件解析细节 |
| `material/` | 材料参数、本构、EOS | 案例流程调度 |
| `io/` | 配置、VTU/PVD/CSV/log | 物理模型决策 |
| `pipeline/` | 阶段调度 | 重复定义 FEM/SPH 内部概念 |
新增功能时,优先放入最具体的物理模块;只有跨模块共用时再抽到 `core/`、`io/` 或 `pipeline/`。