Update README.md

README.md

@@ -35,7 +35,7 @@ The data generation process itself was orchestrated using the [Inductiva API](ht
 which allowed us to run hundreds of OpenFOAM simulations in parallel on the cloud. 
 
 
-# Why
+# Why?
 Existing object datasets have many limitations: they are either small in size, closed source, or have low quality meshes. 
 Hence, we decided to generate a new dataset using the [InstantMesh](https://github.com/TencentARC/InstantMesh) model, 
 which is open-source (Apache-2.0) and is currently state-of-the-art in image-to-mesh generation.
@@ -54,8 +54,7 @@ point of view of the learning problem, they bring challenges to the model that w
 and generalizable models. 
 
 
-# How did we generate the dataset
-
+# How did we generate the dataset?
 1. Generating Input Meshes, using InstantMesh on Standord Cars Dataset and postprocess the input meshes.
 2. Running OpenFoam on the Input Meshes with the Inductiva API.
 We ran OpenFoam simulations with different wind speeds and object angles on the input meshes.
@@ -87,33 +86,52 @@ data
 ## Dataset Files
 Each simulation in the Wind Tunnel Dataset is accompanied by several key files that provide both the input and the output data of the simulations. 
 Here’s a breakdown of the files included in each simulation:
-- **[input_mesh.obj](#input_meshobj)**: OBJ file with the input mesh. These were generated using the InstantMesh model by the process described in section link.
-- **[openfoam_mesh.obj](#openfoam_meshobj)**: OBJ file with the OpenFOAM mesh. (explicar)
-- **[pressure_field_mesh.vtk](#pressure_field_meshvtk)**: VTK file with the pressure field data. (explicar)
-- **[streamlines_mesh.ply](#streamlines_meshply)**: PLY file with the streamlines. (posprocessing)
+- **[input_mesh.obj](#input_meshobj)**: OBJ file with the input mesh.
+- **[openfoam_mesh.obj](#openfoam_meshobj)**: OBJ file with the OpenFOAM mesh.
+- **[pressure_field_mesh.vtk](#pressure_field_meshvtk)**: VTK file with the pressure field data.
+- **[streamlines_mesh.ply](#streamlines_meshply)**: PLY file with the streamlines.
 - **[metadata.json](#metadatajson)**: JSON with metadata about the input parameters and about some output results such as the force coefficients (obtained via simulation) and the path of the output files.
 
 
 ### input_mesh.obj
+Input mesh generated with InstantMesh model from images of the Stanford Cars Dataset.
+This mesh was used as the input of the OpenFoam simulation.
+
+The mesh generation process is described [here](#Why).
 
 | **Input Mesh**               | **Points Histogram**           |
 |-------------------------------|------------------------------|
 | ![Input Mesh](https://huggingface.co/datasets/inductiva/windtunnel/resolve/main/assets/input_mesh.png) | ![Histogram](https://huggingface.co/datasets/inductiva/windtunnel/resolve/main/assets/histogram_of_points_input.png) |
 
 ### openfoam_mesh.obj
+Output mesh obtained from the OpenFoam simulation. The number of points is smaller than `input_mesh` due to internal OpenFoam processing.
+
 | **Open Foam Mesh**               | **Points Histogram**           |
 |-------------------------------|------------------------------|
-| ![Input Mesh](https://huggingface.co/datasets/inductiva/windtunnel/resolve/main/assets/input_mesh.png) | ![Input Mesh](https://huggingface.co/datasets/inductiva/windtunnel/resolve/main/assets/histogram_of_points_foam.png) |
+| ![Input Mesh](https://huggingface.co/datasets/inductiva/windtunnel/resolve/main/assets/openfoam_mesh.png) | ![Input Mesh](https://huggingface.co/datasets/inductiva/windtunnel/resolve/main/assets/histogram_of_points_foam.png) |
 
 ### pressure_field_mesh.obj
+We extracted pressure values from the `openfoam_mesh.obj`.
+Then we interpolated the pressure values with closest_point strategy on the `input_mesh.obj` so that we have a higher resolution mesh.
+As can be seen on the histogram, the distribution of points is the same as the input_mesh.obj.
+
+More information [here](https://github.com/inductiva/wind-tunnel/blob/deab68a018531ff05d0d8ef9d63d8c108800f78f/windtunnel/windtunnel_outputs.py#L111).
+
 | **Pressure Field Mesh**               | **Points Histogram**           |
 |-------------------------------|------------------------------|
-| ![Input Mesh](https://huggingface.co/datasets/inductiva/windtunnel/resolve/main/assets/input_mesh.png) | ![Input Mesh](https://huggingface.co/datasets/inductiva/windtunnel/resolve/main/assets/histogram_of_points_input.png)) |
+| ![Input Mesh](https://huggingface.co/datasets/inductiva/windtunnel/resolve/main/assets/pressure_field_mesh.png) | ![Input Mesh](https://huggingface.co/datasets/inductiva/windtunnel/resolve/main/assets/histogram_of_points_input.png)) |
+
 
 ### streamlines_mesh.ply
+We generated streamlines from the `openfoam_mesh.obj`.
+
+More information [here](https://github.com/inductiva/wind-tunnel/blob/deab68a018531ff05d0d8ef9d63d8c108800f78f/windtunnel/windtunnel_outputs.py#L70).
+
+
+
 | **Streamlines Mesh**               |
 |-------------------------------|
-| ![Input Mesh](https://huggingface.co/datasets/inductiva/windtunnel/resolve/main/assets/input_mesh.png)  |
+| ![Input Mesh](https://huggingface.co/datasets/inductiva/windtunnel/resolve/main/assets/streamlines_mesh.png)  |
 
 ### metadata.obj
   ```json
@@ -193,9 +211,86 @@ print("Sample from training set:", sample)
 
 ## OpenFoam Parameters
 
-You can find the OpenFoam configuration files on github: [https://github.com/inductiva/wind-tunnel/tree/main/windtunnel/templates](https://github.com/inductiva/wind-tunnel/tree/main/windtunnel/templates)
+We used [Inductiva Template Manager](https://tutorials.inductiva.ai/intro_to_api/templating.html) to parameterize the OpenFoam configuration files.
+
+Need a better way to do this:
+```
+flowVelocity         ({{ wind_speed }} 0 0);
+
+vertices
+(
+    ({{ x_min }} {{ y_min }} {{ z_min }})
+    ({{ x_max }} {{ y_min }} {{ z_min }})
+    ({{ x_max }} {{ y_max }} {{ z_min }})
+    ({{ x_min }} {{ y_max }} {{ z_min }})
+    ({{ x_min }} {{ y_min }} {{ z_max }})
+    ({{ x_max }} {{ y_min }} {{ z_max }})
+    ({{ x_max }} {{ y_max }} {{ z_max }})
+    ({{ x_min }} {{ y_max }} {{ z_max }})
+);
+
+endTime         {{ num_iterations }};
+
+magUInf         {{ wind_speed }};
+lRef            {{ length }};        // Wheelbase length
+Aref            {{ area }};        // Estimated
+
+geometry
+{
+    object
+    {
+        type triSurfaceMesh;
+        file "object.obj";
+    }
+
+    refinementBox
+    {
+        type searchableBox;
+        min ({{ x_min }} {{ y_min }} {{ z_min }});
+        max ({{ x_max }} {{ y_max }} {{ z_max }});
+    }
+};
+
+features
+(
+    {
+        file "object.eMesh";
+        level {{ resolution + 1  }};
+    }
+);
+
 
+refinementSurfaces
+{
+    object
+    {
+        // Surface-wise min and max refinement level
+        level ({{ resolution }} {{ resolution + 1 }});
+
+        // Optional specification of patch type (default is wall). No
+        // constraint types (cyclic, symmetry) etc. are allowed.
+        patchInfo
+        {
+            type wall;
+            inGroups (objectGroup);
+        }
+    }
+}
+
+refinementRegions
+{
+    refinementBox
+    {
+        mode inside;
+        levels ((1E15 {{ resolution - 1 }}));
+    }
+}
+
+locationInMesh ({{ x_min }} {{ y_min }} {{ z_min }});
 
+```
+
+You can find the OpenFoam configuration files on github: [https://github.com/inductiva/wind-tunnel/tree/main/windtunnel/templates](https://github.com/inductiva/wind-tunnel/tree/main/windtunnel/templates)
 
 
 ## What's next?