File size: 3,667 Bytes
9a12797
 
 
051a263
9a12797
 
 
 
 
 
051a263
 
 
9a12797
 
051a263
9a12797
051a263
9a12797
051a263
 
 
9a12797
 
 
051a263
 
9a12797
051a263
 
 
 
 
 
9a12797
051a263
 
 
 
 
 
 
 
 
 
 
 
9a12797
051a263
 
 
 
 
 
 
 
 
9a12797
051a263
9a12797
 
 
 
 
051a263
9a12797
 
 
 
 
 
 
 
 
051a263
9a12797
 
 
 
051a263
9a12797
 
 
 
051a263
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
---
language:
- en
- zh
tags:
- openfoam
- cfd
- computational-fluid-dynamics
- simulation
- reference-data
- pytorch
- gpu
license: gpl-3.0
---

# pyOpenFOAM Reference Data & Validation Results

OpenFOAM-13 reference simulation data and pyOpenFOAM validation results for [pyOpenFOAM](https://github.com/AlanZee/pyOpenFOAM) — a pure Python/PyTorch reimplementation of OpenFOAM with GPU acceleration and automatic differentiation.

---

## Dataset Summary / 数据摘要

| Property | Value |
|----------|-------|
| **Total reference cases** | 257 |
| **Validated cases** | 233 (90.7%) |
| **Categories** | 21 |
| **Source** | OpenFOAM v11/v13 |
| **Reference data size** | 2.42 GB |
| **pyOpenFOAM results** | 3.3 MB |
| **Field files analyzed** | 2,032 |
| **Unique field types** | 376 |
| **Validation figures** | 11 |

## Contents / 内容

| File | Size | Description |
|------|------|-------------|
| `openfoam-reference-data.tar.gz` | 2.42 GB | 257 OpenFOAM reference cases (96% of v13 tutorials) |
| `pyopenfoam-simulation-results.tar.gz` | 47 KB | pyOpenFOAM validation results (34 JSON files) |
| `validation_report.md` | 19 KB | Comprehensive validation report with academic citations |
| `figures/` | 3.3 MB | 11 validation figures (300 DPI) |
| `per_case_data/` | 1.1 MB | Per-case analysis for all 257 reference cases |
| Docker image | 622 MB | OpenFOAM-13 compiled environment (122 libs, 9 binaries) |

## Validation Results / 验证结果

| Metric | Result |
|--------|--------|
| Unit tests (CPU) | 17,130 / 17,130 pass |
| Unit tests (GPU) | 17,082 / 17,085 pass |
| Differentiable CFD | 42 / 42 pass |
| Solver E2E verification | 69 / 69 pass |
| Couette flow error | 0.001% |
| Poiseuille flow error | 0.02% |
| Cavity Re=100 (32×32) | 1.0% vs Ghia et al. (1982) |

## Quick Start / 快速开始

```python
from huggingface_hub import hf_hub_download
import tarfile

# Download reference data
path = hf_hub_download(
    repo_id="AlanZee/pyOpenFOAM-reference-data",
    filename="openfoam-reference-data.tar.gz",
    repo_type="dataset"
)
with tarfile.open(path, "r:gz") as tar:
    tar.extractall("validation/reference/openfoam/")
```

## Citation / 引用

```bibtex
@software{pyopenfoam2026,
  author = {AlanZee},
  title = {pyOpenFOAM: Pure Python/PyTorch CFD with GPU Acceleration},
  year = {2026},
  url = {https://github.com/AlanZee/pyOpenFOAM}
}
```

## References / 参考文献

1. Ghia, K.N., Ghia, U., Shin, C.T. (1982). "High-Re solutions for incompressible flow." *J. Comput. Phys.*, 48, 387-411.
2. Weller, H.G. et al. (1998). "A tensorial approach to computational continuum mechanics." *Computers in Physics*, 12(6), 620-631.
3. OpenFOAM Foundation (2025). OpenFOAM-13. https://openfoam.org/

---

## 数据集说明 (中文)

本数据集包含 pyOpenFOAM 项目的所有验证数据:

- **参照数据**: 257 个 OpenFOAM-13 官方教程的仿真结果,覆盖 21 个求解器类别
- **验证结果**: pyOpenFOAM 在所有参照算例上的运行结果和精度对比
- **分析报告**: 符合学术规范的全量验证报告,含 11 张数据可视化图表
- **Docker 镜像**: 预编译的 OpenFOAM-13 环境 (Ubuntu 22.04, GCC 10)

### 验证覆盖率

| 类别 | 算例数 | 已验证 | 覆盖率 |
|------|--------|--------|--------|
| 不可压缩稳态 | 55 | 47 | 85.5% |
| 不可压缩 VoF | 39 | 33 | 84.6% |
| 多相 Euler | 26 | 26 | 100% |
| 通用流体 | 31 | 29 | 93.5% |
| 多组分反应 | 19 | 18 | 94.7% |
| 多区域 CHT | 20 | 18 | 90.0% |
| 可压缩 VoF | 8 | 7 | 87.5% |
| 可压缩激波 | 8 | 8 | 100% |
| 其他 (8 类) | 31 | 29 | 93.5% |
| **总计** | **257** | **233** | **90.7%** |