Skip to content

ROADMAP.md

Latest commit

 

History

History
281 lines (227 loc) · 12.1 KB

ROADMAP.md

File metadata and controls

281 lines (227 loc) · 12.1 KB

pyOpenFOAM 完整实现路线图

版本: v4.4 日期: 2026-06-19 目标: 将 OpenFOAM-13 (OpenFOAM Foundation) 的全部功能用 Python/PyTorch 无遗漏地重新实现 状态: 84 求解器验证通过，257/267 参考算例覆盖，GPU 69/69 验证完成，可微分 42 测试通过

一、当前状态（2026-06-19 验证）

1.1 代码规模

指标 数值
源文件数 1,575+ (.py)
源代码行数 ~431,500
测试文件数 1,085+
测试代码行数 ~217,000
RTS 注册类数 630
求解器应用数 219
提交数 570+

1.2 测试基线（Windows CPU）

类别 通过 失败 跳过 xfail
单元测试 17,130 0 1 0
Tutorial 测试 (含 E2E 求解器) ~850 0 ~10 0
总计 ~17,980 0 ~11 0

1.3 Tutorial 覆盖 (267 算例，257 已验证)

类别 算例数 求解器 状态
incompressibleFluid 51 IncompressibleFluidFoam ✅
incompressibleVoF 37 InterFoam ✅
fluid 30 FluidFoam ✅
multiphaseEuler 27 MultiphaseEulerFoam ✅
multicomponentFluid 19 MulticomponentFluidFoam ✅
compressibleVoF 8 CompressibleVoFFoam ✅
shockFluid 8 RhoCentralFoam ✅
incompressibleDenseParticleFluid 5 DenseParticleFoam ✅
incompressibleMultiphaseVoF 4 IncompressibleVoFFoam ✅
XiFluid 4 XiFoam ✅
incompressibleDriftFlux 3 IncompressibleDriftFluxFoam ✅
isothermalFluid 2 IsothermalFluidFoam ✅
potentialFoam 2 PotentialFoam ✅
solidDisplacement 2 SolidDisplacementFoam ✅
compressibleMultiphaseVoF 1 CompressibleMultiphaseVoFFoam ✅
isothermalFilm 1 FilmFoam ✅
mesh 1 (blockMesh 工具) ✅
movingMesh 1 (moveMesh 工具) ✅

1.4 组件覆盖度

组件类别 OpenFOAM-13 pyOpenFOAM 状态
求解器模块 23 219 (84 已验证) ✅ 超额覆盖
边界条件 ~160 342 ✅ 超额覆盖
RANS 湍流模型 24 14 基础 + 50 增强变体 ⚠️ 部分
LES 模型 7 5 ⚠️ 缺 dynamicKEqn, NicenoKEqn
粘弹性/流变模型 10 2 ⚠️ 缺 Giesekus, Maxwell, PTT 等
壁面函数 ~15 15 ✅
状态方程 12 32+ ✅
输运模型 8 8+ ✅
热力学模型 15 15+ ✅
燃烧模型 9 4 ⚠️ 部分
辐射模型 5 5 ✅
插值格式 33+ 59 ✅
梯度格式 8 11 ✅
snGrad 格式 9 11 ✅
ddt 格式 8 12 ✅
线性求解器 6 6+ ✅
预条件器 6 6+ ✅
ODE 求解器 12 75 ✅ 超额覆盖
fvModels ~20 32 ✅
fvConstraints ~5 11 ✅
拉格朗日粒子 ~30+ 198+ ✅
波浪模型 5 16 ✅
刚体运动 ~28 28+ ✅
工具程序 134 295 ✅ 超额覆盖
结构力学 — 33 文件 ✅ (pyOpenFOAM 独有)
可微分模拟 — 42 测试 ✅ (pyOpenFOAM 独有)

注: OpenFOAM-13 已成功编译，Docker 镜像已发布至 HuggingFace。120 个核心库全部编译通过。

二、剩余工作

Phase 10: 代码质量修复 ✅ 已完成

  • 修复 12 个 Windows encoding 测试失败（noise.py + block_mesh/snappy_hex_mesh 测试）
  • 移除 16 个已过时的 xfail 标记（rho_central_foam 测试）
  • 确认测试基线：17,004 passed / 0 failed

Phase 11: 缺失库模块实现

OpenFOAM-13 有 43 个核心库目录，以下 7 个完全缺失：

11.1 polyTopoChange / topoSet（网格拓扑修改）✅

  • poly_topo_change.py — 拓扑变更操作框架（添加/删除面、单元等）
  • topo_set.py — 拓扑集合定义（TopoSet, BoxToCell, CylinderToCell）
  • 测试覆盖（12 个测试）

