Skip to content

Commit

Permalink
Add citation (#482)
Browse files Browse the repository at this point in the history
  • Loading branch information
marchdf authored Mar 11, 2024
1 parent 71fdec3 commit 551381c
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,20 +51,21 @@ imperative.
## Citation

To cite PelePhysics as a whole and its use as part of the broader Pele suite, please use the following
SIAM Parallel Processing article:
[SIAM Parallel Processing article](https://doi.org/10.1137/1.9781611977967):

```
@article{HenrydeFrahan2024,
doi = {},
url = {},
@article{PeleSoftware,
author = {Marc T. {Henry de Frahan} and Lucas Esclapez and Jon Rood and Nicholas T. Wimer and Paul Mullowney and Bruce A. Perry and Landon Owen and Hariswaran Sitaraman and Shashank Yellapantula and Malik Hassanaly and Mohammad J. Rahimi and Michael J. Martin and Olga A. Doronina and Sreejith N. A. and Martin Rieth and Wenjun Ge and Ramanan Sankaran and Ann S. Almgren and Weiqun Zhang and John B. Bell and Ray Grout and Marc S. Day and Jacqueline H. Chen},
title = {The Pele Simulation Suite for Reacting Flows at Exascale},
booktitle = {Proceedings of the 2024 SIAM Conference on Parallel Processing for Scientific Computing},
journal = {Proceedings of the 2024 SIAM Conference on Parallel Processing for Scientific Computing},
chapter = {},
pages = {13-25},
doi = {10.1137/1.9781611977967.2},
URL = {https://epubs.siam.org/doi/abs/10.1137/1.9781611977967.2},
eprint = {https://epubs.siam.org/doi/pdf/10.1137/1.9781611977967.2},
year = {2024},
publisher = {SIAM},
volume = {},
number = {},
pages = {},
author = {Marc T. {Henry de Frahan} and Lucas Esclapez and Jon Rood and Nicholas Wimer and Paul Mullowney and Bruce A. Perry and Landon Owen and Hariswaran Sitaraman and Shashank Yellapantula and Malik Hassanaly and Mohammad J. Rahimi and Michael Martin and Olga Doronina and Sreejith Nadakkal Appukuttan and Martin Rieth and Wenjun Ge and Ramanan Sankaran and Ann Almgren and Weiqun Zhang and John B. Bell and Ray Grout and Marc S. Day and Jacqueline H. Chen},
title = {The {Pele} Simulation Suite for Reacting Flows at Exascale},
journal = {{SIAM Proceedings Series on Parallel Processing for Scientific Computing}}
publisher = {Proceedings of the 2024 SIAM Conference on Parallel Processing for Scientific Computing}
}
```

Expand Down Expand Up @@ -124,4 +125,4 @@ If the `Pele` codes are built with `Eos_Model = Fuego`, the make system variable
`PelePhysics` currently supports a cubic EOS model: `Soave-Redlich-Kwong`. It is built on top of the ideal gas models, and is selected by specifying its name as the `Eos_Model` during the build (the make system requires that both `Eos_Model` and `Chemistry_Model` be specified). Any additional parameters required for the EOS (e.g., attractions, repulsions, critical states) are either included in the underlying CEPTR database used to generate the source file model implementation, or else are inferred from the input model data.

### Model generation procedures
This repository provides the tools necessary for generating new Pele-compatible combustion mechanisms. Please refer to the [CEPTR documentation](https://amrex-combustion.github.io/PelePhysics/Ceptr.html) for instructions on generating mechanism models. Make sure that you edit the `GNUmakefile` where you want to use this (in, e.g., `PeleC/Exec`) so that `Chemistry_Model` is `XXX`. In `PeleC/Exec/Make.PeleC`, the model is expected to be in the folder `${PELE_PHYSICS_HOME}/Mechanisms/$(Chemistry_Model)`, and it is expected that the folder contains a `Make.package` file to include, so make sure things are where they need to be. Refer to other mechanisms for additional guidance.
This repository provides the tools necessary for generating new Pele-compatible combustion mechanisms. Please refer to the [CEPTR documentation](https://amrex-combustion.github.io/PelePhysics/Ceptr.html) for instructions on generating mechanism models. Make sure that you edit the `GNUmakefile` where you want to use this (in, e.g., `PeleC/Exec`) so that `Chemistry_Model` is `XXX`. In `PeleC/Exec/Make.PeleC`, the model is expected to be in the folder `${PELE_PHYSICS_HOME}/Mechanisms/$(Chemistry_Model)`, and it is expected that the folder contains a `Make.package` file to include, so make sure things are where they need to be. Refer to other mechanisms for additional guidance.

0 comments on commit 551381c

Please sign in to comment.