diff --git a/README.md b/README.md index fe0d9dd..aac75f1 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,31 @@ - +## Premixed Turbulent Combustion with Stochastic Mixing Models Simulator **PaSR-SDE: Premixed Turbulent Combustion with Stochastic Mixing Models Simulator** is a Matlab code to simulate premixed turbulent combustion in a partially stirred reactor using stochastic micro-mixing models. -## Documentation +

+ +

+ +### Documentation **PaSR-SDE** routines are commented to explain their functionality to the final user. Each routine has a short description of its purpose and a list of inputs and/or outputs. -## Software History +### Software History **PaSR-SDE** development started in the first author master thesis in 2007, under suppervision of the second author. The underlying results were disclosed in the following publication: - *E. M. Orbegoso and L. F. Figueira da Silva, Study of stochastic mixing models for combustion in turbulent flows, Proceedings of the Combustion Institute, v. 32, pp. 1595-1603, 2009 http://dx.doi.org/10.1016/j.proci.2008.06.008* The development resumed in 2023, with the last author updating the code to make it compatible with newer versions of Matlab. -## Reproducibility - +### Reproducibility Simulations done with **PaSR-SDE** are fully reproducible, as can be seen on this CodeOcean capsule -## Authors +### Authors - Elder Mendoza Orbegoso (UNT) - Luis Fernando Figueira da Silva (PUC-Rio / Institut Pprime) - Americo Cunha Jr (UERJ) -## Citing PaSR-SDE +### Citing PaSR-SDE We kindly ask users to cite the following references in any publications reporting work done with **CRFlowLib**: - *E. M. Orbegoso and L. F. Figueira da Silva, Study of stochastic mixing models for combustion in turbulent flows, Proceedings of the Combustion Institute, v. 32, pp. 1595-1603, 2009 http://dx.doi.org/10.1016/j.proci.2008.06.008* @@ -52,16 +55,16 @@ We kindly ask users to cite the following references in any publications reporti } ``` -## License +### License **PaSR-SDE** is released under the MIT license. See the LICENSE file for details. All new contributions must be made under the MIT license. -## Institutional support +### Institutional support             -## Funding +### Funding