You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,8 +17,8 @@ OpenFOAM implementation of turbulence models driven by Machine Learning predicti
17
17
18
18
Information on how to cite both papers are available on their respective links
19
19
20
-
**The models are used to correct RANS simulations by using quantities predicted by Machine Learning techniques. They can also be used by the directly using high-fidelity fields (e.g. DNS, LES).**
21
-
20
+
The models are used to correct RANS simulations by using fields predicted by Machine Learning techniques.
21
+
They also work with the direct use of high-fidelity fields, such as DNS or LES.
22
22
In the models of the 1st paper, the corrections are driven by source terms injected into the mean momentum equation, while the model of the 2nd paper injects its source term into a Reynolds stress model (RSM).
23
23
24
24
@@ -33,7 +33,7 @@ In the models of the 1st paper, the corrections are driven by source terms injec
33
33
-[Using the models](#using-the-models)
34
34
-[Tutorials: using the models with the provided DNS data](#tutorials-using-the-models-with-the-provided-dns-data)
35
35
-[Correcting the square-duct RANS case with Re = 3500 using the RST](#1---correcting-the-square-duct-rans-case-with-re--3500-using-the-rst)
36
-
-[Correcting the periodic-hill RANS case with alpha = 1.0 using the EV-RFV](#2---correcting-the-periodic-hill-rans-case-with-alpha--10-using-the-ev-rfv)
36
+
-[Correcting the periodic-hills RANS case with alpha = 1.0 using the EV-RFV](#2---correcting-the-periodic-hill-rans-case-with-alpha--10-using-the-ev-rfv)
37
37
-[Correcting the square-duct RANS case with Re = 2200 using the Gamma-RST](#3---correcting-the-square-duct-rans-case-with-re--2200-using-the-gamma-rst)
38
38
-[References](#references)
39
39
-[Models](#models)
@@ -62,7 +62,7 @@ To compile and use the applications and the libraries, you need to do the follow
62
62
63
63
### The folder `data` contains OpenFOAM simulations
64
64
65
-
The square-duct (SD) and periodic-hills (PH) simulations used in our paper are provided.
65
+
The square-duct (SD) and periodic-hills (PH) simulations used in our papers are provided.
66
66
67
67
The SD folder contains the simulations for Reynolds numbers of 2200, 2400, 2600, 2900, 3200, 3500.
68
68
The PH folder contains the simulations for the slopes of 0.5, 0.8, 1.0, 1.2, 1.5.
@@ -99,7 +99,7 @@ The DNS fields for the periodic-hills were provided by [Xiao et al. (2020)](#ref
99
99
- Based on the papers by [Brener et al. (2021)](#references) and [Brener et al (2024)](#references)
100
100
- Directly injects the vector ***tStar*** into the momentum balance along with the eddy-viscosity nut.
101
101
- The scalar ***nut*** is included within the diffusive term of the discretized mean momentum balance solved to compute the velocity field U
102
-
- Analogous to the `RST-EV` model, a constant ***implicitFactor*** defines if the diffusive term containing ***nut*** is calculated implicitly or explicitly.
102
+
- Analogous to the `evRST` model, a constant ***implicitFactor*** defines if the diffusive term containing ***nut*** is calculated implicitly or explicitly.
103
103
- Default value is also `1.0` (implicit)
104
104
-**gammaRST** - Symmetric source term tensor ***Gamma***
105
105
- Based on the paper by [Macedo et al. (2024)](#references)
@@ -108,7 +108,7 @@ The DNS fields for the periodic-hills were provided by [Xiao et al. (2020)](#ref
108
108
- The deviatoric part of the calculated ***R*** is injected into the momentum balance.
109
109
- The process is repeated iteratively until numerical convergence.
110
110
111
-
Inside the `data` folder there is a shell script that will calculate and organize the source terms in the simulations folders.
111
+
Inside the `data` folder there is a shell script that will calculate and organize the source terms in each simulation.
112
112
113
113
## Using the models
114
114
@@ -123,7 +123,7 @@ Because the focus of this repository is the OpenFOAM implementation of the turbu
123
123
decided to only include the baseline RANS fields from where we extracted the features used as
124
124
our inputs.
125
125
126
-
There are multiple manners of training ML techniques and obtaining the source terms of each of the
126
+
There are multiple manners of training ML techniques and predicting the source terms of each of the
127
127
5 models.
128
128
In our works we have used neural networks and random forests, they were both built using
129
129
common Python libraries such as: `Keras`, `TensorFlow` and `Scikit-learn`.
@@ -164,7 +164,7 @@ The model solves for `U` and `p` and requires the source term `R`.
164
164
3) Specify `RST` as the turbulence model in `constant/turbulenceProperties`: `foamDictionary constant/turbulenceProperties -entry RAS.RASModel -set RST`
165
165
4) Include the repository's library in `system/cotrolDict`: `foamDictionary system/controlDict -entry libs -add "("'"libMachineLearningTurbulenceModels.so"'")"`
166
166
167
-
**You only have to do this if you are not using any of the `controlDict` included in `data` folder**
167
+
**You only have to do this if you are not using any of the `controlDict` included in the `data` folder**
168
168
169
169
5) Run the simulation: `simpleFoam` (you may use any other steady-state solver you prefer)
170
170
@@ -188,7 +188,7 @@ The model solves for `U` and `p` and requires the source terms `nut` (optimal) a
188
188
3) Specify `evRFV` as the turbulence model in `constant/turbulenceProperties`: `foamDictionary constant/turbulenceProperties -entry RAS.RASModel -set evRFV`
189
189
4) Include the repository's library in `system/cotrolDict`: `foamDictionary system/controlDict -entry libs -add "("'"libMachineLearningTurbulenceModels.so"'")"`
190
190
191
-
**You only have to do this if you are not using any of the `controlDict` included in `data` folder**
191
+
**You only have to do this if you are not using any of the `controlDict` included in the `data` folder**
192
192
193
193
5) Run the simulation: `simpleFoam` (you may use any other steady-state solver you prefer)
194
194
@@ -215,7 +215,7 @@ The model solves for `U`, `p` and `R` and requires the source terms `nut` (RANS)
215
215
6) Specify `gammaRST` as the turbulence model in `constant/turbulenceProperties`: `foamDictionary constant/turbulenceProperties -entry RAS.RASModel -set gammaRST`
216
216
7) Include the repository's library in `system/cotrolDict`: `foamDictionary system/controlDict -entry libs -add "("'"libMachineLearningTurbulenceModels.so"'")"`
217
217
218
-
**You only have to do this if you are not using any of the `controlDict` included in `data` folder**
218
+
**You only have to do this if you are not using any of the `controlDict` included in the `data` folder**
219
219
220
220
8) Run the simulation: `simpleFoam` (you may use any other steady-state solver you prefer)
0 commit comments