Jens commited on
Commit
be2a693
·
verified ·
1 Parent(s): ef48198

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +14 -0
README.md CHANGED
@@ -31,6 +31,10 @@ default: true
31
 
32
  Parameterized U-bend CFD dataset for surrogate modeling and scientific machine learning.
33
 
 
 
 
 
34
  ## Dataset Description
35
 
36
  This dataset contains **~9,000 conjugate heat transfer simulations** of a parameterized U-bend cooling channel, generated with OpenFOAM (`chtMultiRegionSimpleFoam`). Each sample represents a unique channel geometry defined by 28 design parameters, with corresponding flow and temperature solution fields.
@@ -172,6 +176,16 @@ ds = UBendFieldDataset("fields/")
172
  loader = DataLoader(ds, batch_size=16, shuffle=True, num_workers=4)
173
  ```
174
 
 
 
 
 
 
 
 
 
 
 
175
  ## Version History
176
 
177
  This is an updated version of the original U-bend dataset with improved mesh quality (mesh convergence study), corrected Sobol sampling, and additional output fields (mean/std of targets, solution fields in safetensors format). The underlying geometry parameterization and simulation setup remain the same.
 
31
 
32
  Parameterized U-bend CFD dataset for surrogate modeling and scientific machine learning.
33
 
34
+ ![Sample overview](overview.png)
35
+
36
+ *Five randomly selected samples showing the geometry and the solution fields (velocity magnitude, pressure, temperature, turbulent kinetic energy, turbulent viscosity).*
37
+
38
  ## Dataset Description
39
 
40
  This dataset contains **~9,000 conjugate heat transfer simulations** of a parameterized U-bend cooling channel, generated with OpenFOAM (`chtMultiRegionSimpleFoam`). Each sample represents a unique channel geometry defined by 28 design parameters, with corresponding flow and temperature solution fields.
 
176
  loader = DataLoader(ds, batch_size=16, shuffle=True, num_workers=4)
177
  ```
178
 
179
+ ### Visualization
180
+
181
+ A ready-to-use visualization script ([`visualize_sample.py`](visualize_sample.py)) is included. It downloads N random samples from the hub and renders the geometry and all solution fields as PNGs:
182
+
183
+ ```bash
184
+ python visualize_sample.py --n 5
185
+ ```
186
+
187
+ This produces individual plots per sample plus an `overview.png` (as shown above).
188
+
189
  ## Version History
190
 
191
  This is an updated version of the original U-bend dataset with improved mesh quality (mesh convergence study), corrected Sobol sampling, and additional output fields (mean/std of targets, solution fields in safetensors format). The underlying geometry parameterization and simulation setup remain the same.