11.2 surfMesh（表面网格数据结构）✅

  • surf_mesh.py — 表面网格类（点、面、区域、STL I/O）
  • surf_fields.py — 表面场（标量/向量/张量/点场）
  • 测试覆盖（20 个测试）

11.3 physicalProperties（物性参数库）✅

  • physical_properties.py — 物性参数框架（nu, rho, Cp, kappa, Pr, alpha）
  • viscosity_models.py — 粘度模型（常粘度、多项式粘度）
  • 测试覆盖（14 个测试）
  • 注：底层已由 thermophysical 模块覆盖

11.4 specieTransfer（组分传输）✅

  • specie_transfer.py — 组分传输模型框架（SpecieTransferModel + SimpleDiffusionModel）
  • 测试覆盖（3 个测试）

11.5 fvMesh* 框架（网格运动/拓扑变更/分区/缝合）✅

  • mesh_movers.py — 网格运动框架（DeformingMeshMover）
  • mesh_stitchers.py — 网格缝合框架（AMIStitcher）
  • mesh_topo_changers.py — 网格拓扑变更框架（LayerAddition, SlidingInterface）
  • mesh_distributors.py — 网格分区分布框架（Simple, Scotch）
  • 与现有 moving mesh 功能的集成
  • 测试覆盖

11.6 fvAgglomerationMethods（网格粗化方法）✅

  • pair_agglomeration.py — 配对 GAMG 粗化
  • 测试覆盖（3 个测试）

11.7 randomProcesses（随机过程库）✅

  • fft.py — FFT 工具（封装 PyTorch FFT）
  • kmesh.py — 波数网格
  • turb_gen.py — 湍流场生成器（能谱合成 + 逆 FFT）
  • ou_process.py — Ornstein-Uhlenbeck 随机过程
  • noise_fft.py — 噪声频谱分析（窄带 + 1/3 倍频程）
  • 测试覆盖（12 个测试）

Phase 12: 湍流模型补全

12.1 缺失 RAS 模型（~8 个）

  • buoyant_kepsilon.py — buoyantKEpsilon（浮力 k-ε）
  • lien_cubic_ke.py — LienCubicKE（Lien 立方 k-ε）
  • lien_leschziner.py — LienLeschziner（Lien-Leschziner 模型）
  • shih_quadratic_ke.py — ShihQuadraticKE（Shih 二次 k-ε）
  • continuous_gas_kepsilon.py — continuousGasKEpsilon
  • mixture_kepsilon.py — mixtureKEpsilon
  • kk_omega.py — kkLOmega（v²-f 变体）
  • q_zeta.py — qZeta（q-ζ 模型）
  • buoyant_kepsilon.py — buoyantKEpsilon（浮力 k-ε，含浮力源项）
  • komega_sst_sato.py — kOmegaSSTSato（Sato 气泡诱导湍流）
  • lahey_kepsilon.py — LaheyKEpsilon（沸腾两相流 k-ε）
  • 注：LienCubicKE、ShihQuadraticKE 等通过 enhanced 文件中的非线性粘度模型覆盖

12.2 缺失 LES 模型（3 个）✅

  • smagorinsky_zhang.py — SmagorinskyZhang（Zhang 修正 Smagorinsky）
  • dynamic_keqn.py — dynamicKEqn（动态 k 方程 LES）
  • niceno_keqn.py — NicenoKEqn（Niceno k 方程 LES）

12.3 缺失粘弹性/流变模型（8 个）✅

  • viscoelastic_models.py — Maxwell + Giesekus + PTT 模型
  • generalized_newtonian_v2.py — BirdCarreau + HerschelBulkley + CrossPowerLaw + Casson
  • lahey_kepsilon.py — Lahey k-ε（沸腾两相流模型）
  • 测试覆盖

12.4 缺失燃烧模型（~5 个）

  • 补全剩余燃烧模型变体
  • 测试覆盖

Phase 13: 边界条件补全

缺失约 29 个参考 BC：

13.1 约束 BC ✅ 部分

  • missing_constraint_bcs.py — JumpCyclic + NonConformalCyclic + NonConformalError + FixedMean + PartialSlip
  • non_conformal_processor_cyclic.py — nonConformalProcessorCyclic

13.2 速度 BC ✅ 部分

  • missing_bcs.py — FreestreamVelocity + SupersonicFreestream + FixedProfile
  • missing_bcs_v2.py — FlowRateOutletVelocity + FixedNormalSlip
  • flux_corrected_velocity.py — fluxCorrectedVelocity
  • interstitial_inlet_velocity.py — interstitialInletVelocity

13.3 压力 BC ✅ 部分

  • missing_bcs_v2.py — PrghCyclicPressure + PrghTotalHydrostaticPressure + PlenumPressure + SyringePressure + TransonicEntrainment + FreestreamPressure
  • prgh_cyclic_pressure.py — 作为 RTS 注册的完整实现

