# ExtFoamBench

[English](README.md) | **中文介绍**

**100 个 CFD 任务 · 7 个几何资产 · 面向任务物理响应的评价体系**

ExtFoamBench 是 [EasyFoam 论文](https://openreview.net/forum?id=GhQ5YmhU8B)提出的 OpenFOAM 智能体评测基准。本仓库重点提供三部分：**ExtFoamBench 数据集、任务所需的几何资产，以及评价指标与接受准则**。

## 核心内容

| 资源 | 内容 | 文件入口 |
| --- | --- | --- |
| **ExtFoamBench 数据集** | 10 个任务家族、100 个任务，覆盖工况、几何与网格、物理模型、数值设置和多次运行工作流 | [任务列表](data/extended.jsonl) · [参考算例输入](benchmarks/extended_cases.json) |
| **几何资产** | 适用于搅拌反应器、翼型和车辆算例的 7 个几何文件，附来源与校验值 | [几何目录](benchmarks/assets/) · [资产清单](benchmarks/assets/manifest.json) |
| **评价指标与准则** | 执行、数值和物理三个维度的评价，以及逐任务 QoI 定义、测量方式、参考比较与容差 | [测量规范](benchmarks/extended_measurement_specs.json) · [QoI 设计](benchmarks/extended_qoi_design.json) · [参考值与容差](benchmarks/extended_reference_qois.json) |

每个家族包含 1 个基准任务和 9 个变体：`yPlusVerification`、`risingBubble`、`supersonicCrossJet`、`nozzleCDV`、`MRF_stirredReactor`、`ERCOFTA_pump`、`compressibleBubbleCollapse`、`aerofoilNACA0012`、`drivaerFastback` 和 `riemann2D`。

任务由 EasyFoam 作者设计。几何资产来自已注明出处的 OpenFOAM 13 资源，保留原有归属与许可说明。

## 评价方式

每个任务从三个维度评价：**E：执行完成；N：满足适用的数值条件；Q：所有必需的物理量／QoI 准则通过。**

- **ECR（执行完成率）** = E 通过的任务数 / 全部指定任务数。
- **TAR（任务接受率）** = E、N、Q 同时通过的任务数 / 全部指定任务数。

QoI 准则规定测什么、在哪里和什么时间测、如何比较，以及允许多大误差。缺失输出仍计入任务总数；诊断分数或连续质量分数不能覆盖必需准则的失败。

## 使用数据集

安装 `datasets` 后，读取默认的 Extended 任务：

```python
from datasets import load_dataset

tasks = load_dataset("Eurus132/ExtFoamBench", "extended", split="test", revision="v1.2.0")
print(len(tasks))  # 100
print(tasks[0]["usr_requirement"])
```

同时下载几何资产、评价准则和参考数据：

```bash
hf download Eurus132/ExtFoamBench --repo-type dataset --revision v1.2.0 --local-dir ExtFoamBench
```

任务表包含需求和元数据。参考算例输入和参考答案用于评价，应放在求解智能体无法读取的位置。这里的 `test` 表示基准评测任务，并非论文中技能演化实验的历史留出划分。

## 配套资源

为方便更广泛的比较，本仓库附带来自[上游 FoamBench](https://github.com/NLR-Theseus/cfdllmbench) 的 **Basic（110 个）**和 **Advanced（16 个）**任务。它们不是 EasyFoam 的原创任务；EasyFoam 作者为其提供了**评价准则和离线参考数据**。可选择 `basic`、`advanced` 或 `all`（226 个任务）浏览。

三组任务的离线 QoI 参考值和数值统计用于支持评价。[可选评价工具包](tools/evaluation-tools.zip)集中提供评估器、脚本和格式定义，需要时再解压。[使用指南](GUIDE.md)说明工具运行方法、数据覆盖情况和评价协议细节。[EasyFoam Skill 库](https://github.com/CAS-CLab/EasyFoam)独立发布。

## 引用与许可

使用 ExtFoamBench 或其评价／参考资源时，请引用 [EasyFoam](https://openreview.net/forum?id=GhQ5YmhU8B)；使用 Basic/Advanced 时，同时注明 [FoamBench](https://github.com/NLR-Theseus/cfdllmbench) 的贡献。项目与第三方资源的许可见[组件许可证说明](LICENSE.md)。

**1.2.0** 版本统一了数据、工具和文档中的文件命名。数值参考值、接受准则和评分逻辑保持一致，旧版仍可下载。