Add per-scenario channels.json sidecars and document field/channel order in README
Browse files- README.md +3 -0
- combustion/channels.json +32 -0
- controlled_cylinder/channels.json +17 -0
- cylinder/channels.json +17 -0
- foil/channels.json +17 -0
- fsi/channels.json +17 -0
README.md
CHANGED
|
@@ -131,6 +131,7 @@ Dataset version: **`2.0.0`** (see `version.json` at repo root; released 2026-01-
|
|
| 131 |
```
|
| 132 |
{repo_root}/
|
| 133 |
cylinder/
|
|
|
|
| 134 |
in_dist_test_params_real.json
|
| 135 |
out_dist_test_params_real.json
|
| 136 |
remain_params_real.json
|
|
@@ -220,6 +221,7 @@ print(f"Output shape: {output_tensor.shape}") # (200, H, W, 2) = 20 × 10
|
|
| 220 |
- `t` (bytes): float32 array `(T_full,)` — time stamps
|
| 221 |
- `shape_t` (int): **complete trajectory length** (e.g., 3990, 2173)
|
| 222 |
- `shape_h`, `shape_w` (int): spatial dimensions
|
|
|
|
| 223 |
|
| 224 |
> **Note on spatial grids:** `x` and `y` are identical across all time frames, so they are stored once as `(H, W)` instead of `(T, H, W)`. For methods that require per-frame coordinate grids (e.g., PINNs), broadcast at runtime: `x_grid = np.broadcast_to(x[np.newaxis, :, :], (T, H, W))`. This is a zero-copy view with no memory overhead.
|
| 225 |
|
|
@@ -235,6 +237,7 @@ print(f"Output shape: {output_tensor.shape}") # (200, H, W, 2) = 20 × 10
|
|
| 235 |
- `t` (bytes): float32 array `(T_full,)` — time stamps
|
| 236 |
- `shape_t` (int): **complete trajectory length** (e.g., 2001)
|
| 237 |
- `shape_h`, `shape_w` (int): spatial dimensions
|
|
|
|
| 238 |
|
| 239 |
### Index files (JSON)
|
| 240 |
|
|
|
|
| 131 |
```
|
| 132 |
{repo_root}/
|
| 133 |
cylinder/
|
| 134 |
+
channels.json # Field / channel schema for this scenario
|
| 135 |
in_dist_test_params_real.json
|
| 136 |
out_dist_test_params_real.json
|
| 137 |
remain_params_real.json
|
|
|
|
| 221 |
- `t` (bytes): float32 array `(T_full,)` — time stamps
|
| 222 |
- `shape_t` (int): **complete trajectory length** (e.g., 3990, 2173)
|
| 223 |
- `shape_h`, `shape_w` (int): spatial dimensions
|
| 224 |
+
- **Field names** for each scenario are also documented machine-readably in [`{scenario}/channels.json`](#repository-layout) (with shapes and short physical descriptions).
|
| 225 |
|
| 226 |
> **Note on spatial grids:** `x` and `y` are identical across all time frames, so they are stored once as `(H, W)` instead of `(T, H, W)`. For methods that require per-frame coordinate grids (e.g., PINNs), broadcast at runtime: `x_grid = np.broadcast_to(x[np.newaxis, :, :], (T, H, W))`. This is a zero-copy view with no memory overhead.
|
| 227 |
|
|
|
|
| 237 |
- `t` (bytes): float32 array `(T_full,)` — time stamps
|
| 238 |
- `shape_t` (int): **complete trajectory length** (e.g., 2001)
|
| 239 |
- `shape_h`, `shape_w` (int): spatial dimensions
|
| 240 |
+
- **Channel order** of the 15 fields packed in `numerical` (along the last axis) is listed in [`combustion/channels.json`](combustion/channels.json) under `numerical.numerical_axis_names` (`index → name` + physical description). Authoritative units and definitions live in the [combustion dataset page](https://realpdebench.github.io/datasets/combustion/).
|
| 241 |
|
| 242 |
### Index files (JSON)
|
| 243 |
|
combustion/channels.json
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"scenario": "combustion",
|
| 3 |
+
"real": {
|
| 4 |
+
"fields": [
|
| 5 |
+
{"key": "observed", "shape": "(T, H, W)", "description": "OH* chemiluminescence (CL) intensity recorded by high-speed imaging of the swirl-stabilized NH3/CH4/air flame."}
|
| 6 |
+
]
|
| 7 |
+
},
|
| 8 |
+
"numerical": {
|
| 9 |
+
"fields": [
|
| 10 |
+
{"key": "observed", "shape": "(T, H, W)", "description": "Surrogate intensity field corresponding to the measured OH* signal, produced by a U-Net mapping from simulated fields to the observable modality."},
|
| 11 |
+
{"key": "numerical", "shape": "(T, H, W, 15)", "description": "Fifteen simulated thermodynamic and species fields from Large Eddy Simulation (STAR-CCM+ with the Eddy Dissipation Concept; 38 species, 184 reactions). The 15 channels are packed along the last axis in the order given by `numerical_axis_names`."}
|
| 12 |
+
],
|
| 13 |
+
"numerical_axis_names": [
|
| 14 |
+
{"index": 0, "name": "Absolute_Pressure", "description": "Absolute pressure field."},
|
| 15 |
+
{"index": 1, "name": "Chemistry_Heat_Release_Rate", "description": "Volumetric heat release rate from chemical reactions."},
|
| 16 |
+
{"index": 2, "name": "Mole_Fraction_of_CH4", "description": "Mole fraction of methane (CH4)."},
|
| 17 |
+
{"index": 3, "name": "Mole_Fraction_of_CO", "description": "Mole fraction of carbon monoxide (CO)."},
|
| 18 |
+
{"index": 4, "name": "Mole_Fraction_of_CO2", "description": "Mole fraction of carbon dioxide (CO2)."},
|
| 19 |
+
{"index": 5, "name": "Mole_Fraction_of_H2O", "description": "Mole fraction of water vapour (H2O)."},
|
| 20 |
+
{"index": 6, "name": "Mole_Fraction_of_NH2", "description": "Mole fraction of the amino radical (NH2)."},
|
| 21 |
+
{"index": 7, "name": "Mole_Fraction_of_NH3", "description": "Mole fraction of ammonia (NH3)."},
|
| 22 |
+
{"index": 8, "name": "Mole_Fraction_of_OH", "description": "Mole fraction of the hydroxyl radical (OH); proxy for the measured OH* chemiluminescence signal."},
|
| 23 |
+
{"index": 9, "name": "Pressure", "description": "Gauge pressure field."},
|
| 24 |
+
{"index": 10, "name": "Temperature", "description": "Static temperature field."},
|
| 25 |
+
{"index": 11, "name": "Velocity[i]", "description": "x-component of the velocity vector."},
|
| 26 |
+
{"index": 12, "name": "Velocity[j]", "description": "y-component of the velocity vector."},
|
| 27 |
+
{"index": 13, "name": "Velocity[k]", "description": "z-component of the velocity vector."},
|
| 28 |
+
{"index": 14, "name": "Velocity_Magnitude", "description": "Magnitude of the velocity vector."}
|
| 29 |
+
]
|
| 30 |
+
},
|
| 31 |
+
"note": "Authoritative physical definitions and units are documented at https://realpdebench.github.io/datasets/combustion/."
|
| 32 |
+
}
|
controlled_cylinder/channels.json
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"scenario": "controlled_cylinder",
|
| 3 |
+
"real": {
|
| 4 |
+
"fields": [
|
| 5 |
+
{"key": "u", "shape": "(T, H, W)", "description": "Streamwise velocity component, measured by Particle Image Velocimetry (PIV) under active flow control."},
|
| 6 |
+
{"key": "v", "shape": "(T, H, W)", "description": "Transverse velocity component, measured by Particle Image Velocimetry (PIV) under active flow control."}
|
| 7 |
+
]
|
| 8 |
+
},
|
| 9 |
+
"numerical": {
|
| 10 |
+
"fields": [
|
| 11 |
+
{"key": "u", "shape": "(T, H, W)", "description": "Streamwise velocity component from CFD simulation with the same control input as the paired experiment."},
|
| 12 |
+
{"key": "v", "shape": "(T, H, W)", "description": "Transverse velocity component from CFD simulation."},
|
| 13 |
+
{"key": "p", "shape": "(T, H, W)", "description": "Pressure field from CFD simulation."}
|
| 14 |
+
]
|
| 15 |
+
},
|
| 16 |
+
"note": "Each field is stored as a separate column in the Arrow dataset. Control parameters (Reynolds number, control frequency) are encoded in the trajectory filenames and in the *_params_*.json index files. Authoritative physical definitions and units are documented at https://realpdebench.github.io/datasets/controlled_cylinder/."
|
| 17 |
+
}
|
cylinder/channels.json
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"scenario": "cylinder",
|
| 3 |
+
"real": {
|
| 4 |
+
"fields": [
|
| 5 |
+
{"key": "u", "shape": "(T, H, W)", "description": "Streamwise velocity component, measured by Particle Image Velocimetry (PIV)."},
|
| 6 |
+
{"key": "v", "shape": "(T, H, W)", "description": "Transverse velocity component, measured by Particle Image Velocimetry (PIV)."}
|
| 7 |
+
]
|
| 8 |
+
},
|
| 9 |
+
"numerical": {
|
| 10 |
+
"fields": [
|
| 11 |
+
{"key": "u", "shape": "(T, H, W)", "description": "Streamwise velocity component from CFD simulation."},
|
| 12 |
+
{"key": "v", "shape": "(T, H, W)", "description": "Transverse velocity component from CFD simulation."},
|
| 13 |
+
{"key": "p", "shape": "(T, H, W)", "description": "Pressure field from CFD simulation."}
|
| 14 |
+
]
|
| 15 |
+
},
|
| 16 |
+
"note": "Each field is stored as a separate column in the Arrow dataset. Authoritative physical definitions and units are documented at https://realpdebench.github.io/datasets/cylinder/."
|
| 17 |
+
}
|
foil/channels.json
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"scenario": "foil",
|
| 3 |
+
"real": {
|
| 4 |
+
"fields": [
|
| 5 |
+
{"key": "u", "shape": "(T, H, W)", "description": "Streamwise velocity component around the NACA0025 foil cross-section, measured by Particle Image Velocimetry (PIV)."},
|
| 6 |
+
{"key": "v", "shape": "(T, H, W)", "description": "Transverse velocity component, measured by Particle Image Velocimetry (PIV)."}
|
| 7 |
+
]
|
| 8 |
+
},
|
| 9 |
+
"numerical": {
|
| 10 |
+
"fields": [
|
| 11 |
+
{"key": "u", "shape": "(T, H, W)", "description": "Streamwise velocity from CFD simulation around the foil cross-section."},
|
| 12 |
+
{"key": "v", "shape": "(T, H, W)", "description": "Transverse velocity from CFD simulation."},
|
| 13 |
+
{"key": "p", "shape": "(T, H, W)", "description": "Pressure field from CFD simulation."}
|
| 14 |
+
]
|
| 15 |
+
},
|
| 16 |
+
"note": "Each field is stored as a separate column in the Arrow dataset. Geometric parameters (angle of attack, Reynolds number) are stored in the *_params_*.json index files. Authoritative physical definitions and units are documented at https://realpdebench.github.io/datasets/foil/."
|
| 17 |
+
}
|
fsi/channels.json
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"scenario": "fsi",
|
| 3 |
+
"real": {
|
| 4 |
+
"fields": [
|
| 5 |
+
{"key": "u", "shape": "(T, H, W)", "description": "Streamwise velocity component around the vibrating cylinder, measured by Particle Image Velocimetry (PIV)."},
|
| 6 |
+
{"key": "v", "shape": "(T, H, W)", "description": "Transverse velocity component, measured by Particle Image Velocimetry (PIV)."}
|
| 7 |
+
]
|
| 8 |
+
},
|
| 9 |
+
"numerical": {
|
| 10 |
+
"fields": [
|
| 11 |
+
{"key": "u", "shape": "(T, H, W)", "description": "Streamwise velocity from coupled fluid-structure simulation."},
|
| 12 |
+
{"key": "v", "shape": "(T, H, W)", "description": "Transverse velocity from coupled fluid-structure simulation."},
|
| 13 |
+
{"key": "p", "shape": "(T, H, W)", "description": "Pressure field from coupled fluid-structure simulation."}
|
| 14 |
+
]
|
| 15 |
+
},
|
| 16 |
+
"note": "Each field is stored as a separate column in the Arrow dataset. Structural parameters (mass ratio, damping ratio, Reynolds number) are stored in the *_params_*.json index files. Authoritative physical definitions and units are documented at https://realpdebench.github.io/datasets/fsi/."
|
| 17 |
+
}
|