Skip to content

Commit 8dbf9ac

Browse files
author
Matheus Macedo
committed
Update README.md
1 parent 331d291 commit 8dbf9ac

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ OpenFOAM implementation of turbulence models driven by Machine Learning predicti
1717

1818
Information on how to cite both papers are available on their respective links
1919

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.
2222
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).
2323

2424

@@ -33,7 +33,7 @@ In the models of the 1st paper, the corrections are driven by source terms injec
3333
- [Using the models](#using-the-models)
3434
- [Tutorials: using the models with the provided DNS data](#tutorials-using-the-models-with-the-provided-dns-data)
3535
- [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)
3737
- [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)
3838
- [References](#references)
3939
- [Models](#models)
@@ -62,7 +62,7 @@ To compile and use the applications and the libraries, you need to do the follow
6262

6363
### The folder `data` contains OpenFOAM simulations
6464

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.
6666

6767
The SD folder contains the simulations for Reynolds numbers of 2200, 2400, 2600, 2900, 3200, 3500.
6868
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
9999
- Based on the papers by [Brener et al. (2021)](#references) and [Brener et al (2024)](#references)
100100
- Directly injects the vector ***tStar*** into the momentum balance along with the eddy-viscosity nut.
101101
- 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.
103103
- Default value is also `1.0` (implicit)
104104
- **gammaRST** - Symmetric source term tensor ***Gamma***
105105
- 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
108108
- The deviatoric part of the calculated ***R*** is injected into the momentum balance.
109109
- The process is repeated iteratively until numerical convergence.
110110

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.
112112

113113
## Using the models
114114

@@ -123,7 +123,7 @@ Because the focus of this repository is the OpenFOAM implementation of the turbu
123123
decided to only include the baseline RANS fields from where we extracted the features used as
124124
our inputs.
125125

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
127127
5 models.
128128
In our works we have used neural networks and random forests, they were both built using
129129
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`.
164164
3) Specify `RST` as the turbulence model in `constant/turbulenceProperties`: `foamDictionary constant/turbulenceProperties -entry RAS.RASModel -set RST`
165165
4) Include the repository's library in `system/cotrolDict`: `foamDictionary system/controlDict -entry libs -add "("'"libMachineLearningTurbulenceModels.so"'")"`
166166

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**
168168

169169
5) Run the simulation: `simpleFoam` (you may use any other steady-state solver you prefer)
170170

@@ -188,7 +188,7 @@ The model solves for `U` and `p` and requires the source terms `nut` (optimal) a
188188
3) Specify `evRFV` as the turbulence model in `constant/turbulenceProperties`: `foamDictionary constant/turbulenceProperties -entry RAS.RASModel -set evRFV`
189189
4) Include the repository's library in `system/cotrolDict`: `foamDictionary system/controlDict -entry libs -add "("'"libMachineLearningTurbulenceModels.so"'")"`
190190

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**
192192

193193
5) Run the simulation: `simpleFoam` (you may use any other steady-state solver you prefer)
194194

@@ -215,7 +215,7 @@ The model solves for `U`, `p` and `R` and requires the source terms `nut` (RANS)
215215
6) Specify `gammaRST` as the turbulence model in `constant/turbulenceProperties`: `foamDictionary constant/turbulenceProperties -entry RAS.RASModel -set gammaRST`
216216
7) Include the repository's library in `system/cotrolDict`: `foamDictionary system/controlDict -entry libs -add "("'"libMachineLearningTurbulenceModels.so"'")"`
217217

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**
219219

220220
8) Run the simulation: `simpleFoam` (you may use any other steady-state solver you prefer)
221221

0 commit comments

Comments
 (0)