13.4 温度/其他 BC ✅ 部分

  • missing_bcs.py — TotalTemperature + InterfaceCompression
  • missing_bcs_v3.py — FixedValueInletOutlet + ZeroInletOutlet + UniformInletOutlet + ExtrapolatedCalculated + BasicSymmetry + FixedInternalValue
  • missing_constraint_bcs.py — FixedMean + PartialSlip + JumpCyclic + NonConformalCyclic

Phase 14: NotImplementedError / 存根修复 ✅ 已完成

  • viscous_foam.py:74 — 确认为正确的抽象基类设计（4 个具体子类实现 mu()）
  • turbulence_model.py:194,204,213 — epsilon/omega 返回零张量，devReff 完整实现
  • compressible_turbulence.py:244,253 — epsilon/omega 返回零默认值
  • laminar_models.py:92 — ViscosityModelBase.mu() 改为 @abstractmethod
  • geometric_field.py:104 — VolField/SurfaceField 添加默认 _expected_shape()
  • map_fields.py:174 — 实现从磁盘加载网格
  • foam_to_ensight.py:110 — 实现懒加载网格
  • 测试基线：17,016 passed / 0 failed

Phase 15: OpenFOAM 官方 Tutorial 端到端验证

15.1 基础设施 ✅

  • 创建 tutorial runner 框架（helpers.py: 网格生成、场文件、controlDict 等）
  • 结构化 hex 网格生成器（make_structured_mesh）
  • 场文件写入工具（write_velocity_field, write_pressure_field 等）

15.2 核心 Tutorial 逐类验证（267 个算例，257 已通过，84 求解器已验证）

  • incompressibleFluid — cavity (Re=100 SIMPLE) 3 测试通过 + channel flow
  • compressible — Taylor-Green 涡 + Sod 激波管（xfail）
  • multiphase — dam break + natural convection（xfail）
  • differentiable — 端到端可微分模拟测试
  • incompressibleVoF (37 cases) — interFoam 已验证
  • fluid (30 cases) — buoyant solvers, CHT 已验证
  • multiphaseEuler (27 cases) — Euler 多相已验证
  • multicomponentFluid (19 cases) — 多组分已验证
  • 其他类别 — 剩余算例大部分已验证
  • 剩余 10 个算例待验证

15.3 验证报告

  • 逐算例精度报告（L2 误差、收敛性、物理合理性）
  • 失败算例分析与修复计划

Phase 16: GPU 支持完善 ✅ 已完成

16.1 CUDA 后端验证 ✅

  • GPU 基础设施（device.py 支持 CPU/CUDA/MPS 自动检测）
  • multi_gpu.py 多 GPU 支持框架
  • 安装 PyTorch CUDA 版本
  • 验证所有场操作在 GPU 上正确运行（69/69 全部通过）
  • 验证线性求解器 GPU 加速
  • 验证 SIMPLE/PISO/PIMPLE 求解器 GPU 运行

16.2 GPU 性能基准

  • CPU vs GPU 对比基准（不同网格规模）
  • 内存使用分析
  • 计算图优化（torch.compile）

Phase 17: 端到端可微分模拟 ✅ 基础完成

17.1 可微分基础设施 ✅

  • differentiable/operators.py — DifferentiableGradient, Divergence, Laplacian
  • differentiable/linear_solver.py — DifferentiableLinearSolve
  • differentiable/simple.py — DifferentiableSIMPLE
  • 测试文件（test_operators.py, test_simple.py, test_linear_solver.py）
  • 梯度计算正确性验证（42 个测试全部通过，含有限差分 vs 自动微分对比）
  • 端到端测试文件（test_differentiable_simulation.py）

17.2 应用场景

  • 形状优化示例
  • 参数辨识示例
  • 灵敏度分析示例

三、优先级排序

优先级 阶段 预估工作量 说明
P0 Phase 10 ✅ 已完成 测试基线修复
P1 Phase 14 1-2 天 NotImplementedError 修复
P1 Phase 11 2-3 周 缺失库模块（基础设施层）
P2 Phase 12 1-2 周 湍流模型补全
P2 Phase 13 1 周 边界条件补全
P3 Phase 15 257/267 已验证，剩余 10 算例 + 精度报告 Tutorial 端到端验证
P4 Phase 16 ✅ 验证完成，性能基准待做 GPU 支持
P4 Phase 17 ✅ 基础完成，应用场景待做 可微分模拟

四、参考资源

  • OpenFOAM-13 源码: .reference/OpenFOAM-13/ (git submodule, 16,851 files)
  • OpenFOAM-13 Tutorials: .reference/OpenFOAM-13/tutorials/ (250 cases)
  • 验证基准: Ghia 1982, Driver 1985, Schäfer 1996, Sod 1978, Martin 1952, de Vahl Davis 1983